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{C-c SPC,org-table-blank-field}
2154 Blank the field at point.
2156 @orgcmd{<TAB>,org-table-next-field}
2157 Re-align the table, move to the next field. Creates a new row if
2160 @orgcmd{S-@key{TAB},org-table-previous-field}
2161 Re-align, move to previous field.
2163 @orgcmd{@key{RET},org-table-next-row}
2164 Re-align the table and move down to next row. Creates a new row if
2165 necessary. At the beginning or end of a line, @key{RET} still does
2166 NEWLINE, so it can be used to split a table.
2168 @orgcmd{M-a,org-table-beginning-of-field}
2169 Move to beginning of the current table field, or on to the previous field.
2170 @orgcmd{M-e,org-table-end-of-field}
2171 Move to end of the current table field, or on to the next field.
2173 @tsubheading{Column and row editing}
2174 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2175 Move the current column left/right.
2177 @orgcmd{M-S-@key{left},org-table-delete-column}
2178 Kill the current column.
2180 @orgcmd{M-S-@key{right},org-table-insert-column}
2181 Insert a new column to the left of the cursor position.
2183 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2184 Move the current row up/down.
2186 @orgcmd{M-S-@key{up},org-table-kill-row}
2187 Kill the current row or horizontal line.
2189 @orgcmd{M-S-@key{down},org-table-insert-row}
2190 Insert a new row above the current row. With a prefix argument, the line is
2191 created below the current one.
2193 @orgcmd{C-c -,org-table-insert-hline}
2194 Insert a horizontal line below current row. With a prefix argument, the line
2195 is created above the current line.
2197 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2198 Insert a horizontal line below current row, and move the cursor into the row
2201 @orgcmd{C-c ^,org-table-sort-lines}
2202 Sort the table lines in the region. The position of point indicates the
2203 column to be used for sorting, and the range of lines is the range
2204 between the nearest horizontal separator lines, or the entire table. If
2205 point is before the first column, you will be prompted for the sorting
2206 column. If there is an active region, the mark specifies the first line
2207 and the sorting column, while point should be in the last line to be
2208 included into the sorting. The command prompts for the sorting type
2209 (alphabetically, numerically, or by time). When called with a prefix
2210 argument, alphabetic sorting will be case-sensitive.
2212 @tsubheading{Regions}
2213 @orgcmd{C-c C-x M-w,org-table-copy-region}
2214 Copy a rectangular region from a table to a special clipboard. Point and
2215 mark determine edge fields of the rectangle. If there is no active region,
2216 copy just the current field. The process ignores horizontal separator lines.
2218 @orgcmd{C-c C-x C-w,org-table-cut-region}
2219 Copy a rectangular region from a table to a special clipboard, and
2220 blank all fields in the rectangle. So this is the ``cut'' operation.
2222 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2223 Paste a rectangular region into a table.
2224 The upper left corner ends up in the current field. All involved fields
2225 will be overwritten. If the rectangle does not fit into the present table,
2226 the table is enlarged as needed. The process ignores horizontal separator
2229 @orgcmd{M-@key{RET},org-table-wrap-region}
2230 Split the current field at the cursor position and move the rest to the line
2231 below. If there is an active region, and both point and mark are in the same
2232 column, the text in the column is wrapped to minimum width for the given
2233 number of lines. A numeric prefix argument may be used to change the number
2234 of desired lines. If there is no region, but you specify a prefix argument,
2235 the current field is made blank, and the content is appended to the field
2238 @tsubheading{Calculations}
2239 @cindex formula, in tables
2240 @cindex calculations, in tables
2241 @cindex region, active
2242 @cindex active region
2243 @cindex transient mark mode
2244 @orgcmd{C-c +,org-table-sum}
2245 Sum the numbers in the current column, or in the rectangle defined by
2246 the active region. The result is shown in the echo area and can
2247 be inserted with @kbd{C-y}.
2249 @orgcmd{S-@key{RET},org-table-copy-down}
2250 @vindex org-table-copy-increment
2251 When current field is empty, copy from first non-empty field above. When not
2252 empty, copy current field down to next row and move cursor along with it.
2253 Depending on the option @code{org-table-copy-increment}, integer field
2254 values will be incremented during copy. Integers that are too large will not
2255 be incremented. Also, a @code{0} prefix argument temporarily disables the
2256 increment. This key is also used by shift-selection and related modes
2257 (@pxref{Conflicts}).
2259 @tsubheading{Miscellaneous}
2260 @orgcmd{C-c `,org-table-edit-field}
2261 Edit the current field in a separate window. This is useful for fields that
2262 are not fully visible (@pxref{Column width and alignment}). When called with
2263 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2264 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2265 window follow the cursor through the table and always show the current
2266 field. The follow mode exits automatically when the cursor leaves the table,
2267 or when you repeat this command with @kbd{C-u C-u C-c `}.
2269 @item M-x org-table-import RET
2270 Import a file as a table. The table should be TAB or whitespace
2271 separated. Use, for example, to import a spreadsheet table or data
2272 from a database, because these programs generally can write
2273 TAB-separated text files. This command works by inserting the file into
2274 the buffer and then converting the region to a table. Any prefix
2275 argument is passed on to the converter, which uses it to determine the
2277 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2278 Tables can also be imported by pasting tabular text into the Org
2279 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2280 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2282 @item M-x org-table-export RET
2283 @findex org-table-export
2284 @vindex org-table-export-default-format
2285 Export the table, by default as a TAB-separated file. Use for data
2286 exchange with, for example, spreadsheet or database programs. The format
2287 used to export the file can be configured in the option
2288 @code{org-table-export-default-format}. You may also use properties
2289 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2290 name and the format for table export in a subtree. Org supports quite
2291 general formats for exported tables. The exporter format is the same as the
2292 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2293 detailed description.
2296 If you don't like the automatic table editor because it gets in your
2297 way on lines which you would like to start with @samp{|}, you can turn
2301 (setq org-enable-table-editor nil)
2304 @noindent Then the only table command that still works is
2305 @kbd{C-c C-c} to do a manual re-align.
2307 @node Column width and alignment
2308 @section Column width and alignment
2309 @cindex narrow columns in tables
2310 @cindex alignment in tables
2312 The width of columns is automatically determined by the table editor. And
2313 also the alignment of a column is determined automatically from the fraction
2314 of number-like versus non-number fields in the column.
2316 Sometimes a single field or a few fields need to carry more text, leading to
2317 inconveniently wide columns. Or maybe you want to make a table with several
2318 columns having a fixed width, regardless of content. To set@footnote{This
2319 feature does not work on XEmacs.} the width of a column, one field anywhere
2320 in the column may contain just the string @samp{<N>} where @samp{N} is an
2321 integer specifying the width of the column in characters. The next re-align
2322 will then set the width of this column to this value.
2326 |---+------------------------------| |---+--------|
2328 | 1 | one | | 1 | one |
2329 | 2 | two | ----\ | 2 | two |
2330 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2331 | 4 | four | | 4 | four |
2332 |---+------------------------------| |---+--------|
2337 Fields that are wider become clipped and end in the string @samp{=>}.
2338 Note that the full text is still in the buffer but is hidden.
2339 To see the full text, hold the mouse over the field---a tool-tip window
2340 will show the full content. To edit such a field, use the command
2341 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2342 open a new window with the full field. Edit it and finish with @kbd{C-c
2345 @vindex org-startup-align-all-tables
2346 When visiting a file containing a table with narrowed columns, the
2347 necessary character hiding has not yet happened, and the table needs to
2348 be aligned before it looks nice. Setting the option
2349 @code{org-startup-align-all-tables} will realign all tables in a file
2350 upon visiting, but also slow down startup. You can also set this option
2351 on a per-file basis with:
2358 If you would like to overrule the automatic alignment of number-rich columns
2359 to the right and of string-rich column to the left, you can use @samp{<r>},
2360 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2361 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2362 also combine alignment and field width like this: @samp{<r10>}.
2364 Lines which only contain these formatting cookies will be removed
2365 automatically when exporting the document.
2368 @section Column groups
2369 @cindex grouping columns in tables
2371 When Org exports tables, it does so by default without vertical
2372 lines because that is visually more satisfying in general. Occasionally
2373 however, vertical lines can be useful to structure a table into groups
2374 of columns, much like horizontal lines can do for groups of rows. In
2375 order to specify column groups, you can use a special row where the
2376 first field contains only @samp{/}. The further fields can either
2377 contain @samp{<} to indicate that this column should start a group,
2378 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2379 and @samp{>}) to make a column
2380 a group of its own. Boundaries between column groups will upon export be
2381 marked with vertical lines. Here is an example:
2384 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2385 |---+-----+-----+-----+---------+------------|
2386 | / | < | | > | < | > |
2387 | 1 | 1 | 1 | 1 | 1 | 1 |
2388 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2389 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2390 |---+-----+-----+-----+---------+------------|
2391 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2394 It is also sufficient to just insert the column group starters after
2395 every vertical line you would like to have:
2398 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2399 |----+-----+-----+-----+---------+------------|
2404 @section The Orgtbl minor mode
2406 @cindex minor mode for tables
2408 If you like the intuitive way the Org table editor works, you
2409 might also want to use it in other modes like Text mode or Mail mode.
2410 The minor mode Orgtbl mode makes this possible. You can always toggle
2411 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2412 example in Message mode, use
2415 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2418 Furthermore, with some special setup, it is possible to maintain tables
2419 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2420 construct @LaTeX{} tables with the underlying ease and power of
2421 Orgtbl mode, including spreadsheet capabilities. For details, see
2422 @ref{Tables in arbitrary syntax}.
2424 @node The spreadsheet
2425 @section The spreadsheet
2426 @cindex calculations, in tables
2427 @cindex spreadsheet capabilities
2428 @cindex @file{calc} package
2430 The table editor makes use of the Emacs @file{calc} package to implement
2431 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2432 derive fields from other fields. While fully featured, Org's implementation
2433 is not identical to other spreadsheets. For example, Org knows the concept
2434 of a @emph{column formula} that will be applied to all non-header fields in a
2435 column without having to copy the formula to each relevant field. There is
2436 also a formula debugger, and a formula editor with features for highlighting
2437 fields in the table corresponding to the references at the point in the
2438 formula, moving these references by arrow keys
2441 * References:: How to refer to another field or range
2442 * Formula syntax for Calc:: Using Calc to compute stuff
2443 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2444 * Durations and time values:: How to compute durations and time values
2445 * Field and range formulas:: Formula for specific (ranges of) fields
2446 * Column formulas:: Formulas valid for an entire column
2447 * Lookup functions:: Lookup functions for searching tables
2448 * Editing and debugging formulas:: Fixing formulas
2449 * Updating the table:: Recomputing all dependent fields
2450 * Advanced features:: Field and column names, parameters and automatic recalc
2454 @subsection References
2457 To compute fields in the table from other fields, formulas must
2458 reference other fields or ranges. In Org, fields can be referenced
2459 by name, by absolute coordinates, and by relative coordinates. To find
2460 out what the coordinates of a field are, press @kbd{C-c ?} in that
2461 field, or press @kbd{C-c @}} to toggle the display of a grid.
2463 @subsubheading Field references
2464 @cindex field references
2465 @cindex references, to fields
2467 Formulas can reference the value of another field in two ways. Like in
2468 any other spreadsheet, you may reference fields with a letter/number
2469 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2470 @vindex org-table-use-standard-references
2471 However, Org prefers@footnote{Org will understand references typed by the
2472 user as @samp{B4}, but it will not use this syntax when offering a formula
2473 for editing. You can customize this behavior using the option
2474 @code{org-table-use-standard-references}.} to use another, more general
2475 representation that looks like this:
2477 @@@var{row}$@var{column}
2480 Column specifications can be absolute like @code{$1},
2481 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2482 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2483 @code{$<} and @code{$>} are immutable references to the first and last
2484 column, respectively, and you can use @code{$>>>} to indicate the third
2485 column from the right.
2487 The row specification only counts data lines and ignores horizontal separator
2488 lines (hlines). Like with columns, you can use absolute row numbers
2489 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2490 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2491 immutable references the first and last@footnote{For backward compatibility
2492 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2493 a stable way to the 5th and 12th field in the last row of the table.
2494 However, this syntax is deprecated, it should not be used for new documents.
2495 Use @code{@@>$} instead.} row in the table, respectively. You may also
2496 specify the row relative to one of the hlines: @code{@@I} refers to the first
2497 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2498 line above the current line, @code{@@+I} to the first such line below the
2499 current line. You can also write @code{@@III+2} which is the second data line
2500 after the third hline in the table.
2502 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2503 i.e., to the row/column for the field being computed. Also, if you omit
2504 either the column or the row part of the reference, the current row/column is
2507 Org's references with @emph{unsigned} numbers are fixed references
2508 in the sense that if you use the same reference in the formula for two
2509 different fields, the same field will be referenced each time.
2510 Org's references with @emph{signed} numbers are floating
2511 references because the same reference operator can reference different
2512 fields depending on the field being calculated by the formula.
2514 Here are a few examples:
2517 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2518 $5 @r{column 5 in the current row (same as @code{E&})}
2519 @@2 @r{current column, row 2}
2520 @@-1$-3 @r{the field one row up, three columns to the left}
2521 @@-I$2 @r{field just under hline above current row, column 2}
2522 @@>$5 @r{field in the last row, in column 5}
2525 @subsubheading Range references
2526 @cindex range references
2527 @cindex references, to ranges
2529 You may reference a rectangular range of fields by specifying two field
2530 references connected by two dots @samp{..}. If both fields are in the
2531 current row, you may simply use @samp{$2..$7}, but if at least one field
2532 is in a different row, you need to use the general @code{@@row$column}
2533 format at least for the first field (i.e the reference must start with
2534 @samp{@@} in order to be interpreted correctly). Examples:
2537 $1..$3 @r{first three fields in the current row}
2538 $P..$Q @r{range, using column names (see under Advanced)}
2539 $<<<..$>> @r{start in third column, continue to the last but one}
2540 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2541 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2542 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2545 @noindent Range references return a vector of values that can be fed
2546 into Calc vector functions. Empty fields in ranges are normally suppressed,
2547 so that the vector contains only the non-empty fields. For other options
2548 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2551 @subsubheading Field coordinates in formulas
2552 @cindex field coordinates
2553 @cindex coordinates, of field
2554 @cindex row, of field coordinates
2555 @cindex column, of field coordinates
2557 One of the very first actions during evaluation of Calc formulas and Lisp
2558 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2559 row or column number of the field where the current result will go to. The
2560 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2561 @code{org-table-current-column}. Examples:
2564 @item if(@@# % 2, $#, string(""))
2565 Insert column number on odd rows, set field to empty on even rows.
2566 @item $2 = '(identity remote(FOO, @@@@#$1))
2567 Copy text or values of each row of column 1 of the table named @code{FOO}
2568 into column 2 of the current table.
2569 @item @@3 = 2 * remote(FOO, @@1$$#)
2570 Insert the doubled value of each column of row 1 of the table named
2571 @code{FOO} into row 3 of the current table.
2574 @noindent For the second/third example, the table named @code{FOO} must have
2575 at least as many rows/columns as the current table. Note that this is
2576 inefficient@footnote{The computation time scales as O(N^2) because the table
2577 named @code{FOO} is parsed for each field to be read.} for large number of
2580 @subsubheading Named references
2581 @cindex named references
2582 @cindex references, named
2583 @cindex name, of column or field
2584 @cindex constants, in calculations
2587 @vindex org-table-formula-constants
2588 @samp{$name} is interpreted as the name of a column, parameter or
2589 constant. Constants are defined globally through the option
2590 @code{org-table-formula-constants}, and locally (for the file) through a
2594 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2598 @vindex constants-unit-system
2599 @pindex constants.el
2600 Also properties (@pxref{Properties and columns}) can be used as
2601 constants in table formulas: for a property @samp{:Xyz:} use the name
2602 @samp{$PROP_Xyz}, and the property will be searched in the current
2603 outline entry and in the hierarchy above it. If you have the
2604 @file{constants.el} package, it will also be used to resolve constants,
2605 including natural constants like @samp{$h} for Planck's constant, and
2606 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2607 supply the values of constants in two different unit systems, @code{SI}
2608 and @code{cgs}. Which one is used depends on the value of the variable
2609 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2610 @code{constSI} and @code{constcgs} to set this value for the current
2611 buffer.}. Column names and parameters can be specified in special table
2612 lines. These are described below, see @ref{Advanced features}. All
2613 names must start with a letter, and further consist of letters and
2616 @subsubheading Remote references
2617 @cindex remote references
2618 @cindex references, remote
2619 @cindex references, to a different table
2620 @cindex name, of column or field
2621 @cindex constants, in calculations
2622 @cindex #+NAME, for table
2624 You may also reference constants, fields and ranges from a different table,
2625 either in the current file or even in a different file. The syntax is
2628 remote(NAME-OR-ID,REF)
2632 where NAME can be the name of a table in the current file as set by a
2633 @code{#+NAME: Name} line before the table. It can also be the ID of an
2634 entry, even in a different file, and the reference then refers to the first
2635 table in that entry. REF is an absolute field or range reference as
2636 described above for example @code{@@3$3} or @code{$somename}, valid in the
2639 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2640 it will be substituted with the name or ID found in this field of the current
2641 table. For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2642 @@>$1)}. The format @code{B3} is not supported because it can not be
2643 distinguished from a plain table name or ID.
2645 @node Formula syntax for Calc
2646 @subsection Formula syntax for Calc
2647 @cindex formula syntax, Calc
2648 @cindex syntax, of formulas
2650 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2651 package. Note that @file{calc} has the non-standard convention that @samp{/}
2652 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2653 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2654 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2655 GNU Emacs Calc Manual}), variable substitution takes place according to the
2656 rules described above.
2657 @cindex vectors, in table calculations
2658 The range vectors can be directly fed into the Calc vector functions
2659 like @samp{vmean} and @samp{vsum}.
2661 @cindex format specifier
2662 @cindex mode, for @file{calc}
2663 @vindex org-calc-default-modes
2664 A formula can contain an optional mode string after a semicolon. This
2665 string consists of flags to influence Calc and other modes during
2666 execution. By default, Org uses the standard Calc modes (precision
2667 12, angular units degrees, fraction and symbolic modes off). The display
2668 format, however, has been changed to @code{(float 8)} to keep tables
2669 compact. The default settings can be configured using the option
2670 @code{org-calc-default-modes}.
2672 @noindent List of modes:
2676 Set the internal Calc calculation precision to 20 digits.
2677 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2678 Normal, scientific, engineering or fixed format of the result of Calc passed
2679 back to Org. Calc formatting is unlimited in precision as long as the Calc
2680 calculation precision is greater.
2681 @item @code{D}, @code{R}
2682 Degree and radian angle modes of Calc.
2683 @item @code{F}, @code{S}
2684 Fraction and symbolic modes of Calc.
2685 @item @code{T}, @code{t}
2686 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2688 If and how to consider empty fields. Without @samp{E} empty fields in range
2689 references are suppressed so that the Calc vector or Lisp list contains only
2690 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2691 fields in ranges or empty field references the value @samp{nan} (not a
2692 number) is used in Calc formulas and the empty string is used for Lisp
2693 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2694 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2696 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2697 to see how this is essential for computations with Lisp formulas. In Calc
2698 formulas it is used only occasionally because there number strings are
2699 already interpreted as numbers without @samp{N}.
2701 Literal, for Lisp formulas only. See the next section.
2705 Unless you use large integer numbers or high-precision-calculation and
2706 -display for floating point numbers you may alternatively provide a
2707 @samp{printf} format specifier to reformat the Calc result after it has been
2708 passed back to Org instead of letting Calc already do the
2709 formatting@footnote{The @samp{printf} reformatting is limited in precision
2710 because the value passed to it is converted into an @samp{integer} or
2711 @samp{double}. The @samp{integer} is limited in size by truncating the
2712 signed value to 32 bits. The @samp{double} is limited in precision to 64
2713 bits overall which leaves approximately 16 significant decimal digits.}. A
2717 $1+$2 @r{Sum of first and second field}
2718 $1+$2;%.2f @r{Same, format result to two decimals}
2719 exp($2)+exp($1) @r{Math functions can be used}
2720 $0;%.1f @r{Reformat current cell to 1 decimal}
2721 ($3-32)*5/9 @r{Degrees F -> C conversion}
2722 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2723 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2724 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2725 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2728 Calc also contains a complete set of logical operations, (@pxref{Logical
2729 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2732 @item if($1 < 20, teen, string(""))
2733 "teen" if age $1 is less than 20, else the Org table result field is set to
2734 empty with the empty string.
2735 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2736 Sum of the first two columns. When at least one of the input fields is empty
2737 the Org table result field is set to empty. @samp{E} is required to not
2738 convert empty fields to 0. @samp{f-1} is an optional Calc format string
2739 similar to @samp{%.1f} but leaves empty results empty.
2740 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2741 Mean value of a range unless there is any empty field. Every field in the
2742 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2743 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2744 @samp{vmean} and the Org table result field is set to empty. Use this when
2745 the sample set is expected to never have missing values.
2746 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2747 Mean value of a range with empty fields skipped. Every field in the range
2748 that is empty is skipped. When all fields in the range are empty the mean
2749 value is not defined and the Org table result field is set to empty. Use
2750 this when the sample set can have a variable size.
2751 @item vmean($1..$7); EN
2752 To complete the example before: Mean value of a range with empty fields
2753 counting as samples with value 0. Use this only when incomplete sample sets
2754 should be padded with 0 to the full size.
2757 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2758 and use them in formula syntax for Calc.
2760 @node Formula syntax for Lisp
2761 @subsection Emacs Lisp forms as formulas
2762 @cindex Lisp forms, as table formulas
2764 It is also possible to write a formula in Emacs Lisp. This can be useful
2765 for string manipulation and control structures, if Calc's functionality is
2768 If a formula starts with a single-quote followed by an opening parenthesis,
2769 then it is evaluated as a Lisp form. The evaluation should return either a
2770 string or a number. Just as with @file{calc} formulas, you can specify modes
2771 and a printf format after a semicolon.
2773 With Emacs Lisp forms, you need to be conscious about the way field
2774 references are interpolated into the form. By default, a reference will be
2775 interpolated as a Lisp string (in double-quotes) containing the field. If
2776 you provide the @samp{N} mode switch, all referenced elements will be numbers
2777 (non-number fields will be zero) and interpolated as Lisp numbers, without
2778 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2779 literally, without quotes. I.e., if you want a reference to be interpreted
2780 as a string by the Lisp form, enclose the reference operator itself in
2781 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2782 fields, so you can embed them in list or vector syntax.
2784 Here are a few examples---note how the @samp{N} mode is used when we do
2785 computations in Lisp:
2788 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2789 Swap the first two characters of the content of column 1.
2791 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2792 @item '(apply '+ '($1..$4));N
2793 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2796 @node Durations and time values
2797 @subsection Durations and time values
2798 @cindex Duration, computing
2799 @cindex Time, computing
2800 @vindex org-table-duration-custom-format
2802 If you want to compute time values use the @code{T} flag, either in Calc
2803 formulas or Elisp formulas:
2807 | Task 1 | Task 2 | Total |
2808 |---------+----------+----------|
2809 | 2:12 | 1:47 | 03:59:00 |
2810 | 3:02:20 | -2:07:00 | 0.92 |
2811 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2815 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2816 are optional. With the @code{T} flag, computed durations will be displayed
2817 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2818 computed durations will be displayed according to the value of the option
2819 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2820 will display the result as a fraction of hours (see the second formula in the
2823 Negative duration values can be manipulated as well, and integers will be
2824 considered as seconds in addition and subtraction.
2826 @node Field and range formulas
2827 @subsection Field and range formulas
2828 @cindex field formula
2829 @cindex range formula
2830 @cindex formula, for individual table field
2831 @cindex formula, for range of fields
2833 To assign a formula to a particular field, type it directly into the field,
2834 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2835 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2836 the formula will be stored as the formula for this field, evaluated, and the
2837 current field will be replaced with the result.
2840 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2841 below the table. If you type the equation in the 4th field of the 3rd data
2842 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2843 inserting/deleting/swapping columns and rows with the appropriate commands,
2844 @i{absolute references} (but not relative ones) in stored formulas are
2845 modified in order to still reference the same field. To avoid this, in
2846 particular in range references, anchor ranges at the table borders (using
2847 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2848 @code{@@I} notation. Automatic adaptation of field references does of course
2849 not happen if you edit the table structure with normal editing
2850 commands---then you must fix the equations yourself.
2852 Instead of typing an equation into the field, you may also use the following
2856 @orgcmd{C-u C-c =,org-table-eval-formula}
2857 Install a new formula for the current field. The command prompts for a
2858 formula with default taken from the @samp{#+TBLFM:} line, applies
2859 it to the current field, and stores it.
2862 The left-hand side of a formula can also be a special expression in order to
2863 assign the formula to a number of different fields. There is no keyboard
2864 shortcut to enter such range formulas. To add them, use the formula editor
2865 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2870 Column formula, valid for the entire column. This is so common that Org
2871 treats these formulas in a special way, see @ref{Column formulas}.
2873 Row formula, applies to all fields in the specified row. @code{@@>=} means
2876 Range formula, applies to all fields in the given rectangular range. This
2877 can also be used to assign a formula to some but not all fields in a row.
2879 Named field, see @ref{Advanced features}.
2882 @node Column formulas
2883 @subsection Column formulas
2884 @cindex column formula
2885 @cindex formula, for table column
2887 When you assign a formula to a simple column reference like @code{$3=}, the
2888 same formula will be used in all fields of that column, with the following
2889 very convenient exceptions: (i) If the table contains horizontal separator
2890 hlines with rows above and below, everything before the first such hline is
2891 considered part of the table @emph{header} and will not be modified by column
2892 formulas. Therefore a header is mandatory when you use column formulas and
2893 want to add hlines to group rows, like for example to separate a total row at
2894 the bottom from the summand rows above. (ii) Fields that already get a value
2895 from a field/range formula will be left alone by column formulas. These
2896 conditions make column formulas very easy to use.
2898 To assign a formula to a column, type it directly into any field in the
2899 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2900 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2901 the formula will be stored as the formula for the current column, evaluated
2902 and the current field replaced with the result. If the field contains only
2903 @samp{=}, the previously stored formula for this column is used. For each
2904 column, Org will only remember the most recently used formula. In the
2905 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2906 left-hand side of a column formula cannot be the name of column, it must be
2907 the numeric column reference or @code{$>}.
2909 Instead of typing an equation into the field, you may also use the
2913 @orgcmd{C-c =,org-table-eval-formula}
2914 Install a new formula for the current column and replace current field with
2915 the result of the formula. The command prompts for a formula, with default
2916 taken from the @samp{#+TBLFM} line, applies it to the current field and
2917 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2918 will apply it to that many consecutive fields in the current column.
2921 @node Lookup functions
2922 @subsection Lookup functions
2923 @cindex lookup functions in tables
2924 @cindex table lookup functions
2926 Org has three predefined Emacs Lisp functions for lookups in tables.
2928 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2929 @findex org-lookup-first
2930 Searches for the first element @code{S} in list @code{S-LIST} for which
2934 is @code{t}; returns the value from the corresponding position in list
2935 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2936 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2937 order as the corresponding parameters are in the call to
2938 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2939 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2941 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2942 @findex org-lookup-last
2943 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2944 element for which @code{PREDICATE} is @code{t}.
2945 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2946 @findex org-lookup-all
2947 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2948 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2949 values. This function can not be used by itself in a formula, because it
2950 returns a list of values. However, powerful lookups can be built when this
2951 function is combined with other Emacs Lisp functions.
2954 If the ranges used in these functions contain empty fields, the @code{E} mode
2955 for the formula should usually be specified: otherwise empty fields will not be
2956 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2957 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2958 element of @code{R-LIST}.
2960 These three functions can be used to implement associative arrays, count
2961 matching cells, rank results, group data etc. For practical examples
2962 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2965 @node Editing and debugging formulas
2966 @subsection Editing and debugging formulas
2967 @cindex formula editing
2968 @cindex editing, of table formulas
2970 @vindex org-table-use-standard-references
2971 You can edit individual formulas in the minibuffer or directly in the field.
2972 Org can also prepare a special buffer with all active formulas of a table.
2973 When offering a formula for editing, Org converts references to the standard
2974 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2975 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2976 option @code{org-table-use-standard-references}.
2979 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2980 Edit the formula associated with the current column/field in the
2981 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2982 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2983 Re-insert the active formula (either a
2984 field formula, or a column formula) into the current field, so that you
2985 can edit it directly in the field. The advantage over editing in the
2986 minibuffer is that you can use the command @kbd{C-c ?}.
2987 @orgcmd{C-c ?,org-table-field-info}
2988 While editing a formula in a table field, highlight the field(s)
2989 referenced by the reference at the cursor position in the formula.
2991 @findex org-table-toggle-coordinate-overlays
2993 Toggle the display of row and column numbers for a table, using overlays
2994 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2995 time the table is aligned; you can force it with @kbd{C-c C-c}.
2997 @findex org-table-toggle-formula-debugger
2999 Toggle the formula debugger on and off
3000 (@command{org-table-toggle-formula-debugger}). See below.
3001 @orgcmd{C-c ',org-table-edit-formulas}
3002 Edit all formulas for the current table in a special buffer, where the
3003 formulas will be displayed one per line. If the current field has an
3004 active formula, the cursor in the formula editor will mark it.
3005 While inside the special buffer, Org will automatically highlight
3006 any field or range reference at the cursor position. You may edit,
3007 remove and add formulas, and use the following commands:
3010 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3011 Exit the formula editor and store the modified formulas. With @kbd{C-u}
3012 prefix, also apply the new formulas to the entire table.
3013 @orgcmd{C-c C-q,org-table-fedit-abort}
3014 Exit the formula editor without installing changes.
3015 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3016 Toggle all references in the formula editor between standard (like
3017 @code{B3}) and internal (like @code{@@3$2}).
3018 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3019 Pretty-print or indent Lisp formula at point. When in a line containing
3020 a Lisp formula, format the formula according to Emacs Lisp rules.
3021 Another @key{TAB} collapses the formula back again. In the open
3022 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3023 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3024 Complete Lisp symbols, just like in Emacs Lisp mode.
3026 @kindex S-@key{down}
3027 @kindex S-@key{left}
3028 @kindex S-@key{right}
3029 @findex org-table-fedit-ref-up
3030 @findex org-table-fedit-ref-down
3031 @findex org-table-fedit-ref-left
3032 @findex org-table-fedit-ref-right
3033 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3034 Shift the reference at point. For example, if the reference is
3035 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3036 This also works for relative references and for hline references.
3037 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3038 Move the test line for column formulas in the Org buffer up and
3040 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3041 Scroll the window displaying the table.
3043 @findex org-table-toggle-coordinate-overlays
3045 Turn the coordinate grid in the table on and off.
3049 Making a table field blank does not remove the formula associated with
3050 the field, because that is stored in a different line (the @samp{#+TBLFM}
3051 line)---during the next recalculation the field will be filled again.
3052 To remove a formula from a field, you have to give an empty reply when
3053 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3056 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3057 equations with @kbd{C-c C-c} in that line or with the normal
3058 recalculation commands in the table.
3060 @anchor{Using multiple #+TBLFM lines}
3061 @subsubheading Using multiple #+TBLFM lines
3062 @cindex #+TBLFM line, multiple
3064 @cindex #+TBLFM, switching
3067 You may apply the formula temporarily. This is useful when you
3068 switch the formula. Place multiple @samp{#+TBLFM} lines right
3069 after the table, and then press @kbd{C-c C-c} on the formula to
3070 apply. Here is an example:
3082 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3094 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3095 will get the following result of applying only the first @samp{#+TBLFM} line.
3106 @subsubheading Debugging formulas
3107 @cindex formula debugging
3108 @cindex debugging, of table formulas
3109 When the evaluation of a formula leads to an error, the field content
3110 becomes the string @samp{#ERROR}. If you would like see what is going
3111 on during variable substitution and calculation in order to find a bug,
3112 turn on formula debugging in the @code{Tbl} menu and repeat the
3113 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3114 field. Detailed information will be displayed.
3116 @node Updating the table
3117 @subsection Updating the table
3118 @cindex recomputing table fields
3119 @cindex updating, table
3121 Recalculation of a table is normally not automatic, but needs to be
3122 triggered by a command. See @ref{Advanced features}, for a way to make
3123 recalculation at least semi-automatic.
3125 In order to recalculate a line of a table or the entire table, use the
3129 @orgcmd{C-c *,org-table-recalculate}
3130 Recalculate the current row by first applying the stored column formulas
3131 from left to right, and all field/range formulas in the current row.
3137 Recompute the entire table, line by line. Any lines before the first
3138 hline are left alone, assuming that these are part of the table header.
3140 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3141 Iterate the table by recomputing it until no further changes occur.
3142 This may be necessary if some computed fields use the value of other
3143 fields that are computed @i{later} in the calculation sequence.
3144 @item M-x org-table-recalculate-buffer-tables RET
3145 @findex org-table-recalculate-buffer-tables
3146 Recompute all tables in the current buffer.
3147 @item M-x org-table-iterate-buffer-tables RET
3148 @findex org-table-iterate-buffer-tables
3149 Iterate all tables in the current buffer, in order to converge table-to-table
3153 @node Advanced features
3154 @subsection Advanced features
3156 If you want the recalculation of fields to happen automatically, or if you
3157 want to be able to assign @i{names}@footnote{Such names must start by an
3158 alphabetic character and use only alphanumeric/underscore characters.} to
3159 fields and columns, you need to reserve the first column of the table for
3160 special marking characters.
3163 @orgcmd{C-#,org-table-rotate-recalc-marks}
3164 Rotate the calculation mark in first column through the states @samp{ },
3165 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3166 change all marks in the region.
3169 Here is an example of a table that collects exam results of students and
3170 makes use of these features:
3174 |---+---------+--------+--------+--------+-------+------|
3175 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3176 |---+---------+--------+--------+--------+-------+------|
3177 | ! | | P1 | P2 | P3 | Tot | |
3178 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3179 | ^ | | m1 | m2 | m3 | mt | |
3180 |---+---------+--------+--------+--------+-------+------|
3181 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3182 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3183 |---+---------+--------+--------+--------+-------+------|
3184 | | Average | | | | 25.0 | |
3185 | ^ | | | | | at | |
3186 | $ | max=50 | | | | | |
3187 |---+---------+--------+--------+--------+-------+------|
3188 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3192 @noindent @b{Important}: please note that for these special tables,
3193 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3194 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3195 to the field itself. The column formulas are not applied in rows with
3198 @cindex marking characters, tables
3199 The marking characters have the following meaning:
3203 The fields in this line define names for the columns, so that you may
3204 refer to a column as @samp{$Tot} instead of @samp{$6}.
3206 This row defines names for the fields @emph{above} the row. With such
3207 a definition, any formula in the table may use @samp{$m1} to refer to
3208 the value @samp{10}. Also, if you assign a formula to a names field, it
3209 will be stored as @samp{$name=...}.
3211 Similar to @samp{^}, but defines names for the fields in the row
3214 Fields in this row can define @emph{parameters} for formulas. For
3215 example, if a field in a @samp{$} row contains @samp{max=50}, then
3216 formulas in this table can refer to the value 50 using @samp{$max}.
3217 Parameters work exactly like constants, only that they can be defined on
3220 Fields in this row are automatically recalculated when pressing
3221 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3222 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3223 lines will be left alone by this command.
3225 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3226 not for automatic recalculation. Use this when automatic
3227 recalculation slows down editing too much.
3229 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3230 All lines that should be recalculated should be marked with @samp{#}
3233 Do not export this line. Useful for lines that contain the narrowing
3234 @samp{<N>} markers or column group markers.
3237 Finally, just to whet your appetite for what can be done with the
3238 fantastic @file{calc.el} package, here is a table that computes the Taylor
3239 series of degree @code{n} at location @code{x} for a couple of
3244 |---+-------------+---+-----+--------------------------------------|
3245 | | Func | n | x | Result |
3246 |---+-------------+---+-----+--------------------------------------|
3247 | # | exp(x) | 1 | x | 1 + x |
3248 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3249 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3250 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3251 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3252 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3253 |---+-------------+---+-----+--------------------------------------|
3254 #+TBLFM: $5=taylor($2,$4,$3);n3
3260 @cindex graph, in tables
3261 @cindex plot tables using Gnuplot
3264 Org-Plot can produce graphs of information stored in org tables, either
3265 graphically or in ASCII-art.
3267 @subheading Graphical plots using @file{Gnuplot}
3269 Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
3270 @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3271 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3272 that you have both Gnuplot and Gnuplot mode installed on your system, then
3273 call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
3278 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3279 | Sede | Max cites | H-index |
3280 |-----------+-----------+---------|
3281 | Chile | 257.72 | 21.39 |
3282 | Leeds | 165.77 | 19.68 |
3283 | Sao Paolo | 71.00 | 11.50 |
3284 | Stockholm | 134.19 | 14.33 |
3285 | Morelia | 257.56 | 17.67 |
3289 Notice that Org Plot is smart enough to apply the table's headers as labels.
3290 Further control over the labels, type, content, and appearance of plots can
3291 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3292 for a complete list of Org-plot options. The @code{#+PLOT:} lines are
3293 optional. For more information and examples see the Org-plot tutorial at
3294 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3296 @subsubheading Plot Options
3300 Specify any @command{gnuplot} option to be set when graphing.
3303 Specify the title of the plot.
3306 Specify which column of the table to use as the @code{x} axis.
3309 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3310 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3311 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3315 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3318 Specify a @code{with} option to be inserted for every col being plotted
3319 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3320 Defaults to @code{lines}.
3323 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3326 List of labels to be used for the @code{deps} (defaults to the column headers
3330 Specify an entire line to be inserted in the Gnuplot script.
3333 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3334 flat mapping rather than a @code{3d} slope.
3337 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3338 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3341 If you want total control, you can specify a script file (place the file name
3342 between double-quotes) which will be used to plot. Before plotting, every
3343 instance of @code{$datafile} in the specified script will be replaced with
3344 the path to the generated data file. Note: even if you set this option, you
3345 may still want to specify the plot type, as that can impact the content of
3349 @subheading ASCII bar plots
3351 While the cursor is on a column, typing @kbd{C-c " a} or
3352 @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
3353 ASCII-art bars plot. The plot is implemented through a regular column
3354 formula. When the source column changes, the bar plot may be updated by
3355 refreshing the table, for example typing @kbd{C-u C-c *}.
3359 | Sede | Max cites | |
3360 |---------------+-----------+--------------|
3361 | Chile | 257.72 | WWWWWWWWWWWW |
3362 | Leeds | 165.77 | WWWWWWWh |
3363 | Sao Paolo | 71.00 | WWW; |
3364 | Stockholm | 134.19 | WWWWWW: |
3365 | Morelia | 257.56 | WWWWWWWWWWWH |
3366 | Rochefourchat | 0.00 | |
3367 #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3371 The formula is an elisp call:
3373 (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
3378 is a reference to the source column.
3381 are the minimal and maximal values displayed. Sources values
3382 outside this range are displayed as @samp{too small}
3383 or @samp{too large}.
3386 is the width in characters of the bar-plot. It defaults to @samp{12}.
3394 Like HTML, Org provides links inside a file, external links to
3395 other files, Usenet articles, emails, and much more.
3398 * Link format:: How links in Org are formatted
3399 * Internal links:: Links to other places in the current file
3400 * External links:: URL-like links to the world
3401 * Handling links:: Creating, inserting and following
3402 * Using links outside Org:: Linking from my C source code?
3403 * Link abbreviations:: Shortcuts for writing complex links
3404 * Search options:: Linking to a specific location
3405 * Custom searches:: When the default search is not enough
3409 @section Link format
3411 @cindex format, of links
3413 Org will recognize plain URL-like links and activate them as
3414 clickable links. The general link format, however, looks like this:
3417 [[link][description]] @r{or alternatively} [[link]]
3421 Once a link in the buffer is complete (all brackets present), Org
3422 will change the display so that @samp{description} is displayed instead
3423 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3424 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3425 which by default is an underlined face. You can directly edit the
3426 visible part of a link. Note that this can be either the @samp{link}
3427 part (if there is no description) or the @samp{description} part. To
3428 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3431 If you place the cursor at the beginning or just behind the end of the
3432 displayed text and press @key{BACKSPACE}, you will remove the
3433 (invisible) bracket at that location. This makes the link incomplete
3434 and the internals are again displayed as plain text. Inserting the
3435 missing bracket hides the link internals again. To show the
3436 internal structure of all links, use the menu entry
3437 @code{Org->Hyperlinks->Literal links}.
3439 @node Internal links
3440 @section Internal links
3441 @cindex internal links
3442 @cindex links, internal
3443 @cindex targets, for links
3445 @cindex property, CUSTOM_ID
3446 If the link does not look like a URL, it is considered to be internal in the
3447 current file. The most important case is a link like
3448 @samp{[[#my-custom-id]]} which will link to the entry with the
3449 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3450 to make sure these custom IDs are unique in a file.
3452 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3453 lead to a text search in the current file.
3455 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3456 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3457 point to the corresponding headline. The preferred match for a text link is
3458 a @i{dedicated target}: the same string in double angular brackets, like
3459 @samp{<<My Target>>}.
3462 If no dedicated target exists, the link will then try to match the exact name
3463 of an element within the buffer. Naming is done with the @code{#+NAME}
3464 keyword, which has to be put in the line before the element it refers to, as
3465 in the following example
3474 If none of the above succeeds, Org will search for a headline that is exactly
3475 the link text but may also include a TODO keyword and tags@footnote{To insert
3476 a link targeting a headline, in-buffer completion can be used. Just type
3477 a star followed by a few optional letters into the buffer and press
3478 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3481 During export, internal links will be used to mark objects and assign them
3482 a number. Marked objects will then be referenced by links pointing to them.
3483 In particular, links without a description will appear as the number assigned
3484 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3485 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3486 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3490 - <<target>>another item
3491 Here we refer to item [[target]].
3495 The last sentence will appear as @samp{Here we refer to item 2} when
3498 In non-Org files, the search will look for the words in the link text. In
3499 the above example the search would be for @samp{my target}.
3501 Following a link pushes a mark onto Org's own mark ring. You can
3502 return to the previous position with @kbd{C-c &}. Using this command
3503 several times in direct succession goes back to positions recorded
3507 * Radio targets:: Make targets trigger links in plain text
3511 @subsection Radio targets
3512 @cindex radio targets
3513 @cindex targets, radio
3514 @cindex links, radio targets
3516 Org can automatically turn any occurrences of certain target names
3517 in normal text into a link. So without explicitly creating a link, the
3518 text connects to the target radioing its position. Radio targets are
3519 enclosed by triple angular brackets. For example, a target @samp{<<<My
3520 Target>>>} causes each occurrence of @samp{my target} in normal text to
3521 become activated as a link. The Org file is scanned automatically
3522 for radio targets only when the file is first loaded into Emacs. To
3523 update the target list during editing, press @kbd{C-c C-c} with the
3524 cursor on or at a target.
3526 @node External links
3527 @section External links
3528 @cindex links, external
3529 @cindex external links
3537 @cindex USENET links
3542 Org supports links to files, websites, Usenet and email messages, BBDB
3543 database entries and links to both IRC conversations and their logs.
3544 External links are URL-like locators. They start with a short identifying
3545 string followed by a colon. There can be no space after the colon. The
3546 following list shows examples for each link type.
3549 http://www.astro.uva.nl/~dominik @r{on the web}
3550 doi:10.1000/182 @r{DOI for an electronic resource}
3551 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3552 /home/dominik/images/jupiter.jpg @r{same as above}
3553 file:papers/last.pdf @r{file, relative path}
3554 ./papers/last.pdf @r{same as above}
3555 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3556 /myself@@some.where:papers/last.pdf @r{same as above}
3557 file:sometextfile::NNN @r{file, jump to line number}
3558 file:projects.org @r{another Org file}
3559 file:projects.org::some words @r{text search in Org file}@footnote{
3560 The actual behavior of the search will depend on the value of
3561 the option @code{org-link-search-must-match-exact-headline}. If its value
3562 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3563 exact headline will be matched. If the value is @code{'query-to-create},
3564 then an exact headline will be searched; if it is not found, then the user
3565 will be queried to create it.}
3566 file:projects.org::*task title @r{heading search in Org file}
3567 file+sys:/path/to/file @r{open via OS, like double-click}
3568 file+emacs:/path/to/file @r{force opening by Emacs}
3569 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3570 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3571 news:comp.emacs @r{Usenet link}
3572 mailto:adent@@galaxy.net @r{Mail link}
3573 mhe:folder @r{MH-E folder link}
3574 mhe:folder#id @r{MH-E message link}
3575 rmail:folder @r{RMAIL folder link}
3576 rmail:folder#id @r{RMAIL message link}
3577 gnus:group @r{Gnus group link}
3578 gnus:group#id @r{Gnus article link}
3579 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3580 irc:/irc.com/#emacs/bob @r{IRC link}
3581 info:org#External links @r{Info node or index link}
3582 shell:ls *.org @r{A shell command}
3583 elisp:org-agenda @r{Interactive Elisp command}
3584 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3588 @cindex WANDERLUST links
3589 On top of these built-in link types, some are available through the
3590 @code{contrib/} directory (@pxref{Installation}). For example, these links
3591 to VM or Wanderlust messages are available when you load the corresponding
3592 libraries from the @code{contrib/} directory:
3595 vm:folder @r{VM folder link}
3596 vm:folder#id @r{VM message link}
3597 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3598 vm-imap:account:folder @r{VM IMAP folder link}
3599 vm-imap:account:folder#id @r{VM IMAP message link}
3600 wl:folder @r{WANDERLUST folder link}
3601 wl:folder#id @r{WANDERLUST message link}
3604 For customizing Org to add new link types @ref{Adding hyperlink types}.
3606 A link should be enclosed in double brackets and may contain a descriptive
3607 text to be displayed instead of the URL (@pxref{Link format}), for example:
3610 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3614 If the description is a file name or URL that points to an image, HTML
3615 export (@pxref{HTML export}) will inline the image as a clickable
3616 button. If there is no description at all and the link points to an
3618 that image will be inlined into the exported HTML file.
3620 @cindex square brackets, around links
3621 @cindex plain text external links
3622 Org also finds external links in the normal text and activates them
3623 as links. If spaces must be part of the link (for example in
3624 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3625 about the end of the link, enclose them in square brackets.
3627 @node Handling links
3628 @section Handling links
3629 @cindex links, handling
3631 Org provides methods to create a link in the correct syntax, to
3632 insert it into an Org file, and to follow the link.
3635 @orgcmd{C-c l,org-store-link}
3636 @cindex storing links
3637 Store a link to the current location. This is a @emph{global} command (you
3638 must create the key binding yourself) which can be used in any buffer to
3639 create a link. The link will be stored for later insertion into an Org
3640 buffer (see below). What kind of link will be created depends on the current
3643 @b{Org mode buffers}@*
3644 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3645 to the target. Otherwise it points to the current headline, which will also
3646 be the description@footnote{If the headline contains a timestamp, it will be
3647 removed from the link and result in a wrong link---you should avoid putting
3648 timestamp in the headline.}.
3650 @vindex org-id-link-to-org-use-id
3651 @cindex property, CUSTOM_ID
3652 @cindex property, ID
3653 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3654 will be stored. In addition or alternatively (depending on the value of
3655 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3656 be created and/or used to construct a link@footnote{The library
3657 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3658 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3659 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3660 potentially create two links: a human-readable from the custom ID, and one
3661 that is globally unique and works even if the entry is moved from file to
3662 file. Later, when inserting the link, you need to decide which one to use.
3664 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3665 Pretty much all Emacs mail clients are supported. The link will point to the
3666 current article, or, in some GNUS buffers, to the group. The description is
3667 constructed from the author and the subject.
3669 @b{Web browsers: W3 and W3M}@*
3670 Here the link will be the current URL, with the page title as description.
3672 @b{Contacts: BBDB}@*
3673 Links created in a BBDB buffer will point to the current entry.
3676 @vindex org-irc-link-to-logs
3677 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3678 a @samp{file:/} style link to the relevant point in the logs for the current
3679 conversation is created. Otherwise an @samp{irc:/} style link to the
3680 user/channel/server under the point will be stored.
3683 For any other files, the link will point to the file, with a search string
3684 (@pxref{Search options}) pointing to the contents of the current line. If
3685 there is an active region, the selected words will form the basis of the
3686 search string. If the automatically created link is not working correctly or
3687 accurately enough, you can write custom functions to select the search string
3688 and to do the search for particular file types---see @ref{Custom searches}.
3689 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3692 When the cursor is in an agenda view, the created link points to the
3693 entry referenced by the current line.
3696 @orgcmd{C-c C-l,org-insert-link}
3697 @cindex link completion
3698 @cindex completion, of links
3699 @cindex inserting links
3700 @vindex org-keep-stored-link-after-insertion
3701 Insert a link@footnote{Note that you don't have to use this command to
3702 insert a link. Links in Org are plain text, and you can type or paste them
3703 straight into the buffer. By using this command, the links are automatically
3704 enclosed in double brackets, and you will be asked for the optional
3705 descriptive text.}. This prompts for a link to be inserted into the buffer.
3706 You can just type a link, using text for an internal link, or one of the link
3707 type prefixes mentioned in the examples above. The link will be inserted
3708 into the buffer@footnote{After insertion of a stored link, the link will be
3709 removed from the list of stored links. To keep it in the list later use, use
3710 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3711 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3712 If some text was selected when this command is called, the selected text
3713 becomes the default description.
3715 @b{Inserting stored links}@*
3716 All links stored during the
3717 current session are part of the history for this prompt, so you can access
3718 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3720 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3721 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3722 defined through link abbreviations (@pxref{Link abbreviations}). If you
3723 press @key{RET} after inserting only the @var{prefix}, Org will offer
3724 specific completion support for some link types@footnote{This works by
3725 calling a special function @code{org-PREFIX-complete-link}.} For
3726 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3727 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3728 @key{RET}} you can complete contact names.
3730 @cindex file name completion
3731 @cindex completion, of file names
3732 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3733 a file will be inserted and you may use file name completion to select
3734 the name of the file. The path to the file is inserted relative to the
3735 directory of the current Org file, if the linked file is in the current
3736 directory or in a sub-directory of it, or if the path is written relative
3737 to the current directory using @samp{../}. Otherwise an absolute path
3738 is used, if possible with @samp{~/} for your home directory. You can
3739 force an absolute path with two @kbd{C-u} prefixes.
3741 @item C-c C-l @ @r{(with cursor on existing link)}
3742 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3743 link and description parts of the link.
3745 @cindex following links
3746 @orgcmd{C-c C-o,org-open-at-point}
3747 @vindex org-file-apps
3748 @vindex org-link-frame-setup
3749 Open link at point. This will launch a web browser for URLs (using
3750 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3751 the corresponding links, and execute the command in a shell link. When the
3752 cursor is on an internal link, this command runs the corresponding search.
3753 When the cursor is on a TAG list in a headline, it creates the corresponding
3754 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3755 date. Furthermore, it will visit text and remote files in @samp{file:} links
3756 with Emacs and select a suitable application for local non-text files.
3757 Classification of files is based on file extension only. See option
3758 @code{org-file-apps}. If you want to override the default application and
3759 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3760 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3761 If the cursor is on a headline, but not on a link, offer all links in the
3762 headline and entry text. If you want to setup the frame configuration for
3763 following links, customize @code{org-link-frame-setup}.
3766 @vindex org-return-follows-link
3767 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3774 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3775 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3779 @vindex org-display-internal-link-with-indirect-buffer
3780 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3781 internal links to be displayed in another window@footnote{See the
3782 option @code{org-display-internal-link-with-indirect-buffer}}.
3784 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3785 @cindex inlining images
3786 @cindex images, inlining
3787 @vindex org-startup-with-inline-images
3788 @cindex @code{inlineimages}, STARTUP keyword
3789 @cindex @code{noinlineimages}, STARTUP keyword
3790 Toggle the inline display of linked images. Normally this will only inline
3791 images that have no description part in the link, i.e., images that will also
3792 be inlined during export. When called with a prefix argument, also display
3793 images that do have a link description. You can ask for inline images to be
3794 displayed at startup by configuring the variable
3795 @code{org-startup-with-inline-images}@footnote{with corresponding
3796 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3797 @orgcmd{C-c %,org-mark-ring-push}
3799 Push the current position onto the mark ring, to be able to return
3800 easily. Commands following an internal link do this automatically.
3802 @orgcmd{C-c &,org-mark-ring-goto}
3803 @cindex links, returning to
3804 Jump back to a recorded position. A position is recorded by the
3805 commands following internal links, and by @kbd{C-c %}. Using this
3806 command several times in direct succession moves through a ring of
3807 previously recorded positions.
3809 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3810 @cindex links, finding next/previous
3811 Move forward/backward to the next link in the buffer. At the limit of
3812 the buffer, the search fails once, and then wraps around. The key
3813 bindings for this are really too long; you might want to bind this also
3814 to @kbd{C-n} and @kbd{C-p}
3816 (add-hook 'org-load-hook
3818 (define-key org-mode-map "\C-n" 'org-next-link)
3819 (define-key org-mode-map "\C-p" 'org-previous-link)))
3823 @node Using links outside Org
3824 @section Using links outside Org
3826 You can insert and follow links that have Org syntax not only in
3827 Org, but in any Emacs buffer. For this, you should create two
3828 global commands, like this (please select suitable global keys
3832 (global-set-key "\C-c L" 'org-insert-link-global)
3833 (global-set-key "\C-c o" 'org-open-at-point-global)
3836 @node Link abbreviations
3837 @section Link abbreviations
3838 @cindex link abbreviations
3839 @cindex abbreviation, links
3841 Long URLs can be cumbersome to type, and often many similar links are
3842 needed in a document. For this you can use link abbreviations. An
3843 abbreviated link looks like this
3846 [[linkword:tag][description]]
3850 @vindex org-link-abbrev-alist
3851 where the tag is optional.
3852 The @i{linkword} must be a word, starting with a letter, followed by
3853 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3854 according to the information in the variable @code{org-link-abbrev-alist}
3855 that relates the linkwords to replacement text. Here is an example:
3859 (setq org-link-abbrev-alist
3860 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3861 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3862 ("google" . "http://www.google.com/search?q=")
3863 ("gmap" . "http://maps.google.com/maps?q=%s")
3864 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3865 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3869 If the replacement text contains the string @samp{%s}, it will be
3870 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3871 url-encode the tag (see the example above, where we need to encode
3872 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3873 to a custom function, and replace it by the resulting string.
3875 If the replacement text doesn't contain any specifier, it will simply
3876 be appended to the string in order to create the link.
3878 Instead of a string, you may also specify a function that will be
3879 called with the tag as the only argument to create the link.
3881 With the above setting, you could link to a specific bug with
3882 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3883 @code{[[google:OrgMode]]}, show the map location of the Free Software
3884 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3885 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3886 what the Org author is doing besides Emacs hacking with
3887 @code{[[ads:Dominik,C]]}.
3889 If you need special abbreviations just for a single Org buffer, you
3890 can define them in the file with
3894 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3895 #+LINK: google http://www.google.com/search?q=%s
3899 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3900 complete link abbreviations. You may also define a function
3901 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3902 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3903 not accept any arguments, and return the full link with prefix.
3905 @node Search options
3906 @section Search options in file links
3907 @cindex search option in file links
3908 @cindex file links, searching
3910 File links can contain additional information to make Emacs jump to a
3911 particular location in the file when following a link. This can be a
3912 line number or a search option after a double@footnote{For backward
3913 compatibility, line numbers can also follow a single colon.} colon. For
3914 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3915 links}) to a file, it encodes the words in the current line as a search
3916 string that can be used to find this line back later when following the
3917 link with @kbd{C-c C-o}.
3919 Here is the syntax of the different ways to attach a search to a file
3920 link, together with an explanation:
3923 [[file:~/code/main.c::255]]
3924 [[file:~/xx.org::My Target]]
3925 [[file:~/xx.org::*My Target]]
3926 [[file:~/xx.org::#my-custom-id]]
3927 [[file:~/xx.org::/regexp/]]
3934 Search for a link target @samp{<<My Target>>}, or do a text search for
3935 @samp{my target}, similar to the search in internal links, see
3936 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3937 link will become an HTML reference to the corresponding named anchor in
3940 In an Org file, restrict search to headlines.
3942 Link to a heading with a @code{CUSTOM_ID} property
3944 Do a regular expression search for @code{regexp}. This uses the Emacs
3945 command @code{occur} to list all matches in a separate window. If the
3946 target file is in Org mode, @code{org-occur} is used to create a
3947 sparse tree with the matches.
3948 @c If the target file is a directory,
3949 @c @code{grep} will be used to search all files in the directory.
3952 As a degenerate case, a file link with an empty file name can be used
3953 to search the current file. For example, @code{[[file:::find me]]} does
3954 a search for @samp{find me} in the current file, just as
3955 @samp{[[find me]]} would.
3957 @node Custom searches
3958 @section Custom Searches
3959 @cindex custom search strings
3960 @cindex search strings, custom
3962 The default mechanism for creating search strings and for doing the
3963 actual search related to a file link may not work correctly in all
3964 cases. For example, Bib@TeX{} database files have many entries like
3965 @samp{year="1993"} which would not result in good search strings,
3966 because the only unique identification for a Bib@TeX{} entry is the
3969 @vindex org-create-file-search-functions
3970 @vindex org-execute-file-search-functions
3971 If you come across such a problem, you can write custom functions to set
3972 the right search string for a particular file type, and to do the search
3973 for the string in the file. Using @code{add-hook}, these functions need
3974 to be added to the hook variables
3975 @code{org-create-file-search-functions} and
3976 @code{org-execute-file-search-functions}. See the docstring for these
3977 variables for more information. Org actually uses this mechanism
3978 for Bib@TeX{} database files, and you can use the corresponding code as
3979 an implementation example. See the file @file{org-bibtex.el}.
3985 Org mode does not maintain TODO lists as separate documents@footnote{Of
3986 course, you can make a document that contains only long lists of TODO items,
3987 but this is not required.}. Instead, TODO items are an integral part of the
3988 notes file, because TODO items usually come up while taking notes! With Org
3989 mode, simply mark any entry in a tree as being a TODO item. In this way,
3990 information is not duplicated, and the entire context from which the TODO
3991 item emerged is always present.
3993 Of course, this technique for managing TODO items scatters them
3994 throughout your notes file. Org mode compensates for this by providing
3995 methods to give you an overview of all the things that you have to do.
3998 * TODO basics:: Marking and displaying TODO entries
3999 * TODO extensions:: Workflow and assignments
4000 * Progress logging:: Dates and notes for progress
4001 * Priorities:: Some things are more important than others
4002 * Breaking down tasks:: Splitting a task into manageable pieces
4003 * Checkboxes:: Tick-off lists
4007 @section Basic TODO functionality
4009 Any headline becomes a TODO item when it starts with the word
4010 @samp{TODO}, for example:
4013 *** TODO Write letter to Sam Fortune
4017 The most important commands to work with TODO entries are:
4020 @orgcmd{C-c C-t,org-todo}
4021 @cindex cycling, of TODO states
4022 @vindex org-use-fast-todo-selection
4024 Rotate the TODO state of the current item among
4027 ,-> (unmarked) -> TODO -> DONE --.
4028 '--------------------------------'
4031 If TODO keywords have fast access keys (see @ref{Fast access to TODO
4032 states}), you will be prompted for a TODO keyword through the fast selection
4033 interface; this is the default behavior when
4034 @code{org-use-fast-todo-selection} is non-@code{nil}.
4036 The same rotation can also be done ``remotely'' from the timeline and agenda
4037 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
4039 @orgkey{C-u C-c C-t}
4040 When TODO keywords have no selection keys, select a specific keyword using
4041 completion; otherwise force cycling through TODO states with no prompt. When
4042 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
4043 selection interface.
4045 @kindex S-@key{right}
4046 @kindex S-@key{left}
4047 @item S-@key{right} @ @r{/} @ S-@key{left}
4048 @vindex org-treat-S-cursor-todo-selection-as-state-change
4049 Select the following/preceding TODO state, similar to cycling. Useful
4050 mostly if more than two TODO states are possible (@pxref{TODO
4051 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
4052 with @code{shift-selection-mode}. See also the variable
4053 @code{org-treat-S-cursor-todo-selection-as-state-change}.
4054 @orgcmd{C-c / t,org-show-todo-tree}
4055 @cindex sparse tree, for TODO
4056 @vindex org-todo-keywords
4057 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
4058 entire buffer, but shows all TODO items (with not-DONE state) and the
4059 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
4060 / T}), search for a specific TODO@. You will be prompted for the keyword,
4061 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4062 entries that match any one of these keywords. With a numeric prefix argument
4063 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4064 With two prefix arguments, find all TODO states, both un-done and done.
4065 @orgcmd{C-c a t,org-todo-list}
4066 Show the global TODO list. Collects the TODO items (with not-DONE states)
4067 from all agenda files (@pxref{Agenda views}) into a single buffer. The new
4068 buffer will be in @code{agenda-mode}, which provides commands to examine and
4069 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4070 @xref{Global TODO list}, for more information.
4071 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4072 Insert a new TODO entry below the current one.
4076 @vindex org-todo-state-tags-triggers
4077 Changing a TODO state can also trigger tag changes. See the docstring of the
4078 option @code{org-todo-state-tags-triggers} for details.
4080 @node TODO extensions
4081 @section Extended use of TODO keywords
4082 @cindex extended TODO keywords
4084 @vindex org-todo-keywords
4085 By default, marked TODO entries have one of only two states: TODO and
4086 DONE@. Org mode allows you to classify TODO items in more complex ways
4087 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
4088 special setup, the TODO keyword system can work differently in different
4091 Note that @i{tags} are another way to classify headlines in general and
4092 TODO items in particular (@pxref{Tags}).
4095 * Workflow states:: From TODO to DONE in steps
4096 * TODO types:: I do this, Fred does the rest
4097 * Multiple sets in one file:: Mixing it all, and still finding your way
4098 * Fast access to TODO states:: Single letter selection of a state
4099 * Per-file keywords:: Different files, different requirements
4100 * Faces for TODO keywords:: Highlighting states
4101 * TODO dependencies:: When one task needs to wait for others
4104 @node Workflow states
4105 @subsection TODO keywords as workflow states
4106 @cindex TODO workflow
4107 @cindex workflow states as TODO keywords
4109 You can use TODO keywords to indicate different @emph{sequential} states
4110 in the process of working on an item, for example@footnote{Changing
4111 this variable only becomes effective after restarting Org mode in a
4115 (setq org-todo-keywords
4116 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4119 The vertical bar separates the TODO keywords (states that @emph{need
4120 action}) from the DONE states (which need @emph{no further action}). If
4121 you don't provide the separator bar, the last state is used as the DONE
4123 @cindex completion, of TODO keywords
4124 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4125 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4126 also use a numeric prefix argument to quickly select a specific state. For
4127 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4128 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4129 define many keywords, you can use in-buffer completion
4130 (@pxref{Completion}) or even a special one-key selection scheme
4131 (@pxref{Fast access to TODO states}) to insert these words into the
4132 buffer. Changing a TODO state can be logged with a timestamp, see
4133 @ref{Tracking TODO state changes}, for more information.
4136 @subsection TODO keywords as types
4138 @cindex names as TODO keywords
4139 @cindex types as TODO keywords
4141 The second possibility is to use TODO keywords to indicate different
4142 @emph{types} of action items. For example, you might want to indicate
4143 that items are for ``work'' or ``home''. Or, when you work with several
4144 people on a single project, you might want to assign action items
4145 directly to persons, by using their names as TODO keywords. This would
4146 be set up like this:
4149 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4152 In this case, different keywords do not indicate a sequence, but rather
4153 different types. So the normal work flow would be to assign a task to a
4154 person, and later to mark it DONE@. Org mode supports this style by adapting
4155 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4156 @kbd{t} command in the timeline and agenda buffers.}. When used several
4157 times in succession, it will still cycle through all names, in order to first
4158 select the right type for a task. But when you return to the item after some
4159 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4160 to DONE@. Use prefix arguments or completion to quickly select a specific
4161 name. You can also review the items of a specific TODO type in a sparse tree
4162 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4163 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4164 from all agenda files into a single buffer, you would use the numeric prefix
4165 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4167 @node Multiple sets in one file
4168 @subsection Multiple keyword sets in one file
4169 @cindex TODO keyword sets
4171 Sometimes you may want to use different sets of TODO keywords in
4172 parallel. For example, you may want to have the basic
4173 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4174 separate state indicating that an item has been canceled (so it is not
4175 DONE, but also does not require action). Your setup would then look
4179 (setq org-todo-keywords
4180 '((sequence "TODO" "|" "DONE")
4181 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4182 (sequence "|" "CANCELED")))
4185 The keywords should all be different, this helps Org mode to keep track
4186 of which subsequence should be used for a given entry. In this setup,
4187 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4188 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4189 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4190 select the correct sequence. Besides the obvious ways like typing a
4191 keyword or using completion, you may also apply the following commands:
4194 @kindex C-S-@key{right}
4195 @kindex C-S-@key{left}
4196 @kindex C-u C-u C-c C-t
4197 @item C-u C-u C-c C-t
4198 @itemx C-S-@key{right}
4199 @itemx C-S-@key{left}
4200 These keys jump from one TODO subset to the next. In the above example,
4201 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4202 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4203 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4204 @code{shift-selection-mode} (@pxref{Conflicts}).
4205 @kindex S-@key{right}
4206 @kindex S-@key{left}
4209 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4210 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4211 from @code{DONE} to @code{REPORT} in the example above. See also
4212 @ref{Conflicts}, for a discussion of the interaction with
4213 @code{shift-selection-mode}.
4216 @node Fast access to TODO states
4217 @subsection Fast access to TODO states
4219 If you would like to quickly change an entry to an arbitrary TODO state
4220 instead of cycling through the states, you can set up keys for single-letter
4221 access to the states. This is done by adding the selection character after
4222 each keyword, in parentheses@footnote{All characters are allowed except
4223 @code{@@^!}, which have a special meaning here.}. For example:
4226 (setq org-todo-keywords
4227 '((sequence "TODO(t)" "|" "DONE(d)")
4228 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4229 (sequence "|" "CANCELED(c)")))
4232 @vindex org-fast-tag-selection-include-todo
4233 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4234 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4235 keyword from an entry.@footnote{Check also the option
4236 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4237 state through the tags interface (@pxref{Setting tags}), in case you like to
4238 mingle the two concepts. Note that this means you need to come up with
4239 unique keys across both sets of keywords.}
4241 @node Per-file keywords
4242 @subsection Setting up keywords for individual files
4243 @cindex keyword options
4244 @cindex per-file keywords
4249 It can be very useful to use different aspects of the TODO mechanism in
4250 different files. For file-local settings, you need to add special lines to
4251 the file which set the keywords and interpretation for that file only. For
4252 example, to set one of the two examples discussed above, you need one of the
4253 following lines anywhere in the file:
4256 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4258 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4259 interpretation, but it means the same as @code{#+TODO}), or
4261 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4264 A setup for using several sets in parallel would be:
4268 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4272 @cindex completion, of option keywords
4274 @noindent To make sure you are using the correct keyword, type
4275 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4277 @cindex DONE, final TODO keyword
4278 Remember that the keywords after the vertical bar (or the last keyword
4279 if no bar is there) must always mean that the item is DONE (although you
4280 may use a different word). After changing one of these lines, use
4281 @kbd{C-c C-c} with the cursor still in the line to make the changes
4282 known to Org mode@footnote{Org mode parses these lines only when
4283 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4284 cursor in a line starting with @samp{#+} is simply restarting Org mode
4285 for the current buffer.}.
4287 @node Faces for TODO keywords
4288 @subsection Faces for TODO keywords
4289 @cindex faces, for TODO keywords
4291 @vindex org-todo @r{(face)}
4292 @vindex org-done @r{(face)}
4293 @vindex org-todo-keyword-faces
4294 Org mode highlights TODO keywords with special faces: @code{org-todo}
4295 for keywords indicating that an item still has to be acted upon, and
4296 @code{org-done} for keywords indicating that an item is finished. If
4297 you are using more than 2 different states, you might want to use
4298 special faces for some of them. This can be done using the option
4299 @code{org-todo-keyword-faces}. For example:
4303 (setq org-todo-keyword-faces
4304 '(("TODO" . org-warning) ("STARTED" . "yellow")
4305 ("CANCELED" . (:foreground "blue" :weight bold))))
4309 While using a list with face properties as shown for CANCELED @emph{should}
4310 work, this does not always seem to be the case. If necessary, define a
4311 special face and use that. A string is interpreted as a color. The option
4312 @code{org-faces-easy-properties} determines if that color is interpreted as a
4313 foreground or a background color.
4315 @node TODO dependencies
4316 @subsection TODO dependencies
4317 @cindex TODO dependencies
4318 @cindex dependencies, of TODO states
4319 @cindex TODO dependencies, NOBLOCKING
4321 @vindex org-enforce-todo-dependencies
4322 @cindex property, ORDERED
4323 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4324 dependencies. Usually, a parent TODO task should not be marked DONE until
4325 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4326 there is a logical sequence to a number of (sub)tasks, so that one task
4327 cannot be acted upon before all siblings above it are done. If you customize
4328 the option @code{org-enforce-todo-dependencies}, Org will block entries
4329 from changing state to DONE while they have children that are not DONE@.
4330 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4331 will be blocked until all earlier siblings are marked DONE@. Here is an
4335 * TODO Blocked until (two) is done
4344 ** TODO b, needs to wait for (a)
4345 ** TODO c, needs to wait for (a) and (b)
4348 You can ensure an entry is never blocked by using the @code{NOBLOCKING}
4352 * This entry is never blocked
4359 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4360 @vindex org-track-ordered-property-with-tag
4361 @cindex property, ORDERED
4362 Toggle the @code{ORDERED} property of the current entry. A property is used
4363 for this behavior because this should be local to the current entry, not
4364 inherited like a tag. However, if you would like to @i{track} the value of
4365 this property with a tag for better visibility, customize the option
4366 @code{org-track-ordered-property-with-tag}.
4367 @orgkey{C-u C-u C-u C-c C-t}
4368 Change TODO state, circumventing any state blocking.
4371 @vindex org-agenda-dim-blocked-tasks
4372 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4373 that cannot be closed because of such dependencies will be shown in a dimmed
4374 font or even made invisible in agenda views (@pxref{Agenda views}).
4376 @cindex checkboxes and TODO dependencies
4377 @vindex org-enforce-todo-dependencies
4378 You can also block changes of TODO states by looking at checkboxes
4379 (@pxref{Checkboxes}). If you set the option
4380 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4381 checkboxes will be blocked from switching to DONE.
4383 If you need more complex dependency structures, for example dependencies
4384 between entries in different trees or files, check out the contributed
4385 module @file{org-depend.el}.
4388 @node Progress logging
4389 @section Progress logging
4390 @cindex progress logging
4391 @cindex logging, of progress
4393 Org mode can automatically record a timestamp and possibly a note when
4394 you mark a TODO item as DONE, or even each time you change the state of
4395 a TODO item. This system is highly configurable; settings can be on a
4396 per-keyword basis and can be localized to a file or even a subtree. For
4397 information on how to clock working time for a task, see @ref{Clocking
4401 * Closing items:: When was this entry marked DONE?
4402 * Tracking TODO state changes:: When did the status change?
4403 * Tracking your habits:: How consistent have you been?
4407 @subsection Closing items
4409 The most basic logging is to keep track of @emph{when} a certain TODO
4410 item was finished. This is achieved with@footnote{The corresponding
4411 in-buffer setting is: @code{#+STARTUP: logdone}}
4414 (setq org-log-done 'time)
4417 @vindex org-closed-keep-when-no-todo
4419 Then each time you turn an entry from a TODO (not-done) state into any of the
4420 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4421 the headline. If you turn the entry back into a TODO item through further
4422 state cycling, that line will be removed again. If you turn the entry back
4423 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4424 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4425 non-@code{nil}. If you want to record a note along with the timestamp,
4426 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4430 (setq org-log-done 'note)
4434 You will then be prompted for a note, and that note will be stored below
4435 the entry with a @samp{Closing Note} heading.
4437 In the timeline (@pxref{Timeline}) and in the agenda
4438 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4439 display the TODO items with a @samp{CLOSED} timestamp on each day,
4440 giving you an overview of what has been done.
4442 @node Tracking TODO state changes
4443 @subsection Tracking TODO state changes
4444 @cindex drawer, for state change recording
4446 @vindex org-log-states-order-reversed
4447 @vindex org-log-into-drawer
4448 @cindex property, LOG_INTO_DRAWER
4449 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4450 might want to keep track of when a state change occurred and maybe take a
4451 note about this change. You can either record just a timestamp, or a
4452 time-stamped note for a change. These records will be inserted after the
4453 headline as an itemized list, newest first@footnote{See the option
4454 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4455 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4456 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4457 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4458 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4459 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4460 overrule the setting of this variable for a subtree by setting a
4461 @code{LOG_INTO_DRAWER} property.
4463 Since it is normally too much to record a note for every state, Org mode
4464 expects configuration on a per-keyword basis for this. This is achieved by
4465 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4466 with timestamp) in parentheses after each keyword. For example, with the
4470 (setq org-todo-keywords
4471 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4474 To record a timestamp without a note for TODO keywords configured with
4475 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4478 @vindex org-log-done
4479 You not only define global TODO keywords and fast access keys, but also
4480 request that a time is recorded when the entry is set to
4481 DONE@footnote{It is possible that Org mode will record two timestamps
4482 when you are using both @code{org-log-done} and state change logging.
4483 However, it will never prompt for two notes---if you have configured
4484 both, the state change recording note will take precedence and cancel
4485 the @samp{Closing Note}.}, and that a note is recorded when switching to
4486 WAIT or CANCELED@. The setting for WAIT is even more special: the
4487 @samp{!} after the slash means that in addition to the note taken when
4488 entering the state, a timestamp should be recorded when @i{leaving} the
4489 WAIT state, if and only if the @i{target} state does not configure
4490 logging for entering it. So it has no effect when switching from WAIT
4491 to DONE, because DONE is configured to record a timestamp only. But
4492 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4493 setting now triggers a timestamp even though TODO has no logging
4496 You can use the exact same syntax for setting logging preferences local
4499 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4502 @cindex property, LOGGING
4503 In order to define logging settings that are local to a subtree or a
4504 single item, define a LOGGING property in this entry. Any non-empty
4505 LOGGING property resets all logging settings to @code{nil}. You may then turn
4506 on logging for this specific tree using STARTUP keywords like
4507 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4508 settings like @code{TODO(!)}. For example
4511 * TODO Log each state with only a time
4513 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4515 * TODO Only log when switching to WAIT, and when repeating
4517 :LOGGING: WAIT(@@) logrepeat
4519 * TODO No logging at all
4525 @node Tracking your habits
4526 @subsection Tracking your habits
4529 Org has the ability to track the consistency of a special category of TODOs,
4530 called ``habits''. A habit has the following properties:
4534 You have enabled the @code{habits} module by customizing @code{org-modules}.
4536 The habit is a TODO item, with a TODO keyword representing an open state.
4538 The property @code{STYLE} is set to the value @code{habit}.
4540 The TODO has a scheduled date, usually with a @code{.+} style repeat
4541 interval. A @code{++} style may be appropriate for habits with time
4542 constraints, e.g., must be done on weekends, or a @code{+} style for an
4543 unusual habit that can have a backlog, e.g., weekly reports.
4545 The TODO may also have minimum and maximum ranges specified by using the
4546 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4547 three days, but at most every two days.
4549 You must also have state logging for the @code{DONE} state enabled
4550 (@pxref{Tracking TODO state changes}), in order for historical data to be
4551 represented in the consistency graph. If it is not enabled it is not an
4552 error, but the consistency graphs will be largely meaningless.
4555 To give you an idea of what the above rules look like in action, here's an
4556 actual habit with some history:
4560 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4563 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4565 - State "DONE" from "TODO" [2009-10-15 Thu]
4566 - State "DONE" from "TODO" [2009-10-12 Mon]
4567 - State "DONE" from "TODO" [2009-10-10 Sat]
4568 - State "DONE" from "TODO" [2009-10-04 Sun]
4569 - State "DONE" from "TODO" [2009-10-02 Fri]
4570 - State "DONE" from "TODO" [2009-09-29 Tue]
4571 - State "DONE" from "TODO" [2009-09-25 Fri]
4572 - State "DONE" from "TODO" [2009-09-19 Sat]
4573 - State "DONE" from "TODO" [2009-09-16 Wed]
4574 - State "DONE" from "TODO" [2009-09-12 Sat]
4577 What this habit says is: I want to shave at most every 2 days (given by the
4578 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4579 today is the 15th, then the habit first appears in the agenda on Oct 17,
4580 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4581 after four days have elapsed.
4583 What's really useful about habits is that they are displayed along with a
4584 consistency graph, to show how consistent you've been at getting that task
4585 done in the past. This graph shows every day that the task was done over the
4586 past three weeks, with colors for each day. The colors used are:
4590 If the task wasn't to be done yet on that day.
4592 If the task could have been done on that day.
4594 If the task was going to be overdue the next day.
4596 If the task was overdue on that day.
4599 In addition to coloring each day, the day is also marked with an asterisk if
4600 the task was actually done that day, and an exclamation mark to show where
4601 the current day falls in the graph.
4603 There are several configuration variables that can be used to change the way
4604 habits are displayed in the agenda.
4607 @item org-habit-graph-column
4608 The buffer column at which the consistency graph should be drawn. This will
4609 overwrite any text in that column, so it is a good idea to keep your habits'
4610 titles brief and to the point.
4611 @item org-habit-preceding-days
4612 The amount of history, in days before today, to appear in consistency graphs.
4613 @item org-habit-following-days
4614 The number of days after today that will appear in consistency graphs.
4615 @item org-habit-show-habits-only-for-today
4616 If non-@code{nil}, only show habits in today's agenda view. This is set to true by
4620 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4621 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4622 bring them back. They are also subject to tag filtering, if you have habits
4623 which should only be done in certain contexts, for example.
4629 If you use Org mode extensively, you may end up with enough TODO items that
4630 it starts to make sense to prioritize them. Prioritizing can be done by
4631 placing a @emph{priority cookie} into the headline of a TODO item, like this
4634 *** TODO [#A] Write letter to Sam Fortune
4638 @vindex org-priority-faces
4639 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4640 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4641 treated just like priority @samp{B}. Priorities make a difference only for
4642 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4643 have no inherent meaning to Org mode. The cookies can be highlighted with
4644 special faces by customizing @code{org-priority-faces}.
4646 Priorities can be attached to any outline node; they do not need to be TODO
4652 @findex org-priority
4653 Set the priority of the current headline (@command{org-priority}). The
4654 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4655 When you press @key{SPC} instead, the priority cookie is removed from the
4656 headline. The priorities can also be changed ``remotely'' from the timeline
4657 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4659 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4660 @vindex org-priority-start-cycle-with-default
4661 Increase/decrease priority of current headline@footnote{See also the option
4662 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4663 also used to modify timestamps (@pxref{Creating timestamps}). See also
4664 @ref{Conflicts}, for a discussion of the interaction with
4665 @code{shift-selection-mode}.
4668 @vindex org-highest-priority
4669 @vindex org-lowest-priority
4670 @vindex org-default-priority
4671 You can change the range of allowed priorities by setting the options
4672 @code{org-highest-priority}, @code{org-lowest-priority}, and
4673 @code{org-default-priority}. For an individual buffer, you may set
4674 these values (highest, lowest, default) like this (please make sure that
4675 the highest priority is earlier in the alphabet than the lowest
4678 @cindex #+PRIORITIES
4683 @node Breaking down tasks
4684 @section Breaking tasks down into subtasks
4685 @cindex tasks, breaking down
4686 @cindex statistics, for TODO items
4688 @vindex org-agenda-todo-list-sublevels
4689 It is often advisable to break down large tasks into smaller, manageable
4690 subtasks. You can do this by creating an outline tree below a TODO item,
4691 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4692 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4693 the overview over the fraction of subtasks that are already completed, insert
4694 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4695 be updated each time the TODO status of a child changes, or when pressing
4696 @kbd{C-c C-c} on the cookie. For example:
4699 * Organize Party [33%]
4700 ** TODO Call people [1/2]
4704 ** DONE Talk to neighbor
4707 @cindex property, COOKIE_DATA
4708 If a heading has both checkboxes and TODO children below it, the meaning of
4709 the statistics cookie become ambiguous. Set the property
4710 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4713 @vindex org-hierarchical-todo-statistics
4714 If you would like to have the statistics cookie count any TODO entries in the
4715 subtree (not just direct children), configure
4716 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4717 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4721 * Parent capturing statistics [2/20]
4723 :COOKIE_DATA: todo recursive
4727 If you would like a TODO entry to automatically change to DONE
4728 when all children are done, you can use the following setup:
4731 (defun org-summary-todo (n-done n-not-done)
4732 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4733 (let (org-log-done org-log-states) ; turn off logging
4734 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4736 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4740 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4741 large number of subtasks (@pxref{Checkboxes}).
4748 @vindex org-list-automatic-rules
4749 Every item in a plain list@footnote{With the exception of description
4750 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4751 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4752 it with the string @samp{[ ]}. This feature is similar to TODO items
4753 (@pxref{TODO items}), but is more lightweight. Checkboxes are not included
4754 in the global TODO list, so they are often great to split a task into a
4755 number of simple steps. Or you can use them in a shopping list. To toggle a
4756 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4757 @file{org-mouse.el}).
4759 Here is an example of a checkbox list.
4762 * TODO Organize party [2/4]
4763 - [-] call people [1/3]
4768 - [ ] think about what music to play
4769 - [X] talk to the neighbors
4772 Checkboxes work hierarchically, so if a checkbox item has children that
4773 are checkboxes, toggling one of the children checkboxes will make the
4774 parent checkbox reflect if none, some, or all of the children are
4777 @cindex statistics, for checkboxes
4778 @cindex checkbox statistics
4779 @cindex property, COOKIE_DATA
4780 @vindex org-checkbox-hierarchical-statistics
4781 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4782 indicating how many checkboxes present in this entry have been checked off,
4783 and the total number of checkboxes present. This can give you an idea on how
4784 many checkboxes remain, even without opening a folded entry. The cookies can
4785 be placed into a headline or into (the first line of) a plain list item.
4786 Each cookie covers checkboxes of direct children structurally below the
4787 headline/item on which the cookie appears@footnote{Set the option
4788 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4789 count all checkboxes below the cookie, not just those belonging to direct
4790 children.}. You have to insert the cookie yourself by typing either
4791 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4792 result, as in the examples above. With @samp{[%]} you get information about
4793 the percentage of checkboxes checked (in the above example, this would be
4794 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4795 count either checkboxes below the heading or TODO states of children, and it
4796 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4797 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4799 @cindex blocking, of checkboxes
4800 @cindex checkbox blocking
4801 @cindex property, ORDERED
4802 If the current outline node has an @code{ORDERED} property, checkboxes must
4803 be checked off in sequence, and an error will be thrown if you try to check
4804 off a box while there are unchecked boxes above it.
4806 @noindent The following commands work with checkboxes:
4809 @orgcmd{C-c C-c,org-toggle-checkbox}
4810 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4811 With a single prefix argument, add an empty checkbox or remove the current
4812 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4813 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4814 considered to be an intermediate state.
4815 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4816 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4817 double prefix argument, set it to @samp{[-]}, which is considered to be an
4821 If there is an active region, toggle the first checkbox in the region
4822 and set all remaining boxes to the same status as the first. With a prefix
4823 arg, add or remove the checkbox for all items in the region.
4825 If the cursor is in a headline, toggle checkboxes in the region between
4826 this headline and the next (so @emph{not} the entire subtree).
4828 If there is no active region, just toggle the checkbox at point.
4830 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4831 Insert a new item with a checkbox. This works only if the cursor is already
4832 in a plain list item (@pxref{Plain lists}).
4833 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4834 @vindex org-track-ordered-property-with-tag
4835 @cindex property, ORDERED
4836 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4837 be checked off in sequence. A property is used for this behavior because
4838 this should be local to the current entry, not inherited like a tag.
4839 However, if you would like to @i{track} the value of this property with a tag
4840 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4841 @orgcmd{C-c #,org-update-statistics-cookies}
4842 Update the statistics cookie in the current outline entry. When called with
4843 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4844 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4845 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4846 changing TODO states. If you delete boxes/entries or add/change them by
4847 hand, use this command to get things back into sync.
4853 @cindex headline tagging
4854 @cindex matching, tags
4855 @cindex sparse tree, tag based
4857 An excellent way to implement labels and contexts for cross-correlating
4858 information is to assign @i{tags} to headlines. Org mode has extensive
4861 @vindex org-tag-faces
4862 Every headline can contain a list of tags; they occur at the end of the
4863 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4864 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4865 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4866 Tags will by default be in bold face with the same color as the headline.
4867 You may specify special faces for specific tags using the option
4868 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4869 (@pxref{Faces for TODO keywords}).
4872 * Tag inheritance:: Tags use the tree structure of the outline
4873 * Setting tags:: How to assign tags to a headline
4874 * Tag groups:: Use one tag to search for several tags
4875 * Tag searches:: Searching for combinations of tags
4878 @node Tag inheritance
4879 @section Tag inheritance
4880 @cindex tag inheritance
4881 @cindex inheritance, of tags
4882 @cindex sublevels, inclusion into tags match
4884 @i{Tags} make use of the hierarchical structure of outline trees. If a
4885 heading has a certain tag, all subheadings will inherit the tag as
4886 well. For example, in the list
4889 * Meeting with the French group :work:
4890 ** Summary by Frank :boss:notes:
4891 *** TODO Prepare slides for him :action:
4895 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4896 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4897 explicitly marked with those tags. You can also set tags that all entries in
4898 a file should inherit just as if these tags were defined in a hypothetical
4899 level zero that surrounds the entire file. Use a line like this@footnote{As
4900 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4901 changes in the line.}:
4905 #+FILETAGS: :Peter:Boss:Secret:
4909 @vindex org-use-tag-inheritance
4910 @vindex org-tags-exclude-from-inheritance
4911 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4912 To turn it off entirely, use @code{org-use-tag-inheritance}.
4914 @vindex org-tags-match-list-sublevels
4915 When a headline matches during a tags search while tag inheritance is turned
4916 on, all the sublevels in the same tree will (for a simple match form) match
4917 as well@footnote{This is only true if the search does not involve more
4918 complex tests including properties (@pxref{Property searches}).}. The list
4919 of matches may then become very long. If you only want to see the first tags
4920 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4923 @vindex org-agenda-use-tag-inheritance
4924 Tag inheritance is relevant when the agenda search tries to match a tag,
4925 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4926 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4927 have your tags correctly set in the agenda, so that tag filtering works fine,
4928 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4929 this: the default value includes all agenda types, but setting this to @code{nil}
4930 can really speed up agenda generation.
4933 @section Setting tags
4934 @cindex setting tags
4935 @cindex tags, setting
4938 Tags can simply be typed into the buffer at the end of a headline.
4939 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4940 also a special command for inserting tags:
4943 @orgcmd{C-c C-q,org-set-tags-command}
4944 @cindex completion, of tags
4945 @vindex org-tags-column
4946 Enter new tags for the current headline. Org mode will either offer
4947 completion or a special single-key interface for setting tags, see
4948 below. After pressing @key{RET}, the tags will be inserted and aligned
4949 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4950 tags in the current buffer will be aligned to that column, just to make
4951 things look nice. TAGS are automatically realigned after promotion,
4952 demotion, and TODO state changes (@pxref{TODO basics}).
4954 @orgcmd{C-c C-c,org-set-tags-command}
4955 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4958 @vindex org-tag-alist
4959 Org supports tag insertion based on a @emph{list of tags}. By
4960 default this list is constructed dynamically, containing all tags
4961 currently used in the buffer. You may also globally specify a hard list
4962 of tags with the variable @code{org-tag-alist}. Finally you can set
4963 the default tags for a given file with lines like
4967 #+TAGS: @@work @@home @@tennisclub
4968 #+TAGS: laptop car pc sailboat
4971 If you have globally defined your preferred set of tags using the
4972 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4973 in a specific file, add an empty TAGS option line to that file:
4979 @vindex org-tag-persistent-alist
4980 If you have a preferred set of tags that you would like to use in every file,
4981 in addition to those defined on a per-file basis by TAGS option lines, then
4982 you may specify a list of tags with the variable
4983 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4984 by adding a STARTUP option line to that file:
4990 By default Org mode uses the standard minibuffer completion facilities for
4991 entering tags. However, it also implements another, quicker, tag selection
4992 method called @emph{fast tag selection}. This allows you to select and
4993 deselect tags with just a single key press. For this to work well you should
4994 assign unique letters to most of your commonly used tags. You can do this
4995 globally by configuring the variable @code{org-tag-alist} in your
4996 @file{.emacs} file. For example, you may find the need to tag many items in
4997 different files with @samp{:@@home:}. In this case you can set something
5001 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
5004 @noindent If the tag is only relevant to the file you are working on, then you
5005 can instead set the TAGS option line as:
5008 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
5011 @noindent The tags interface will show the available tags in a splash
5012 window. If you want to start a new line after a specific tag, insert
5013 @samp{\n} into the tag list
5016 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
5019 @noindent or write them in two lines:
5022 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
5023 #+TAGS: laptop(l) pc(p)
5027 You can also group together tags that are mutually exclusive by using
5031 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
5034 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
5035 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
5037 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
5038 these lines to activate any changes.
5041 To set these mutually exclusive groups in the variable @code{org-tag-alist},
5042 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
5043 of the braces. Similarly, you can use @code{:newline} to indicate a line
5044 break. The previous example would be set globally by the following
5048 (setq org-tag-alist '((:startgroup . nil)
5049 ("@@work" . ?w) ("@@home" . ?h)
5050 ("@@tennisclub" . ?t)
5052 ("laptop" . ?l) ("pc" . ?p)))
5055 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
5056 automatically present you with a special interface, listing inherited tags,
5057 the tags of the current headline, and a list of all valid tags with
5058 corresponding keys@footnote{Keys will automatically be assigned to tags which
5059 have no configured keys.}. In this interface, you can use the following
5064 Pressing keys assigned to tags will add or remove them from the list of
5065 tags in the current line. Selecting a tag in a group of mutually
5066 exclusive tags will turn off any other tags from that group.
5069 Enter a tag in the minibuffer, even if the tag is not in the predefined
5070 list. You will be able to complete on all tags present in the buffer.
5071 You can also add several tags: just separate them with a comma.
5075 Clear all tags for this line.
5078 Accept the modified set.
5080 Abort without installing changes.
5082 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5084 Turn off groups of mutually exclusive tags. Use this to (as an
5085 exception) assign several tags from such a group.
5087 Toggle auto-exit after the next change (see below).
5088 If you are using expert mode, the first @kbd{C-c} will display the
5093 This method lets you assign tags to a headline with very few keys. With
5094 the above setup, you could clear the current tags and set @samp{@@home},
5095 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5096 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
5097 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5098 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
5099 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5100 @key{RET} @key{RET}}.
5102 @vindex org-fast-tag-selection-single-key
5103 If you find that most of the time you need only a single key press to
5104 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5105 Then you no longer have to press @key{RET} to exit fast tag selection---it
5106 will immediately exit after the first change. If you then occasionally
5107 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5108 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5109 instead of @kbd{C-c C-c}). If you set the variable to the value
5110 @code{expert}, the special window is not even shown for single-key tag
5111 selection, it comes up only when you press an extra @kbd{C-c}.
5117 @cindex tags, groups
5118 In a set of mutually exclusive tags, the first tag can be defined as a
5119 @emph{group tag}. When you search for a group tag, it will return matches
5120 for all members in the group. In an agenda view, filtering by a group tag
5121 will display headlines tagged with at least one of the members of the
5122 group. This makes tag searches and filters even more flexible.
5124 You can set group tags by inserting a colon between the group tag and other
5125 tags---beware that all whitespaces are mandatory so that Org can parse this
5129 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5132 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5133 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5135 You can also use the @code{:grouptags} keyword directly when setting
5136 @code{org-tag-alist}:
5139 (setq org-tag-alist '((:startgroup . nil)
5142 ("@@read_book" . nil)
5143 ("@@read_ebook" . nil)
5147 You cannot nest group tags or use a group tag as a tag in another group.
5150 @vindex org-group-tags
5151 If you want to ignore group tags temporarily, toggle group tags support
5152 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5153 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5156 @section Tag searches
5157 @cindex tag searches
5158 @cindex searching for tags
5160 Once a system of tags has been set up, it can be used to collect related
5161 information into special lists.
5164 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5165 Create a sparse tree with all headlines matching a tags/property/TODO search.
5166 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5167 @xref{Matching tags and properties}.
5168 @orgcmd{C-c a m,org-tags-view}
5169 Create a global list of tag matches from all agenda files. @xref{Matching
5170 tags and properties}.
5171 @orgcmd{C-c a M,org-tags-view}
5172 @vindex org-tags-match-list-sublevels
5173 Create a global list of tag matches from all agenda files, but check
5174 only TODO items and force checking subitems (see the option
5175 @code{org-tags-match-list-sublevels}).
5178 These commands all prompt for a match string which allows basic Boolean logic
5179 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5180 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5181 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5182 string is rich and allows also matching against TODO keywords, entry levels
5183 and properties. For a complete description with many examples, see
5184 @ref{Matching tags and properties}.
5187 @node Properties and columns
5188 @chapter Properties and columns
5191 A property is a key-value pair associated with an entry. Properties can be
5192 set so they are associated with a single entry, with every entry in a tree,
5193 or with every entry in an Org mode file.
5195 There are two main applications for properties in Org mode. First,
5196 properties are like tags, but with a value. Imagine maintaining a file where
5197 you document bugs and plan releases for a piece of software. Instead of
5198 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5199 property, say @code{:Release:}, that in different subtrees has different
5200 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5201 implement (very basic) database capabilities in an Org buffer. Imagine
5202 keeping track of your music CDs, where properties could be things such as the
5203 album, artist, date of release, number of tracks, and so on.
5205 Properties can be conveniently edited and viewed in column view
5206 (@pxref{Column view}).
5209 * Property syntax:: How properties are spelled out
5210 * Special properties:: Access to other Org mode features
5211 * Property searches:: Matching property values
5212 * Property inheritance:: Passing values down the tree
5213 * Column view:: Tabular viewing and editing
5214 * Property API:: Properties for Lisp programmers
5217 @node Property syntax
5218 @section Property syntax
5219 @cindex property syntax
5220 @cindex drawer, for properties
5222 Properties are key-value pairs. When they are associated with a single entry
5223 or with a tree they need to be inserted into a special drawer
5224 (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
5225 right below a headline, and its planning line (@pxref{Deadlines and
5226 scheduling}) when applicable. Each property is specified on a single line,
5227 with the key (surrounded by colons) first, and the value after it. Keys are
5228 case-insensitives. Here is an example:
5233 *** Goldberg Variations
5235 :Title: Goldberg Variations
5236 :Composer: J.S. Bach
5238 :Publisher: Deutsche Grammophon
5243 Depending on the value of @code{org-use-property-inheritance}, a property set
5244 this way will either be associated with a single entry, or the subtree
5245 defined by the entry, see @ref{Property inheritance}.
5247 You may define the allowed values for a particular property @samp{:Xyz:}
5248 by setting a property @samp{:Xyz_ALL:}. This special property is
5249 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5250 the entire tree. When allowed values are defined, setting the
5251 corresponding property becomes easier and is less prone to typing
5252 errors. For the example with the CD collection, we can predefine
5253 publishers and the number of disks in a box like this:
5258 :NDisks_ALL: 1 2 3 4
5259 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5263 If you want to set properties that can be inherited by any entry in a
5264 file, use a line like
5265 @cindex property, _ALL
5268 #+PROPERTY: NDisks_ALL 1 2 3 4
5271 Contrary to properties set from a special drawer, you have to refresh the
5272 buffer with @kbd{C-c C-c} to activate this change.
5274 If you want to add to the value of an existing property, append a @code{+} to
5275 the property name. The following results in the property @code{var} having
5276 the value ``foo=1 bar=2''.
5279 #+PROPERTY: var foo=1
5280 #+PROPERTY: var+ bar=2
5283 It is also possible to add to the values of inherited properties. The
5284 following results in the @code{genres} property having the value ``Classic
5285 Baroque'' under the @code{Goldberg Variations} subtree.
5293 *** Goldberg Variations
5295 :Title: Goldberg Variations
5296 :Composer: J.S. Bach
5298 :Publisher: Deutsche Grammophon
5303 Note that a property can only have one entry per Drawer.
5305 @vindex org-global-properties
5306 Property values set with the global variable
5307 @code{org-global-properties} can be inherited by all entries in all
5311 The following commands help to work with properties:
5314 @orgcmd{M-@key{TAB},pcomplete}
5315 After an initial colon in a line, complete property keys. All keys used
5316 in the current file will be offered as possible completions.
5317 @orgcmd{C-c C-x p,org-set-property}
5318 Set a property. This prompts for a property name and a value. If
5319 necessary, the property drawer is created as well.
5320 @item C-u M-x org-insert-drawer RET
5321 @cindex org-insert-drawer
5322 Insert a property drawer into the current entry. The drawer will be
5323 inserted early in the entry, but after the lines with planning
5324 information like deadlines.
5325 @orgcmd{C-c C-c,org-property-action}
5326 With the cursor in a property drawer, this executes property commands.
5327 @orgcmd{C-c C-c s,org-set-property}
5328 Set a property in the current entry. Both the property and the value
5329 can be inserted using completion.
5330 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5331 Switch property at point to the next/previous allowed value.
5332 @orgcmd{C-c C-c d,org-delete-property}
5333 Remove a property from the current entry.
5334 @orgcmd{C-c C-c D,org-delete-property-globally}
5335 Globally remove a property, from all entries in the current file.
5336 @orgcmd{C-c C-c c,org-compute-property-at-point}
5337 Compute the property at point, using the operator and scope from the
5338 nearest column format definition.
5341 @node Special properties
5342 @section Special properties
5343 @cindex properties, special
5345 Special properties provide an alternative access method to Org mode features,
5346 like the TODO state or the priority of an entry, discussed in the previous
5347 chapters. This interface exists so that you can include these states in
5348 a column view (@pxref{Column view}), or to use them in queries. The
5349 following property names are special and (except for @code{:CATEGORY:})
5350 should not be used as keys in the properties drawer:
5352 @cindex property, special, ALLTAGS
5353 @cindex property, special, BLOCKED
5354 @cindex property, special, NOBLOCKING
5355 @cindex property, special, CATEGORY
5356 @cindex property, special, CLOCKSUM
5357 @cindex property, special, CLOCKSUM_T
5358 @cindex property, special, CLOSED
5359 @cindex property, special, DEADLINE
5360 @cindex property, special, FILE
5361 @cindex property, special, ITEM
5362 @cindex property, special, PRIORITY
5363 @cindex property, special, SCHEDULED
5364 @cindex property, special, TAGS
5365 @cindex property, special, TIMESTAMP
5366 @cindex property, special, TIMESTAMP_IA
5367 @cindex property, special, TODO
5369 ALLTAGS @r{All tags, including inherited ones.}
5370 BLOCKED @r{"t" if task is currently blocked by children or siblings.}
5371 NOBLOCKING @r{"t" if blocking is disabled for this task.}
5372 CATEGORY @r{The category of an entry.}
5373 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5374 @r{must be run first to compute the values in the current buffer.}
5375 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5376 @r{@code{org-clock-sum-today} must be run first to compute the}
5377 @r{values in the current buffer.}
5378 CLOSED @r{When was this entry closed?}
5379 DEADLINE @r{The deadline time string, without the angular brackets.}
5380 FILE @r{The filename the entry is located in.}
5381 ITEM @r{The headline of the entry, with stars.}
5382 PRIORITY @r{The priority of the entry, a string with a single letter.}
5383 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5384 TAGS @r{The tags defined directly in the headline.}
5385 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5386 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5387 TODO @r{The TODO keyword of the entry.}
5390 @node Property searches
5391 @section Property searches
5392 @cindex properties, searching
5393 @cindex searching, of properties
5395 To create sparse trees and special lists with selection based on properties,
5396 the same commands are used as for tag searches (@pxref{Tag searches}).
5399 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5400 Create a sparse tree with all matching entries. With a
5401 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5402 @orgcmd{C-c a m,org-tags-view}
5403 Create a global list of tag/property matches from all agenda files.
5404 @xref{Matching tags and properties}.
5405 @orgcmd{C-c a M,org-tags-view}
5406 @vindex org-tags-match-list-sublevels
5407 Create a global list of tag matches from all agenda files, but check
5408 only TODO items and force checking of subitems (see the option
5409 @code{org-tags-match-list-sublevels}).
5412 The syntax for the search string is described in @ref{Matching tags and
5415 There is also a special command for creating sparse trees based on a
5420 Create a sparse tree based on the value of a property. This first
5421 prompts for the name of a property, and then for a value. A sparse tree
5422 is created with all entries that define this property with the given
5423 value. If you enclose the value in curly braces, it is interpreted as
5424 a regular expression and matched against the property values.
5427 @node Property inheritance
5428 @section Property Inheritance
5429 @cindex properties, inheritance
5430 @cindex inheritance, of properties
5432 @vindex org-use-property-inheritance
5433 The outline structure of Org mode documents lends itself to an
5434 inheritance model of properties: if the parent in a tree has a certain
5435 property, the children can inherit this property. Org mode does not
5436 turn this on by default, because it can slow down property searches
5437 significantly and is often not needed. However, if you find inheritance
5438 useful, you can turn it on by setting the variable
5439 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5440 all properties inherited from the parent, to a list of properties
5441 that should be inherited, or to a regular expression that matches
5442 inherited properties. If a property has the value @code{nil}, this is
5443 interpreted as an explicit undefine of the property, so that inheritance
5444 search will stop at this value and return @code{nil}.
5446 Org mode has a few properties for which inheritance is hard-coded, at
5447 least for the special applications for which they are used:
5449 @cindex property, COLUMNS
5452 The @code{:COLUMNS:} property defines the format of column view
5453 (@pxref{Column view}). It is inherited in the sense that the level
5454 where a @code{:COLUMNS:} property is defined is used as the starting
5455 point for a column view table, independently of the location in the
5456 subtree from where columns view is turned on.
5458 @cindex property, CATEGORY
5459 For agenda view, a category set through a @code{:CATEGORY:} property
5460 applies to the entire subtree.
5462 @cindex property, ARCHIVE
5463 For archiving, the @code{:ARCHIVE:} property may define the archive
5464 location for the entire subtree (@pxref{Moving subtrees}).
5466 @cindex property, LOGGING
5467 The LOGGING property may define logging settings for an entry or a
5468 subtree (@pxref{Tracking TODO state changes}).
5472 @section Column view
5474 A great way to view and edit properties in an outline tree is
5475 @emph{column view}. In column view, each outline node is turned into a
5476 table row. Columns in this table provide access to properties of the
5477 entries. Org mode implements columns by overlaying a tabular structure
5478 over the headline of each item. While the headlines have been turned
5479 into a table row, you can still change the visibility of the outline
5480 tree. For example, you get a compact table by switching to CONTENTS
5481 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5482 is active), but you can still open, read, and edit the entry below each
5483 headline. Or, you can switch to column view after executing a sparse
5484 tree command and in this way get a table only for the selected items.
5485 Column view also works in agenda buffers (@pxref{Agenda views}) where
5486 queries have collected selected items, possibly from a number of files.
5489 * Defining columns:: The COLUMNS format property
5490 * Using column view:: How to create and use column view
5491 * Capturing column view:: A dynamic block for column view
5494 @node Defining columns
5495 @subsection Defining columns
5496 @cindex column view, for properties
5497 @cindex properties, column view
5499 Setting up a column view first requires defining the columns. This is
5500 done by defining a column format line.
5503 * Scope of column definitions:: Where defined, where valid?
5504 * Column attributes:: Appearance and content of a column
5507 @node Scope of column definitions
5508 @subsubsection Scope of column definitions
5510 To define a column format for an entire file, use a line like
5514 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5517 To specify a format that only applies to a specific tree, add a
5518 @code{:COLUMNS:} property to the top node of that tree, for example:
5521 ** Top node for columns view
5523 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5527 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5528 for the entry itself, and for the entire subtree below it. Since the
5529 column definition is part of the hierarchical structure of the document,
5530 you can define columns on level 1 that are general enough for all
5531 sublevels, and more specific columns further down, when you edit a
5532 deeper part of the tree.
5534 @node Column attributes
5535 @subsubsection Column attributes
5536 A column definition sets the attributes of a column. The general
5537 definition looks like this:
5540 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5544 Except for the percent sign and the property name, all items are
5545 optional. The individual parts have the following meaning:
5548 @var{width} @r{An integer specifying the width of the column in characters.}
5549 @r{If omitted, the width will be determined automatically.}
5550 @var{property} @r{The property that should be edited in this column.}
5551 @r{Special properties representing meta data are allowed here}
5552 @r{as well (@pxref{Special properties})}
5553 @var{title} @r{The header text for the column. If omitted, the property}
5555 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5556 @r{parent nodes are computed from the children.}
5557 @r{Supported summary types are:}
5558 @{+@} @r{Sum numbers in this column.}
5559 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5560 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5561 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5562 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5563 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5564 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5565 @{min@} @r{Smallest number in column.}
5566 @{max@} @r{Largest number.}
5567 @{mean@} @r{Arithmetic mean of numbers.}
5568 @{:min@} @r{Smallest time value in column.}
5569 @{:max@} @r{Largest time value.}
5570 @{:mean@} @r{Arithmetic mean of time values.}
5571 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5572 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5573 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5574 @{est+@} @r{Add low-high estimates.}
5578 Be aware that you can only have one summary type for any property you
5579 include. Subsequent columns referencing the same property will all display the
5580 same summary information.
5582 The @code{est+} summary type requires further explanation. It is used for
5583 combining estimates, expressed as low-high ranges. For example, instead
5584 of estimating a particular task will take 5 days, you might estimate it as
5585 5--6 days if you're fairly confident you know how much work is required, or
5586 1--10 days if you don't really know what needs to be done. Both ranges
5587 average at 5.5 days, but the first represents a more predictable delivery.
5589 When combining a set of such estimates, simply adding the lows and highs
5590 produces an unrealistically wide result. Instead, @code{est+} adds the
5591 statistical mean and variance of the sub-tasks, generating a final estimate
5592 from the sum. For example, suppose you had ten tasks, each of which was
5593 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5594 of 5 to 20 days, representing what to expect if everything goes either
5595 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5596 full job more realistically, at 10--15 days.
5598 Numbers are right-aligned when a format specifier with an explicit width like
5599 @code{%5d} or @code{%5.1f} is used.
5601 Here is an example for a complete columns definition, along with allowed
5605 :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.}
5606 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5607 :Owner_ALL: Tammy Mark Karl Lisa Don
5608 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5609 :Approved_ALL: "[ ]" "[X]"
5613 The first column, @samp{%25ITEM}, means the first 25 characters of the
5614 item itself, i.e., of the headline. You probably always should start the
5615 column definition with the @samp{ITEM} specifier. The other specifiers
5616 create columns @samp{Owner} with a list of names as allowed values, for
5617 @samp{Status} with four different possible values, and for a checkbox
5618 field @samp{Approved}. When no width is given after the @samp{%}
5619 character, the column will be exactly as wide as it needs to be in order
5620 to fully display all values. The @samp{Approved} column does have a
5621 modified title (@samp{Approved?}, with a question mark). Summaries will
5622 be created for the @samp{Time_Estimate} column by adding time duration
5623 expressions like HH:MM, and for the @samp{Approved} column, by providing
5624 an @samp{[X]} status if all children have been checked. The
5625 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5626 sums of CLOCK intervals in the subtree, either for all clocks or just for
5629 @node Using column view
5630 @subsection Using column view
5633 @tsubheading{Turning column view on and off}
5634 @orgcmd{C-c C-x C-c,org-columns}
5635 @vindex org-columns-default-format
5636 Turn on column view. If the cursor is before the first headline in the file,
5637 column view is turned on for the entire file, using the @code{#+COLUMNS}
5638 definition. If the cursor is somewhere inside the outline, this command
5639 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5640 defines a format. When one is found, the column view table is established
5641 for the tree starting at the entry that contains the @code{:COLUMNS:}
5642 property. If no such property is found, the format is taken from the
5643 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5644 and column view is established for the current entry and its subtree.
5645 @orgcmd{r,org-columns-redo}
5646 Recreate the column view, to include recent changes made in the buffer.
5647 @orgcmd{g,org-columns-redo}
5649 @orgcmd{q,org-columns-quit}
5651 @tsubheading{Editing values}
5652 @item @key{left} @key{right} @key{up} @key{down}
5653 Move through the column view from field to field.
5654 @kindex S-@key{left}
5655 @kindex S-@key{right}
5656 @item S-@key{left}/@key{right}
5657 Switch to the next/previous allowed value of the field. For this, you
5658 have to have specified allowed values for a property.
5660 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5661 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5662 Same as @kbd{S-@key{left}/@key{right}}
5663 @orgcmd{e,org-columns-edit-value}
5664 Edit the property at point. For the special properties, this will
5665 invoke the same interface that you normally use to change that
5666 property. For example, when editing a TAGS property, the tag completion
5667 or fast selection interface will pop up.
5668 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5669 When there is a checkbox at point, toggle it.
5670 @orgcmd{v,org-columns-show-value}
5671 View the full value of this property. This is useful if the width of
5672 the column is smaller than that of the value.
5673 @orgcmd{a,org-columns-edit-allowed}
5674 Edit the list of allowed values for this property. If the list is found
5675 in the hierarchy, the modified value is stored there. If no list is
5676 found, the new value is stored in the first entry that is part of the
5677 current column view.
5678 @tsubheading{Modifying the table structure}
5679 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5680 Make the column narrower/wider by one character.
5681 @orgcmd{S-M-@key{right},org-columns-new}
5682 Insert a new column, to the left of the current column.
5683 @orgcmd{S-M-@key{left},org-columns-delete}
5684 Delete the current column.
5687 @node Capturing column view
5688 @subsection Capturing column view
5690 Since column view is just an overlay over a buffer, it cannot be
5691 exported or printed directly. If you want to capture a column view, use
5692 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5693 of this block looks like this:
5695 @cindex #+BEGIN, columnview
5698 #+BEGIN: columnview :hlines 1 :id "label"
5703 @noindent This dynamic block has the following parameters:
5707 This is the most important parameter. Column view is a feature that is
5708 often localized to a certain (sub)tree, and the capture block might be
5709 at a different location in the file. To identify the tree whose view to
5710 capture, you can use 4 values:
5711 @cindex property, ID
5713 local @r{use the tree in which the capture block is located}
5714 global @r{make a global view, including all headings in the file}
5715 "file:@var{path-to-file}"
5716 @r{run column view at the top of this file}
5717 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5718 @r{property with the value @i{label}. You can use}
5719 @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5720 @r{the current entry and copy it to the kill-ring.}
5723 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5724 an hline before each headline with level @code{<= @var{N}}.
5726 When set to @code{t}, force column groups to get vertical lines.
5728 When set to a number, don't capture entries below this level.
5729 @item :skip-empty-rows
5730 When set to @code{t}, skip rows where the only non-empty specifier of the
5731 column view is @code{ITEM}.
5736 The following commands insert or update the dynamic block:
5739 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5740 Insert a dynamic block capturing a column view. You will be prompted
5741 for the scope or ID of the view.
5742 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5743 Update dynamic block at point. The cursor needs to be in the
5744 @code{#+BEGIN} line of the dynamic block.
5745 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5746 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5747 you have several clock table blocks, column-capturing blocks or other dynamic
5751 You can add formulas to the column view table and you may add plotting
5752 instructions in front of the table---these will survive an update of the
5753 block. If there is a @code{#+TBLFM:} after the table, the table will
5754 actually be recalculated automatically after an update.
5756 An alternative way to capture and process property values into a table is
5757 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5758 package@footnote{Contributed packages are not part of Emacs, but are
5759 distributed with the main distribution of Org (visit
5760 @uref{http://orgmode.org}).}. It provides a general API to collect
5761 properties from entries in a certain scope, and arbitrary Lisp expressions to
5762 process these values before inserting them into a table or a dynamic block.
5765 @section The Property API
5766 @cindex properties, API
5767 @cindex API, for properties
5769 There is a full API for accessing and changing properties. This API can
5770 be used by Emacs Lisp programs to work with properties and to implement
5771 features based on them. For more information see @ref{Using the
5774 @node Dates and times
5775 @chapter Dates and times
5781 To assist project planning, TODO items can be labeled with a date and/or
5782 a time. The specially formatted string carrying the date and time
5783 information is called a @emph{timestamp} in Org mode. This may be a
5784 little confusing because timestamp is often used to indicate when
5785 something was created or last changed. However, in Org mode this term
5786 is used in a much wider sense.
5789 * Timestamps:: Assigning a time to a tree entry
5790 * Creating timestamps:: Commands which insert timestamps
5791 * Deadlines and scheduling:: Planning your work
5792 * Clocking work time:: Tracking how long you spend on a task
5793 * Effort estimates:: Planning work effort in advance
5794 * Relative timer:: Notes with a running timer
5795 * Countdown timer:: Starting a countdown timer for a task
5800 @section Timestamps, deadlines, and scheduling
5802 @cindex ranges, time
5807 A timestamp is a specification of a date (possibly with a time or a range of
5808 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5809 simplest form, the day name is optional when you type the date yourself.
5810 However, any dates inserted or modified by Org will add that day name, for
5811 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5812 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5813 date/time format. To use an alternative format, see @ref{Custom time
5814 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5815 tree entry. Its presence causes entries to be shown on specific dates in the
5816 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5819 @item Plain timestamp; Event; Appointment
5822 A simple timestamp just assigns a date/time to an item. This is just
5823 like writing down an appointment or event in a paper agenda. In the
5824 timeline and agenda displays, the headline of an entry associated with a
5825 plain timestamp will be shown exactly on that date.
5828 * Meet Peter at the movies
5829 <2006-11-01 Wed 19:15>
5830 * Discussion on climate change
5831 <2006-11-02 Thu 20:00-22:00>
5834 @item Timestamp with repeater interval
5835 @cindex timestamp, with repeater interval
5836 A timestamp may contain a @emph{repeater interval}, indicating that it
5837 applies not only on the given date, but again and again after a certain
5838 interval of N days (d), weeks (w), months (m), or years (y). The
5839 following will show up in the agenda every Wednesday:
5842 * Pick up Sam at school
5843 <2007-05-16 Wed 12:30 +1w>
5846 @item Diary-style sexp entries
5847 For more complex date specifications, Org mode supports using the special
5848 sexp diary entries implemented in the Emacs calendar/diary
5849 package@footnote{When working with the standard diary sexp functions, you
5850 need to be very careful with the order of the arguments. That order depends
5851 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5852 versions, @code{european-calendar-style}). For example, to specify a date
5853 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5854 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5855 the settings. This has been the source of much confusion. Org mode users
5856 can resort to special versions of these functions like @code{org-date} or
5857 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5858 functions, but with stable ISO order of arguments (year, month, day) wherever
5859 applicable, independent of the value of @code{calendar-date-style}.}. For
5860 example with optional time
5863 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5864 <%%(diary-float t 4 2)>
5867 @item Time/Date range
5870 Two timestamps connected by @samp{--} denote a range. The headline
5871 will be shown on the first and last day of the range, and on any dates
5872 that are displayed and fall in the range. Here is an example:
5875 ** Meeting in Amsterdam
5876 <2004-08-23 Mon>--<2004-08-26 Thu>
5879 @item Inactive timestamp
5880 @cindex timestamp, inactive
5881 @cindex inactive timestamp
5882 Just like a plain timestamp, but with square brackets instead of
5883 angular ones. These timestamps are inactive in the sense that they do
5884 @emph{not} trigger an entry to show up in the agenda.
5887 * Gillian comes late for the fifth time
5893 @node Creating timestamps
5894 @section Creating timestamps
5895 @cindex creating timestamps
5896 @cindex timestamps, creating
5898 For Org mode to recognize timestamps, they need to be in the specific
5899 format. All commands listed below produce timestamps in the correct
5903 @orgcmd{C-c .,org-time-stamp}
5904 Prompt for a date and insert a corresponding timestamp. When the cursor is
5905 at an existing timestamp in the buffer, the command is used to modify this
5906 timestamp instead of inserting a new one. When this command is used twice in
5907 succession, a time range is inserted.
5909 @orgcmd{C-c !,org-time-stamp-inactive}
5910 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5917 @vindex org-time-stamp-rounding-minutes
5918 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5919 contains date and time. The default time can be rounded to multiples of 5
5920 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5923 Normalize timestamp, insert/fix day name if missing or wrong.
5925 @orgcmd{C-c <,org-date-from-calendar}
5926 Insert a timestamp corresponding to the cursor date in the Calendar.
5928 @orgcmd{C-c >,org-goto-calendar}
5929 Access the Emacs calendar for the current date. If there is a
5930 timestamp in the current line, go to the corresponding date
5933 @orgcmd{C-c C-o,org-open-at-point}
5934 Access the agenda for the date given by the timestamp or -range at
5935 point (@pxref{Weekly/daily agenda}).
5937 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5938 Change date at cursor by one day. These key bindings conflict with
5939 shift-selection and related modes (@pxref{Conflicts}).
5941 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5942 Change the item under the cursor in a timestamp. The cursor can be on a
5943 year, month, day, hour or minute. When the timestamp contains a time range
5944 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5945 shifting the time block with constant length. To change the length, modify
5946 the second time. Note that if the cursor is in a headline and not at a
5947 timestamp, these same keys modify the priority of an item.
5948 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5949 related modes (@pxref{Conflicts}).
5951 @orgcmd{C-c C-y,org-evaluate-time-range}
5952 @cindex evaluate time range
5953 Evaluate a time range by computing the difference between start and end.
5954 With a prefix argument, insert result after the time range (in a table: into
5955 the following column).
5960 * The date/time prompt:: How Org mode helps you entering date and time
5961 * Custom time format:: Making dates look different
5964 @node The date/time prompt
5965 @subsection The date/time prompt
5966 @cindex date, reading in minibuffer
5967 @cindex time, reading in minibuffer
5969 @vindex org-read-date-prefer-future
5970 When Org mode prompts for a date/time, the default is shown in default
5971 date/time format, and the prompt therefore seems to ask for a specific
5972 format. But it will in fact accept date/time information in a variety of
5973 formats. Generally, the information should start at the beginning of the
5974 string. Org mode will find whatever information is in
5975 there and derive anything you have not specified from the @emph{default date
5976 and time}. The default is usually the current date and time, but when
5977 modifying an existing timestamp, or when entering the second stamp of a
5978 range, it is taken from the stamp in the buffer. When filling in
5979 information, Org mode assumes that most of the time you will want to enter a
5980 date in the future: if you omit the month/year and the given day/month is
5981 @i{before} today, it will assume that you mean a future date@footnote{See the
5982 variable @code{org-read-date-prefer-future}. You may set that variable to
5983 the symbol @code{time} to even make a time before now shift the date to
5984 tomorrow.}. If the date has been automatically shifted into the future, the
5985 time prompt will show this with @samp{(=>F).}
5987 For example, let's assume that today is @b{June 13, 2006}. Here is how
5988 various inputs will be interpreted, the items filled in by Org mode are
5992 3-2-5 @result{} 2003-02-05
5993 2/5/3 @result{} 2003-02-05
5994 14 @result{} @b{2006}-@b{06}-14
5995 12 @result{} @b{2006}-@b{07}-12
5996 2/5 @result{} @b{2007}-02-05
5997 Fri @result{} nearest Friday after the default date
5998 sep 15 @result{} @b{2006}-09-15
5999 feb 15 @result{} @b{2007}-02-15
6000 sep 12 9 @result{} 2009-09-12
6001 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
6002 22 sept 0:34 @result{} @b{2006}-09-22 0:34
6003 w4 @result{} ISO week for of the current year @b{2006}
6004 2012 w4 fri @result{} Friday of ISO week 4 in 2012
6005 2012-w04-5 @result{} Same as above
6008 Furthermore you can specify a relative date by giving, as the @emph{first}
6009 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
6010 indicate change in hours, days, weeks, months, or years. With a single plus
6011 or minus, the date is always relative to today. With a double plus or minus,
6012 it is relative to the default date. If instead of a single letter, you use
6013 the abbreviation of day name, the date will be the Nth such day, e.g.:
6018 +4d @result{} four days from today
6019 +4 @result{} same as above
6020 +2w @result{} two weeks from today
6021 ++5 @result{} five days from default date
6022 +2tue @result{} second Tuesday from now
6023 -wed @result{} last Wednesday
6026 @vindex parse-time-months
6027 @vindex parse-time-weekdays
6028 The function understands English month and weekday abbreviations. If
6029 you want to use unabbreviated names and/or other languages, configure
6030 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
6032 @vindex org-read-date-force-compatible-dates
6033 Not all dates can be represented in a given Emacs implementation. By default
6034 Org mode forces dates into the compatibility range 1970--2037 which works on
6035 all Emacs implementations. If you want to use dates outside of this range,
6036 read the docstring of the variable
6037 @code{org-read-date-force-compatible-dates}.
6039 You can specify a time range by giving start and end times or by giving a
6040 start time and a duration (in HH:MM format). Use one or two dash(es) as the
6041 separator in the former case and use '+' as the separator in the latter
6045 11am-1:15pm @result{} 11:00-13:15
6046 11am--1:15pm @result{} same as above
6047 11am+2:15 @result{} same as above
6050 @cindex calendar, for selecting date
6051 @vindex org-popup-calendar-for-date-prompt
6052 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6053 you don't need/want the calendar, configure the variable
6054 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
6055 prompt, either by clicking on a date in the calendar, or by pressing
6056 @key{RET}, the date selected in the calendar will be combined with the
6057 information entered at the prompt. You can control the calendar fully
6058 from the minibuffer:
6065 @kindex S-@key{right}
6066 @kindex S-@key{left}
6067 @kindex S-@key{down}
6069 @kindex M-S-@key{right}
6070 @kindex M-S-@key{left}
6073 @key{RET} @r{Choose date at cursor in calendar.}
6074 mouse-1 @r{Select date by clicking on it.}
6075 S-@key{right}/@key{left} @r{One day forward/backward.}
6076 S-@key{down}/@key{up} @r{One week forward/backward.}
6077 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6078 > / < @r{Scroll calendar forward/backward by one month.}
6079 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
6082 @vindex org-read-date-display-live
6083 The actions of the date/time prompt may seem complex, but I assure you they
6084 will grow on you, and you will start getting annoyed by pretty much any other
6085 way of entering a date/time out there. To help you understand what is going
6086 on, the current interpretation of your input will be displayed live in the
6087 minibuffer@footnote{If you find this distracting, turn the display off with
6088 @code{org-read-date-display-live}.}.
6090 @node Custom time format
6091 @subsection Custom time format
6092 @cindex custom date/time format
6093 @cindex time format, custom
6094 @cindex date format, custom
6096 @vindex org-display-custom-times
6097 @vindex org-time-stamp-custom-formats
6098 Org mode uses the standard ISO notation for dates and times as it is
6099 defined in ISO 8601. If you cannot get used to this and require another
6100 representation of date and time to keep you happy, you can get it by
6101 customizing the options @code{org-display-custom-times} and
6102 @code{org-time-stamp-custom-formats}.
6105 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6106 Toggle the display of custom formats for dates and times.
6110 Org mode needs the default format for scanning, so the custom date/time
6111 format does not @emph{replace} the default format---instead it is put
6112 @emph{over} the default format using text properties. This has the
6113 following consequences:
6116 You cannot place the cursor onto a timestamp anymore, only before or
6119 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6120 each component of a timestamp. If the cursor is at the beginning of
6121 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6122 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6123 time will be changed by one minute.
6125 If the timestamp contains a range of clock times or a repeater, these
6126 will not be overlaid, but remain in the buffer as they were.
6128 When you delete a timestamp character-by-character, it will only
6129 disappear from the buffer after @emph{all} (invisible) characters
6130 belonging to the ISO timestamp have been removed.
6132 If the custom timestamp format is longer than the default and you are
6133 using dates in tables, table alignment will be messed up. If the custom
6134 format is shorter, things do work as expected.
6138 @node Deadlines and scheduling
6139 @section Deadlines and scheduling
6141 A timestamp may be preceded by special keywords to facilitate planning:
6145 @cindex DEADLINE keyword
6147 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6148 to be finished on that date.
6150 @vindex org-deadline-warning-days
6151 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6152 On the deadline date, the task will be listed in the agenda. In
6153 addition, the agenda for @emph{today} will carry a warning about the
6154 approaching or missed deadline, starting
6155 @code{org-deadline-warning-days} before the due date, and continuing
6156 until the entry is marked DONE@. An example:
6159 *** TODO write article about the Earth for the Guide
6160 DEADLINE: <2004-02-29 Sun>
6161 The editor in charge is [[bbdb:Ford Prefect]]
6164 You can specify a different lead time for warnings for a specific
6165 deadline using the following syntax. Here is an example with a warning
6166 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6167 deactivated if the task gets scheduled and you set
6168 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6171 @cindex SCHEDULED keyword
6173 Meaning: you are planning to start working on that task on the given
6176 @vindex org-agenda-skip-scheduled-if-done
6177 The headline will be listed under the given date@footnote{It will still
6178 be listed on that date after it has been marked DONE@. If you don't like
6179 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6180 addition, a reminder that the scheduled date has passed will be present
6181 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6182 the task will automatically be forwarded until completed.
6185 *** TODO Call Trillian for a date on New Years Eve.
6186 SCHEDULED: <2004-12-25 Sat>
6189 @vindex org-scheduled-delay-days
6190 @vindex org-agenda-skip-scheduled-delay-if-deadline
6191 If you want to @emph{delay} the display of this task in the agenda, use
6192 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6193 25th but will appear two days later. In case the task contains a repeater,
6194 the delay is considered to affect all occurrences; if you want the delay to
6195 only affect the first scheduled occurrence of the task, use @code{--2d}
6196 instead. See @code{org-scheduled-delay-days} and
6197 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6198 control this globally or per agenda.
6201 @b{Important:} Scheduling an item in Org mode should @i{not} be
6202 understood in the same way that we understand @i{scheduling a meeting}.
6203 Setting a date for a meeting is just a simple appointment, you should
6204 mark this entry with a simple plain timestamp, to get this item shown
6205 on the date where it applies. This is a frequent misunderstanding by
6206 Org users. In Org mode, @i{scheduling} means setting a date when you
6207 want to start working on an action item.
6210 You may use timestamps with repeaters in scheduling and deadline
6211 entries. Org mode will issue early and late warnings based on the
6212 assumption that the timestamp represents the @i{nearest instance} of
6213 the repeater. However, the use of diary sexp entries like
6215 @code{<%%(diary-float t 42)>}
6217 in scheduling and deadline timestamps is limited. Org mode does not
6218 know enough about the internals of each sexp function to issue early and
6219 late warnings. However, it will show the item on each day where the
6223 * Inserting deadline/schedule:: Planning items
6224 * Repeated tasks:: Items that show up again and again
6227 @node Inserting deadline/schedule
6228 @subsection Inserting deadlines or schedules
6230 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6231 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6232 any text between this line and the headline.} a deadline or to schedule
6237 @orgcmd{C-c C-d,org-deadline}
6238 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6239 in the line directly following the headline. Any CLOSED timestamp will be
6240 removed. When called with a prefix arg, an existing deadline will be removed
6241 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6242 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6243 and @code{nologredeadline}}, a note will be taken when changing an existing
6246 @orgcmd{C-c C-s,org-schedule}
6247 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6248 happen in the line directly following the headline. Any CLOSED timestamp
6249 will be removed. When called with a prefix argument, remove the scheduling
6250 date from the entry. Depending on the variable
6251 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6252 keywords @code{logreschedule}, @code{lognotereschedule}, and
6253 @code{nologreschedule}}, a note will be taken when changing an existing
6256 @orgcmd{C-c / d,org-check-deadlines}
6257 @cindex sparse tree, for deadlines
6258 @vindex org-deadline-warning-days
6259 Create a sparse tree with all deadlines that are either past-due, or
6260 which will become due within @code{org-deadline-warning-days}.
6261 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6262 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6263 all deadlines due tomorrow.
6265 @orgcmd{C-c / b,org-check-before-date}
6266 Sparse tree for deadlines and scheduled items before a given date.
6268 @orgcmd{C-c / a,org-check-after-date}
6269 Sparse tree for deadlines and scheduled items after a given date.
6272 Note that @code{org-schedule} and @code{org-deadline} supports
6273 setting the date by indicating a relative time: e.g., +1d will set
6274 the date to the next day after today, and --1w will set the date
6275 to the previous week before any current timestamp.
6277 @node Repeated tasks
6278 @subsection Repeated tasks
6279 @cindex tasks, repeated
6280 @cindex repeated tasks
6282 Some tasks need to be repeated again and again. Org mode helps to
6283 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6284 or plain timestamp. In the following example
6286 ** TODO Pay the rent
6287 DEADLINE: <2005-10-01 Sat +1m>
6290 the @code{+1m} is a repeater; the intended interpretation is that the task
6291 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6292 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6293 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6294 and a special warning period in a deadline entry, the repeater should come
6295 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6297 @vindex org-todo-repeat-to-state
6298 Deadlines and scheduled items produce entries in the agenda when they are
6299 over-due, so it is important to be able to mark such an entry as completed
6300 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6301 keyword DONE, it will no longer produce entries in the agenda. The problem
6302 with this is, however, that then also the @emph{next} instance of the
6303 repeated entry will not be active. Org mode deals with this in the following
6304 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6305 shift the base date of the repeating timestamp by the repeater interval, and
6306 immediately set the entry state back to TODO@footnote{In fact, the target
6307 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6308 the variable @code{org-todo-repeat-to-state}. If neither of these is
6309 specified, the target state defaults to the first state of the TODO state
6310 sequence.}. In the example above, setting the state to DONE would actually
6311 switch the date like this:
6314 ** TODO Pay the rent
6315 DEADLINE: <2005-11-01 Tue +1m>
6318 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6319 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6321 @vindex org-log-repeat
6322 A timestamp@footnote{You can change this using the option
6323 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6324 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6325 will also be prompted for a note.} will be added under the deadline, to keep
6326 a record that you actually acted on the previous instance of this deadline.
6328 As a consequence of shifting the base date, this entry will no longer be
6329 visible in the agenda when checking past dates, but all future instances
6332 With the @samp{+1m} cookie, the date shift will always be exactly one
6333 month. So if you have not paid the rent for three months, marking this
6334 entry DONE will still keep it as an overdue deadline. Depending on the
6335 task, this may not be the best way to handle it. For example, if you
6336 forgot to call your father for 3 weeks, it does not make sense to call
6337 him 3 times in a single day to make up for it. Finally, there are tasks
6338 like changing batteries which should always repeat a certain time
6339 @i{after} the last time you did it. For these tasks, Org mode has
6340 special repeaters @samp{++} and @samp{.+}. For example:
6344 DEADLINE: <2008-02-10 Sun ++1w>
6345 Marking this DONE will shift the date by at least one week,
6346 but also by as many weeks as it takes to get this date into
6347 the future. However, it stays on a Sunday, even if you called
6348 and marked it done on Saturday.
6349 ** TODO Check the batteries in the smoke detectors
6350 DEADLINE: <2005-11-01 Tue .+1m>
6351 Marking this DONE will shift the date to one month after
6355 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6356 You may have both scheduling and deadline information for a specific task.
6357 If the repeater is set for the scheduling information only, you probably want
6358 the repeater to be ignored after the deadline. If so, set the variable
6359 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6360 @code{repeated-after-deadline}. If you want both scheduling and deadline
6361 information to repeat after the same interval, set the same repeater for both
6364 An alternative to using a repeater is to create a number of copies of a task
6365 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6366 created for this purpose, it is described in @ref{Structure editing}.
6369 @node Clocking work time
6370 @section Clocking work time
6371 @cindex clocking time
6372 @cindex time clocking
6374 Org mode allows you to clock the time you spend on specific tasks in a
6375 project. When you start working on an item, you can start the clock. When
6376 you stop working on that task, or when you mark the task done, the clock is
6377 stopped and the corresponding time interval is recorded. It also computes
6378 the total time spent on each subtree@footnote{Clocking only works if all
6379 headings are indented with less than 30 stars. This is a hardcoded
6380 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6381 history or tasks recently clocked, so that you can jump quickly between a
6382 number of tasks absorbing your time.
6384 To save the clock history across Emacs sessions, use
6386 (setq org-clock-persist 'history)
6387 (org-clock-persistence-insinuate)
6389 When you clock into a new task after resuming Emacs, the incomplete
6390 clock@footnote{To resume the clock under the assumption that you have worked
6391 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6392 will be found (@pxref{Resolving idle time}) and you will be prompted about
6396 * Clocking commands:: Starting and stopping a clock
6397 * The clock table:: Detailed reports
6398 * Resolving idle time:: Resolving time when you've been idle
6401 @node Clocking commands
6402 @subsection Clocking commands
6405 @orgcmd{C-c C-x C-i,org-clock-in}
6406 @vindex org-clock-into-drawer
6407 @vindex org-clock-continuously
6408 @cindex property, LOG_INTO_DRAWER
6409 Start the clock on the current item (clock-in). This inserts the CLOCK
6410 keyword together with a timestamp. If this is not the first clocking of
6411 this item, the multiple CLOCK lines will be wrapped into a
6412 @code{:LOGBOOK:} drawer (see also the variable
6413 @code{org-clock-into-drawer}). You can also overrule
6414 the setting of this variable for a subtree by setting a
6415 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6416 When called with a @kbd{C-u} prefix argument,
6417 select the task from a list of recently clocked tasks. With two @kbd{C-u
6418 C-u} prefixes, clock into the task at point and mark it as the default task;
6419 the default task will then always be available with letter @kbd{d} when
6420 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6421 continuous clocking by starting the clock when the last clock stopped.@*
6422 @cindex property: CLOCK_MODELINE_TOTAL
6423 @cindex property: LAST_REPEAT
6424 @vindex org-clock-modeline-total
6425 While the clock is running, the current clocking time is shown in the mode
6426 line, along with the title of the task. The clock time shown will be all
6427 time ever clocked for this task and its children. If the task has an effort
6428 estimate (@pxref{Effort estimates}), the mode line displays the current
6429 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6430 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6431 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6432 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6433 will be shown. More control over what time is shown can be exercised with
6434 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6435 @code{current} to show only the current clocking instance, @code{today} to
6436 show all time clocked on this tasks today (see also the variable
6437 @code{org-extend-today-until}), @code{all} to include all time, or
6438 @code{auto} which is the default@footnote{See also the variable
6439 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6440 mode line entry will pop up a menu with clocking options.
6442 @orgcmd{C-c C-x C-o,org-clock-out}
6443 @vindex org-log-note-clock-out
6444 Stop the clock (clock-out). This inserts another timestamp at the same
6445 location where the clock was last started. It also directly computes
6446 the resulting time and inserts it after the time range as @samp{=>
6447 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6448 possibility to record an additional note together with the clock-out
6449 timestamp@footnote{The corresponding in-buffer setting is:
6450 @code{#+STARTUP: lognoteclock-out}}.
6451 @orgcmd{C-c C-x C-x,org-clock-in-last}
6452 @vindex org-clock-continuously
6453 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6454 select the task from the clock history. With two @kbd{C-u} prefixes,
6455 force continuous clocking by starting the clock when the last clock
6457 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6458 Update the effort estimate for the current clock task.
6461 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6462 Recompute the time interval after changing one of the timestamps. This
6463 is only necessary if you edit the timestamps directly. If you change
6464 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6465 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6466 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6467 clock duration keeps the same.
6468 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6469 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6470 the one of the previous (or the next clock) timestamp by the same duration.
6471 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6472 by five minutes, then the clocked-in timestamp of the next clock will be
6473 increased by five minutes.
6474 @orgcmd{C-c C-t,org-todo}
6475 Changing the TODO state of an item to DONE automatically stops the clock
6476 if it is running in this same item.
6477 @orgcmd{C-c C-x C-q,org-clock-cancel}
6478 Cancel the current clock. This is useful if a clock was started by
6479 mistake, or if you ended up working on something else.
6480 @orgcmd{C-c C-x C-j,org-clock-goto}
6481 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6482 prefix arg, select the target task from a list of recently clocked tasks.
6483 @orgcmd{C-c C-x C-d,org-clock-display}
6484 @vindex org-remove-highlights-with-change
6485 Display time summaries for each subtree in the current buffer. This puts
6486 overlays at the end of each headline, showing the total time recorded under
6487 that heading, including the time of any subheadings. You can use visibility
6488 cycling to study the tree, but the overlays disappear when you change the
6489 buffer (see variable @code{org-remove-highlights-with-change}) or press
6493 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6494 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6495 worked on or closed during a day.
6497 @strong{Important:} note that both @code{org-clock-out} and
6498 @code{org-clock-in-last} can have a global keybinding and will not
6499 modify the window disposition.
6501 @node The clock table
6502 @subsection The clock table
6503 @cindex clocktable, dynamic block
6504 @cindex report, of clocked time
6506 Org mode can produce quite complex reports based on the time clocking
6507 information. Such a report is called a @emph{clock table}, because it is
6508 formatted as one or several Org tables.
6511 @orgcmd{C-c C-x C-r,org-clock-report}
6512 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6513 report as an Org mode table into the current file. When the cursor is
6514 at an existing clock table, just update it. When called with a prefix
6515 argument, jump to the first clock report in the current document and
6516 update it. The clock table always includes also trees with
6517 @code{:ARCHIVE:} tag.
6518 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6519 Update dynamic block at point. The cursor needs to be in the
6520 @code{#+BEGIN} line of the dynamic block.
6521 @orgkey{C-u C-c C-x C-u}
6522 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6523 you have several clock table blocks in a buffer.
6524 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6525 Shift the current @code{:block} interval and update the table. The cursor
6526 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6527 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6531 Here is an example of the frame for a clock table as it is inserted into the
6532 buffer with the @kbd{C-c C-x C-r} command:
6534 @cindex #+BEGIN, clocktable
6536 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6540 @vindex org-clocktable-defaults
6541 The @samp{BEGIN} line specifies a number of options to define the scope,
6542 structure, and formatting of the report. Defaults for all these options can
6543 be configured in the variable @code{org-clocktable-defaults}.
6545 @noindent First there are options that determine which clock entries are to
6548 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6549 @r{Clocks at deeper levels will be summed into the upper level.}
6550 :scope @r{The scope to consider. This can be any of the following:}
6551 nil @r{the current buffer or narrowed region}
6552 file @r{the full current buffer}
6553 subtree @r{the subtree where the clocktable is located}
6554 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6555 tree @r{the surrounding level 1 tree}
6556 agenda @r{all agenda files}
6557 ("file"..) @r{scan these files}
6558 file-with-archives @r{current file and its archives}
6559 agenda-with-archives @r{all agenda files, including archives}
6560 :block @r{The time block to consider. This block is specified either}
6561 @r{absolutely, or relative to the current time and may be any of}
6563 2007-12-31 @r{New year eve 2007}
6564 2007-12 @r{December 2007}
6565 2007-W50 @r{ISO-week 50 in 2007}
6566 2007-Q2 @r{2nd quarter in 2007}
6567 2007 @r{the year 2007}
6568 today, yesterday, today-@var{N} @r{a relative day}
6569 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6570 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6571 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6572 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6573 :tstart @r{A time string specifying when to start considering times.}
6574 @r{Relative times like @code{"<-2w>"} can also be used. See}
6575 @r{@ref{Matching tags and properties} for relative time syntax.}
6576 :tend @r{A time string specifying when to stop considering times.}
6577 @r{Relative times like @code{"<now>"} can also be used. See}
6578 @r{@ref{Matching tags and properties} for relative time syntax.}
6579 :wstart @r{The starting day of the week. The default is 1 for monday.}
6580 :mstart @r{The starting day of the month. The default 1 is for the first}
6581 @r{day of the month.}
6582 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6583 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6584 :stepskip0 @r{Do not show steps that have zero time.}
6585 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6586 :tags @r{A tags match to select entries that should contribute. See}
6587 @r{@ref{Matching tags and properties} for the match syntax.}
6590 Then there are options which determine the formatting of the table. These
6591 options are interpreted by the function @code{org-clocktable-write-default},
6592 but you can specify your own function using the @code{:formatter} parameter.
6594 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6595 :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".}
6596 :link @r{Link the item headlines in the table to their origins.}
6597 :narrow @r{An integer to limit the width of the headline column in}
6598 @r{the org table. If you write it like @samp{50!}, then the}
6599 @r{headline will also be shortened in export.}
6600 :indent @r{Indent each headline field according to its level.}
6601 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6602 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6603 :level @r{Should a level number column be included?}
6604 :sort @r{A cons cell like containing the column to sort and a sorting type.}
6605 @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6606 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6607 @r{All are overwritten except if there is an explicit @code{:narrow}}
6608 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6609 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6610 :properties @r{List of properties that should be shown in the table. Each}
6611 @r{property will get its own column.}
6612 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6613 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6614 @r{As a special case, @samp{:formula %} adds a column with % time.}
6615 @r{If you do not specify a formula here, any existing formula}
6616 @r{below the clock table will survive updates and be evaluated.}
6617 :formatter @r{A function to format clock data and insert it into the buffer.}
6619 To get a clock summary of the current level 1 tree, for the current
6620 day, you could write
6622 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6626 and to use a specific time range you could write@footnote{Note that all
6627 parameters must be specified in a single line---the line is broken here
6628 only to fit it into the manual.}
6630 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6631 :tend "<2006-08-10 Thu 12:00>"
6634 A range starting a week ago and ending right now could be written as
6636 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6639 A summary of the current subtree with % times would be
6641 #+BEGIN: clocktable :scope subtree :link t :formula %
6644 A horizontally compact representation of everything clocked during last week
6647 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6651 @node Resolving idle time
6652 @subsection Resolving idle time and continuous clocking
6654 @subsubheading Resolving idle time
6655 @cindex resolve idle time
6656 @vindex org-clock-x11idle-program-name
6658 @cindex idle, resolve, dangling
6659 If you clock in on a work item, and then walk away from your
6660 computer---perhaps to take a phone call---you often need to ``resolve'' the
6661 time you were away by either subtracting it from the current clock, or
6662 applying it to another one.
6664 @vindex org-clock-idle-time
6665 By customizing the variable @code{org-clock-idle-time} to some integer, such
6666 as 10 or 15, Emacs can alert you when you get back to your computer after
6667 being idle for that many minutes@footnote{On computers using Mac OS X,
6668 idleness is based on actual user idleness, not just Emacs' idle time. For
6669 X11, you can install a utility program @file{x11idle.c}, available in the
6670 @code{contrib/scripts} directory of the Org git distribution, or install the
6671 @file{xprintidle} package and set it to the variable
6672 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6673 same general treatment of idleness. On other systems, idle time refers to
6674 Emacs idle time only.}, and ask what you want to do with the idle time.
6675 There will be a question waiting for you when you get back, indicating how
6676 much idle time has passed (constantly updated with the current amount), as
6677 well as a set of choices to correct the discrepancy:
6681 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6682 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6683 effectively changing nothing, or enter a number to keep that many minutes.
6685 If you use the shift key and press @kbd{K}, it will keep however many minutes
6686 you request and then immediately clock out of that task. If you keep all of
6687 the minutes, this is the same as just clocking out of the current task.
6689 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6690 the clock, and then check back in from the moment you returned.
6692 To keep none of the minutes and just clock out at the start of the away time,
6693 use the shift key and press @kbd{S}. Remember that using shift will always
6694 leave you clocked out, no matter which option you choose.
6696 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6697 canceling you subtract the away time, and the resulting clock amount is less
6698 than a minute, the clock will still be canceled rather than clutter up the
6699 log with an empty entry.
6702 What if you subtracted those away minutes from the current clock, and now
6703 want to apply them to a new clock? Simply clock in to any task immediately
6704 after the subtraction. Org will notice that you have subtracted time ``on
6705 the books'', so to speak, and will ask if you want to apply those minutes to
6706 the next task you clock in on.
6708 There is one other instance when this clock resolution magic occurs. Say you
6709 were clocked in and hacking away, and suddenly your cat chased a mouse who
6710 scared a hamster that crashed into your UPS's power button! You suddenly
6711 lose all your buffers, but thanks to auto-save you still have your recent Org
6712 mode changes, including your last clock in.
6714 If you restart Emacs and clock into any task, Org will notice that you have a
6715 dangling clock which was never clocked out from your last session. Using
6716 that clock's starting time as the beginning of the unaccounted-for period,
6717 Org will ask how you want to resolve that time. The logic and behavior is
6718 identical to dealing with away time due to idleness; it is just happening due
6719 to a recovery event rather than a set amount of idle time.
6721 You can also check all the files visited by your Org agenda for dangling
6722 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6724 @subsubheading Continuous clocking
6725 @cindex continuous clocking
6726 @vindex org-clock-continuously
6728 You may want to start clocking from the time when you clocked out the
6729 previous task. To enable this systematically, set @code{org-clock-continuously}
6730 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6731 last clocked entry for this session, and start the new clock from there.
6733 If you only want this from time to time, use three universal prefix arguments
6734 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6736 @node Effort estimates
6737 @section Effort estimates
6738 @cindex effort estimates
6740 @cindex property, Effort
6741 @vindex org-effort-property
6742 If you want to plan your work in a very detailed way, or if you need to
6743 produce offers with quotations of the estimated work effort, you may want to
6744 assign effort estimates to entries. If you are also clocking your work, you
6745 may later want to compare the planned effort with the actual working time,
6746 a great way to improve planning estimates. Effort estimates are stored in
6747 a special property @code{EFFORT}. You can set the effort for an entry with
6748 the following commands:
6751 @orgcmd{C-c C-x e,org-set-effort}
6752 Set the effort estimate for the current entry. With a numeric prefix
6753 argument, set it to the Nth allowed value (see below). This command is also
6754 accessible from the agenda with the @kbd{e} key.
6755 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6756 Modify the effort estimate of the item currently being clocked.
6759 Clearly the best way to work with effort estimates is through column view
6760 (@pxref{Column view}). You should start by setting up discrete values for
6761 effort estimates, and a @code{COLUMNS} format that displays these values
6762 together with clock sums (if you want to clock your time). For a specific
6766 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6767 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6771 @vindex org-global-properties
6772 @vindex org-columns-default-format
6773 or, even better, you can set up these values globally by customizing the
6774 variables @code{org-global-properties} and @code{org-columns-default-format}.
6775 In particular if you want to use this setup also in the agenda, a global
6776 setup may be advised.
6778 The way to assign estimates to individual items is then to switch to column
6779 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6780 value. The values you enter will immediately be summed up in the hierarchy.
6781 In the column next to it, any clocked time will be displayed.
6783 @vindex org-agenda-columns-add-appointments-to-effort-sum
6784 If you switch to column view in the daily/weekly agenda, the effort column
6785 will summarize the estimated work effort for each day@footnote{Please note
6786 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6787 column view}).}, and you can use this to find space in your schedule. To get
6788 an overview of the entire part of the day that is committed, you can set the
6789 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6790 appointments on a day that take place over a specified time interval will
6791 then also be added to the load estimate of the day.
6793 Effort estimates can be used in secondary agenda filtering that is triggered
6794 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6795 these estimates defined consistently, two or three key presses will narrow
6796 down the list to stuff that fits into an available time slot.
6798 @node Relative timer
6799 @section Taking notes with a relative timer
6800 @cindex relative timer
6802 When taking notes during, for example, a meeting or a video viewing, it can
6803 be useful to have access to times relative to a starting time. Org provides
6804 such a relative timer and make it easy to create timed notes.
6807 @orgcmd{C-c C-x .,org-timer}
6808 Insert a relative time into the buffer. The first time you use this, the
6809 timer will be started. When called with a prefix argument, the timer is
6811 @orgcmd{C-c C-x -,org-timer-item}
6812 Insert a description list item with the current relative time. With a prefix
6813 argument, first reset the timer to 0.
6814 @orgcmd{M-@key{RET},org-insert-heading}
6815 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6817 @c for key sequences with a comma, command name macros fail :(
6820 Pause the timer, or continue it if it is already paused
6821 (@command{org-timer-pause-or-continue}).
6822 @c removed the sentence because it is redundant to the following item
6823 @kindex C-u C-c C-x ,
6825 Stop the timer. After this, you can only start a new timer, not continue the
6826 old one. This command also removes the timer from the mode line.
6827 @orgcmd{C-c C-x 0,org-timer-start}
6828 Reset the timer without inserting anything into the buffer. By default, the
6829 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6830 specific starting offset. The user is prompted for the offset, with a
6831 default taken from a timer string at point, if any, So this can be used to
6832 restart taking notes after a break in the process. When called with a double
6833 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6834 by a certain amount. This can be used to fix timer strings if the timer was
6835 not started at exactly the right moment.
6838 @node Countdown timer
6839 @section Countdown timer
6840 @cindex Countdown timer
6844 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6845 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6847 @code{org-timer-set-timer} prompts the user for a duration and displays a
6848 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6849 default countdown value. Giving a prefix numeric argument overrides this
6852 @node Capture - Refile - Archive
6853 @chapter Capture - Refile - Archive
6856 An important part of any organization system is the ability to quickly
6857 capture new ideas and tasks, and to associate reference material with them.
6858 Org does this using a process called @i{capture}. It also can store files
6859 related to a task (@i{attachments}) in a special directory. Once in the
6860 system, tasks and projects need to be moved around. Moving completed project
6861 trees to an archive file keeps the system compact and fast.
6864 * Capture:: Capturing new stuff
6865 * Attachments:: Add files to tasks
6866 * RSS feeds:: Getting input from RSS feeds
6867 * Protocols:: External (e.g., Browser) access to Emacs and Org
6868 * Refile and copy:: Moving/copying a tree from one place to another
6869 * Archiving:: What to do with finished projects
6876 Capture lets you quickly store notes with little interruption of your work
6877 flow. Org's method for capturing new items is heavily inspired by John
6878 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6879 used a special setup for @file{remember.el}, then replaced it with
6880 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6881 been completely replaced by @file{org-capture.el}.
6883 If your configuration depends on @file{org-remember.el}, you need to update
6884 it and use the setup described below. To convert your
6885 @code{org-remember-templates}, run the command
6887 @kbd{M-x org-capture-import-remember-templates RET}
6889 @noindent and then customize the new variable with @kbd{M-x
6890 customize-variable org-capture-templates}, check the result, and save the
6894 * Setting up capture:: Where notes will be stored
6895 * Using capture:: Commands to invoke and terminate capture
6896 * Capture templates:: Define the outline of different note types
6899 @node Setting up capture
6900 @subsection Setting up capture
6902 The following customization sets a default target file for notes, and defines
6903 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6904 suggestion.} for capturing new material.
6906 @vindex org-default-notes-file
6909 (setq org-default-notes-file (concat org-directory "/notes.org"))
6910 (define-key global-map "\C-cc" 'org-capture)
6915 @subsection Using capture
6918 @orgcmd{C-c c,org-capture}
6919 Call the command @code{org-capture}. Note that this keybinding is global and
6920 not active by default: you need to install it. If you have templates
6922 defined @pxref{Capture templates}, it will offer these templates for
6923 selection or use a new Org outline node as the default template. It will
6924 insert the template into the target file and switch to an indirect buffer
6925 narrowed to this new node. You may then insert the information you want.
6927 @orgcmd{C-c C-c,org-capture-finalize}
6928 Once you have finished entering information into the capture buffer, @kbd{C-c
6929 C-c} will return you to the window configuration before the capture process,
6930 so that you can resume your work without further distraction. When called
6931 with a prefix arg, finalize and then jump to the captured item.
6933 @orgcmd{C-c C-w,org-capture-refile}
6934 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6935 a different place. Please realize that this is a normal refiling command
6936 that will be executed---so the cursor position at the moment you run this
6937 command is important. If you have inserted a tree with a parent and
6938 children, first move the cursor back to the parent. Any prefix argument
6939 given to this command will be passed on to the @code{org-refile} command.
6941 @orgcmd{C-c C-k,org-capture-kill}
6942 Abort the capture process and return to the previous state.
6946 You can also call @code{org-capture} in a special way from the agenda, using
6947 the @kbd{k c} key combination. With this access, any timestamps inserted by
6948 the selected capture template will default to the cursor date in the agenda,
6949 rather than to the current date.
6951 To find the locations of the last stored capture, use @code{org-capture} with
6956 Visit the target location of a capture template. You get to select the
6957 template in the usual way.
6958 @orgkey{C-u C-u C-c c}
6959 Visit the last stored capture item in its buffer.
6962 @vindex org-capture-bookmark
6963 @cindex org-capture-last-stored
6964 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6965 automatically be created unless you set @code{org-capture-bookmark} to
6968 To insert the capture at point in an Org buffer, call @code{org-capture} with
6969 a @code{C-0} prefix argument.
6971 @node Capture templates
6972 @subsection Capture templates
6973 @cindex templates, for Capture
6975 You can use templates for different types of capture items, and
6976 for different target locations. The easiest way to create such templates is
6977 through the customize interface.
6981 Customize the variable @code{org-capture-templates}.
6984 Before we give the formal description of template definitions, let's look at
6985 an example. Say you would like to use one template to create general TODO
6986 entries, and you want to put these entries under the heading @samp{Tasks} in
6987 your file @file{~/org/gtd.org}. Also, a date tree in the file
6988 @file{journal.org} should capture journal entries. A possible configuration
6993 (setq org-capture-templates
6994 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6995 "* TODO %?\n %i\n %a")
6996 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6997 "* %?\nEntered on %U\n %i\n %a")))
7001 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
7005 [[file:@var{link to where you initiated capture}]]
7009 During expansion of the template, @code{%a} has been replaced by a link to
7010 the location from where you called the capture command. This can be
7011 extremely useful for deriving tasks from emails, for example. You fill in
7012 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7013 place where you started the capture process.
7015 To define special keys to capture to a particular template without going
7016 through the interactive template selection, you can create your key binding
7020 (define-key global-map "\C-cx"
7021 (lambda () (interactive) (org-capture nil "x")))
7025 * Template elements:: What is needed for a complete template entry
7026 * Template expansion:: Filling in information about time and context
7027 * Templates in contexts:: Only show a template in a specific context
7030 @node Template elements
7031 @subsubsection Template elements
7033 Now lets look at the elements of a template definition. Each entry in
7034 @code{org-capture-templates} is a list with the following items:
7038 The keys that will select the template, as a string, characters
7039 only, for example @code{"a"} for a template to be selected with a
7040 single key, or @code{"bt"} for selection with two keys. When using
7041 several keys, keys using the same prefix key must be sequential
7042 in the list and preceded by a 2-element entry explaining the
7043 prefix key, for example
7045 ("b" "Templates for marking stuff to buy")
7047 @noindent If you do not define a template for the @kbd{C} key, this key will
7048 be used to open the customize buffer for this complex variable.
7051 A short string describing the template, which will be shown during
7055 The type of entry, a symbol. Valid values are:
7059 An Org mode node, with a headline. Will be filed as the child of the target
7060 entry or as a top-level entry. The target file should be an Org mode file.
7062 A plain list item, placed in the first plain list at the target
7063 location. Again the target file should be an Org file.
7065 A checkbox item. This only differs from the plain list item by the
7068 a new line in the first table at the target location. Where exactly the
7069 line will be inserted depends on the properties @code{:prepend} and
7070 @code{:table-line-pos} (see below).
7072 Text to be inserted as it is.
7076 @vindex org-default-notes-file
7077 Specification of where the captured item should be placed. In Org mode
7078 files, targets usually define a node. Entries will become children of this
7079 node. Other types will be added to the table or list in the body of this
7080 node. Most target specifications contain a file name. If that file name is
7081 the empty string, it defaults to @code{org-default-notes-file}. A file can
7082 also be given as a variable, function, or Emacs Lisp form.
7087 @item (file "path/to/file")
7088 Text will be placed at the beginning or end of that file.
7090 @item (id "id of existing org entry")
7091 Filing as child of this entry, or in the body of the entry.
7093 @item (file+headline "path/to/file" "node headline")
7094 Fast configuration if the target heading is unique in the file.
7096 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7097 For non-unique headings, the full path is safer.
7099 @item (file+regexp "path/to/file" "regexp to find location")
7100 Use a regular expression to position the cursor.
7102 @item (file+datetree "path/to/file")
7103 Will create a heading in a date tree for today's date@footnote{Datetree
7104 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7105 and @code{* 2013} in your file, the capture will refile the note to the first
7108 @item (file+datetree+prompt "path/to/file")
7109 Will create a heading in a date tree, but will prompt for the date.
7111 @item (file+function "path/to/file" function-finding-location)
7112 A function to find the right location in the file.
7115 File to the entry that is currently being clocked.
7117 @item (function function-finding-location)
7118 Most general way, write your own function to find both
7123 The template for creating the capture item. If you leave this empty, an
7124 appropriate default template will be used. Otherwise this is a string with
7125 escape codes, which will be replaced depending on time and context of the
7126 capture call. The string with escapes may be loaded from a template file,
7127 using the special syntax @code{(file "path/to/template")}. See below for
7131 The rest of the entry is a property list of additional options.
7132 Recognized properties are:
7136 Normally new captured information will be appended at
7137 the target location (last child, last table line, last list item...).
7138 Setting this property will change that.
7140 @item :immediate-finish
7141 When set, do not offer to edit the information, just
7142 file it away immediately. This makes sense if the template only needs
7143 information that can be added automatically.
7146 Set this to the number of lines to insert
7147 before and after the new item. Default 0, only common other value is 1.
7150 Start the clock in this item.
7153 Keep the clock running when filing the captured entry.
7156 If starting the capture interrupted a clock, restart that clock when finished
7157 with the capture. Note that @code{:clock-keep} has precedence over
7158 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7159 run and the previous one will not be resumed.
7162 Do not narrow the target buffer, simply show the full buffer. Default is to
7163 narrow it so that you only see the new material.
7165 @item :table-line-pos
7166 Specification of the location in the table where the new line should be
7167 inserted. It can be a string, a variable holding a string or a function
7168 returning a string. The string should look like @code{"II-3"} meaning that
7169 the new line should become the third line before the second horizontal
7173 If the target file was not yet visited when capture was invoked, kill the
7174 buffer again after capture is completed.
7178 @node Template expansion
7179 @subsubsection Template expansion
7181 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7182 these sequences literally, escape the @kbd{%} with a backslash.} allow
7183 dynamic insertion of content. The templates are expanded in the order given here:
7186 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7187 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7188 @r{For convenience, %:keyword (see below) placeholders}
7189 @r{within the expression will be expanded prior to this.}
7190 @r{The sexp must return a string.}
7191 %<...> @r{The result of format-time-string on the ... format specification.}
7192 %t @r{Timestamp, date only.}
7193 %T @r{Timestamp, with date and time.}
7194 %u, %U @r{Like the above, but inactive timestamps.}
7195 %i @r{Initial content, the region when capture is called while the}
7196 @r{region is active.}
7197 @r{The entire text will be indented like @code{%i} itself.}
7198 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7199 %A @r{Like @code{%a}, but prompt for the description part.}
7200 %l @r{Like %a, but only insert the literal link.}
7201 %c @r{Current kill ring head.}
7202 %x @r{Content of the X clipboard.}
7203 %k @r{Title of the currently clocked task.}
7204 %K @r{Link to the currently clocked task.}
7205 %n @r{User name (taken from @code{user-full-name}).}
7206 %f @r{File visited by current buffer when org-capture was called.}
7207 %F @r{Full path of the file or directory visited by current buffer.}
7208 %:keyword @r{Specific information for certain link types, see below.}
7209 %^g @r{Prompt for tags, with completion on tags in target file.}
7210 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7211 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7212 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7213 %^C @r{Interactive selection of which kill or clip to use.}
7214 %^L @r{Like @code{%^C}, but insert as link.}
7215 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7216 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7217 @r{You may specify a default value and a completion table with}
7218 @r{%^@{prompt|default|completion2|completion3...@}.}
7219 @r{The arrow keys access a prompt-specific history.}
7220 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7221 @r{a number, starting from 1.}
7222 %? @r{After completing the template, position cursor here.}
7226 For specific link types, the following keywords will be
7227 defined@footnote{If you define your own link types (@pxref{Adding
7228 hyperlink types}), any property you store with
7229 @code{org-store-link-props} can be accessed in capture templates in a
7232 @vindex org-from-is-user-regexp
7234 Link type | Available keywords
7235 ---------------------------------+----------------------------------------------
7236 bbdb | %:name %:company
7237 irc | %:server %:port %:nick
7238 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
7239 | %:from %:fromname %:fromaddress
7240 | %:to %:toname %:toaddress
7241 | %:date @r{(message date header field)}
7242 | %:date-timestamp @r{(date as active timestamp)}
7243 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7244 | %: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}.}}
7245 gnus | %:group, @r{for messages also all email fields}
7247 info | %:file %:node
7252 To place the cursor after template expansion use:
7255 %? @r{After completing the template, position cursor here.}
7258 @node Templates in contexts
7259 @subsubsection Templates in contexts
7261 @vindex org-capture-templates-contexts
7262 To control whether a capture template should be accessible from a specific
7263 context, you can customize @code{org-capture-templates-contexts}. Let's say
7264 for example that you have a capture template @code{"p"} for storing Gnus
7265 emails containing patches. Then you would configure this option like this:
7268 (setq org-capture-templates-contexts
7269 '(("p" (in-mode . "message-mode"))))
7272 You can also tell that the command key @code{"p"} should refer to another
7273 template. In that case, add this command key like this:
7276 (setq org-capture-templates-contexts
7277 '(("p" "q" (in-mode . "message-mode"))))
7280 See the docstring of the variable for more information.
7283 @section Attachments
7286 @vindex org-attach-directory
7287 It is often useful to associate reference material with an outline node/task.
7288 Small chunks of plain text can simply be stored in the subtree of a project.
7289 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7290 files that live elsewhere on your computer or in the cloud, like emails or
7291 source code files belonging to a project. Another method is @i{attachments},
7292 which are files located in a directory belonging to an outline node. Org
7293 uses directories named by the unique ID of each entry. These directories are
7294 located in the @file{data} directory which lives in the same directory where
7295 your Org file lives@footnote{If you move entries or Org files from one
7296 directory to another, you may want to configure @code{org-attach-directory}
7297 to contain an absolute path.}. If you initialize this directory with
7298 @code{git init}, Org will automatically commit changes when it sees them.
7299 The attachment system has been contributed to Org by John Wiegley.
7301 In cases where it seems better to do so, you can also attach a directory of your
7302 choice to an entry. You can also make children inherit the attachment
7303 directory from a parent, so that an entire subtree uses the same attached
7306 @noindent The following commands deal with attachments:
7309 @orgcmd{C-c C-a,org-attach}
7310 The dispatcher for commands related to the attachment system. After these
7311 keys, a list of commands is displayed and you must press an additional key
7312 to select a command:
7315 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7316 @vindex org-attach-method
7317 Select a file and move it into the task's attachment directory. The file
7318 will be copied, moved, or linked, depending on @code{org-attach-method}.
7319 Note that hard links are not supported on all systems.
7325 Attach a file using the copy/move/link method.
7326 Note that hard links are not supported on all systems.
7328 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7329 Create a new attachment as an Emacs buffer.
7331 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7332 Synchronize the current task with its attachment directory, in case you added
7333 attachments yourself.
7335 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7336 @vindex org-file-apps
7337 Open current task's attachment. If there is more than one, prompt for a
7338 file name first. Opening will follow the rules set by @code{org-file-apps}.
7339 For more details, see the information on following hyperlinks
7340 (@pxref{Handling links}).
7342 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7343 Also open the attachment, but force opening the file in Emacs.
7345 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7346 Open the current task's attachment directory.
7348 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7349 Also open the directory, but force using @command{dired} in Emacs.
7351 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7352 Select and delete a single attachment.
7354 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7355 Delete all of a task's attachments. A safer way is to open the directory in
7356 @command{dired} and delete from there.
7358 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7359 @cindex property, ATTACH_DIR
7360 Set a specific directory as the entry's attachment directory. This works by
7361 putting the directory path into the @code{ATTACH_DIR} property.
7363 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7364 @cindex property, ATTACH_DIR_INHERIT
7365 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7366 same directory for attachments as the parent does.
7375 Org can add and change entries based on information found in RSS feeds and
7376 Atom feeds. You could use this to make a task out of each new podcast in a
7377 podcast feed. Or you could use a phone-based note-creating service on the
7378 web to import tasks into Org. To access feeds, configure the variable
7379 @code{org-feed-alist}. The docstring of this variable has detailed
7380 information. Here is just an example:
7384 (setq org-feed-alist
7386 "http://rss.slashdot.org/Slashdot/slashdot"
7387 "~/txt/org/feeds.org" "Slashdot Entries")))
7392 will configure that new items from the feed provided by
7393 @code{rss.slashdot.org} will result in new entries in the file
7394 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7395 the following command is used:
7398 @orgcmd{C-c C-x g,org-feed-update-all}
7400 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7402 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7403 Prompt for a feed name and go to the inbox configured for this feed.
7406 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7407 it will store information about the status of items in the feed, to avoid
7408 adding the same item several times.
7410 For more information, including how to read atom feeds, see
7411 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7414 @section Protocols for external access
7415 @cindex protocols, for external access
7418 You can set up Org for handling protocol calls from outside applications that
7419 are passed to Emacs through the @file{emacsserver}. For example, you can
7420 configure bookmarks in your web browser to send a link to the current page to
7421 Org and create a note from it using capture (@pxref{Capture}). Or you
7422 could create a bookmark that will tell Emacs to open the local source file of
7423 a remote website you are looking at with the browser. See
7424 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7425 documentation and setup instructions.
7427 @node Refile and copy
7428 @section Refile and copy
7429 @cindex refiling notes
7430 @cindex copying notes
7432 When reviewing the captured data, you may want to refile or to copy some of
7433 the entries into a different list, for example into a project. Cutting,
7434 finding the right location, and then pasting the note is cumbersome. To
7435 simplify this process, you can use the following special command:
7438 @orgcmd{C-c M-w,org-copy}
7440 Copying works like refiling, except that the original note is not deleted.
7441 @orgcmd{C-c C-w,org-refile}
7443 @vindex org-reverse-note-order
7444 @vindex org-refile-targets
7445 @vindex org-refile-use-outline-path
7446 @vindex org-outline-path-complete-in-steps
7447 @vindex org-refile-allow-creating-parent-nodes
7448 @vindex org-log-refile
7449 @vindex org-refile-use-cache
7450 @vindex org-refile-keep
7451 Refile the entry or region at point. This command offers possible locations
7452 for refiling the entry and lets you select one with completion. The item (or
7453 all items in the region) is filed below the target heading as a subitem.
7454 Depending on @code{org-reverse-note-order}, it will be either the first or
7456 By default, all level 1 headlines in the current buffer are considered to be
7457 targets, but you can have more complex definitions across a number of files.
7458 See the variable @code{org-refile-targets} for details. If you would like to
7459 select a location via a file-path-like completion along the outline path, see
7460 the variables @code{org-refile-use-outline-path} and
7461 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7462 create new nodes as new parents for refiling on the fly, check the
7463 variable @code{org-refile-allow-creating-parent-nodes}.
7464 When the variable @code{org-log-refile}@footnote{with corresponding
7465 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7466 and @code{nologrefile}} is set, a timestamp or a note will be
7467 recorded when an entry has been refiled.
7468 @orgkey{C-u C-c C-w}
7469 Use the refile interface to jump to a heading.
7470 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7471 Jump to the location where @code{org-refile} last moved a tree to.
7473 Refile as the child of the item currently being clocked.
7475 Refile and keep the entry in place. Also see @code{org-refile-keep} to make
7476 this the default behavior, and beware that this may result in duplicated
7477 @code{ID} properties.
7478 @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}
7479 Clear the target cache. Caching of refile targets can be turned on by
7480 setting @code{org-refile-use-cache}. To make the command see new possible
7481 targets, you have to clear the cache with this command.
7488 When a project represented by a (sub)tree is finished, you may want
7489 to move the tree out of the way and to stop it from contributing to the
7490 agenda. Archiving is important to keep your working files compact and global
7491 searches like the construction of agenda views fast.
7494 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7495 @vindex org-archive-default-command
7496 Archive the current entry using the command specified in the variable
7497 @code{org-archive-default-command}.
7501 * Moving subtrees:: Moving a tree to an archive file
7502 * Internal archiving:: Switch off a tree but keep it in the file
7505 @node Moving subtrees
7506 @subsection Moving a tree to the archive file
7507 @cindex external archiving
7509 The most common archiving action is to move a project tree to another file,
7513 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7514 @vindex org-archive-location
7515 Archive the subtree starting at the cursor position to the location
7516 given by @code{org-archive-location}.
7517 @orgkey{C-u C-c C-x C-s}
7518 Check if any direct children of the current headline could be moved to
7519 the archive. To do this, each subtree is checked for open TODO entries.
7520 If none are found, the command offers to move it to the archive
7521 location. If the cursor is @emph{not} on a headline when this command
7522 is invoked, the level 1 trees will be checked.
7525 @cindex archive locations
7526 The default archive location is a file in the same directory as the
7527 current file, with the name derived by appending @file{_archive} to the
7528 current file name. You can also choose what heading to file archived
7529 items under, with the possibility to add them to a datetree in a file.
7530 For information and examples on how to specify the file and the heading,
7531 see the documentation string of the variable
7532 @code{org-archive-location}.
7534 There is also an in-buffer option for setting this variable, for
7535 example@footnote{For backward compatibility, the following also works:
7536 If there are several such lines in a file, each specifies the archive
7537 location for the text below it. The first such line also applies to any
7538 text before its definition. However, using this method is
7539 @emph{strongly} deprecated as it is incompatible with the outline
7540 structure of the document. The correct method for setting multiple
7541 archive locations in a buffer is using properties.}:
7545 #+ARCHIVE: %s_done::
7548 @cindex property, ARCHIVE
7550 If you would like to have a special ARCHIVE location for a single entry
7551 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7552 location as the value (@pxref{Properties and columns}).
7554 @vindex org-archive-save-context-info
7555 When a subtree is moved, it receives a number of special properties that
7556 record context information like the file from where the entry came, its
7557 outline path the archiving time etc. Configure the variable
7558 @code{org-archive-save-context-info} to adjust the amount of information
7562 @node Internal archiving
7563 @subsection Internal archiving
7565 If you want to just switch off (for agenda views) certain subtrees without
7566 moving them to a different file, you can use the @code{ARCHIVE tag}.
7568 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7569 its location in the outline tree, but behaves in the following way:
7572 @vindex org-cycle-open-archived-trees
7573 It does not open when you attempt to do so with a visibility cycling
7574 command (@pxref{Visibility cycling}). You can force cycling archived
7575 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7576 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7577 @code{show-all} will open archived subtrees.
7579 @vindex org-sparse-tree-open-archived-trees
7580 During sparse tree construction (@pxref{Sparse trees}), matches in
7581 archived subtrees are not exposed, unless you configure the option
7582 @code{org-sparse-tree-open-archived-trees}.
7584 @vindex org-agenda-skip-archived-trees
7585 During agenda view construction (@pxref{Agenda views}), the content of
7586 archived trees is ignored unless you configure the option
7587 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7588 be included. In the agenda you can press @kbd{v a} to get archives
7589 temporarily included.
7591 @vindex org-export-with-archived-trees
7592 Archived trees are not exported (@pxref{Exporting}), only the headline
7593 is. Configure the details using the variable
7594 @code{org-export-with-archived-trees}.
7596 @vindex org-columns-skip-archived-trees
7597 Archived trees are excluded from column view unless the variable
7598 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7601 The following commands help manage the ARCHIVE tag:
7604 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7605 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7606 the headline changes to a shadowed face, and the subtree below it is
7608 @orgkey{C-u C-c C-x a}
7609 Check if any direct children of the current headline should be archived.
7610 To do this, each subtree is checked for open TODO entries. If none are
7611 found, the command offers to set the ARCHIVE tag for the child. If the
7612 cursor is @emph{not} on a headline when this command is invoked, the
7613 level 1 trees will be checked.
7614 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7615 Cycle a tree even if it is tagged with ARCHIVE.
7616 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7617 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7618 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7619 entry becomes a child of that sibling and in this way retains a lot of its
7620 original context, including inherited tags and approximate position in the
7626 @chapter Agenda views
7627 @cindex agenda views
7629 Due to the way Org works, TODO items, time-stamped items, and
7630 tagged headlines can be scattered throughout a file or even a number of
7631 files. To get an overview of open action items, or of events that are
7632 important for a particular date, this information must be collected,
7633 sorted and displayed in an organized way.
7635 Org can select items based on various criteria and display them
7636 in a separate buffer. Seven different view types are provided:
7640 an @emph{agenda} that is like a calendar and shows information
7643 a @emph{TODO list} that covers all unfinished
7646 a @emph{match view}, showings headlines based on the tags, properties, and
7647 TODO state associated with them,
7649 a @emph{timeline view} that shows all events in a single Org file,
7650 in time-sorted view,
7652 a @emph{text search view} that shows all entries from multiple files
7653 that contain specified keywords,
7655 a @emph{stuck projects view} showing projects that currently don't move
7658 @emph{custom views} that are special searches and combinations of different
7663 The extracted information is displayed in a special @emph{agenda
7664 buffer}. This buffer is read-only, but provides commands to visit the
7665 corresponding locations in the original Org files, and even to
7666 edit these files remotely.
7668 @vindex org-agenda-window-setup
7669 @vindex org-agenda-restore-windows-after-quit
7670 Two variables control how the agenda buffer is displayed and whether the
7671 window configuration is restored when the agenda exits:
7672 @code{org-agenda-window-setup} and
7673 @code{org-agenda-restore-windows-after-quit}.
7676 * Agenda files:: Files being searched for agenda information
7677 * Agenda dispatcher:: Keyboard access to agenda views
7678 * Built-in agenda views:: What is available out of the box?
7679 * Presentation and sorting:: How agenda items are prepared for display
7680 * Agenda commands:: Remote editing of Org trees
7681 * Custom agenda views:: Defining special searches and views
7682 * Exporting agenda views:: Writing a view to a file
7683 * Agenda column view:: Using column view for collected entries
7687 @section Agenda files
7688 @cindex agenda files
7689 @cindex files for agenda
7691 @vindex org-agenda-files
7692 The information to be shown is normally collected from all @emph{agenda
7693 files}, the files listed in the variable
7694 @code{org-agenda-files}@footnote{If the value of that variable is not a
7695 list, but a single file name, then the list of agenda files will be
7696 maintained in that external file.}. If a directory is part of this list,
7697 all files with the extension @file{.org} in this directory will be part
7700 Thus, even if you only work with a single Org file, that file should
7701 be put into the list@footnote{When using the dispatcher, pressing
7702 @kbd{<} before selecting a command will actually limit the command to
7703 the current file, and ignore @code{org-agenda-files} until the next
7704 dispatcher command.}. You can customize @code{org-agenda-files}, but
7705 the easiest way to maintain it is through the following commands
7707 @cindex files, adding to agenda list
7709 @orgcmd{C-c [,org-agenda-file-to-front}
7710 Add current file to the list of agenda files. The file is added to
7711 the front of the list. If it was already in the list, it is moved to
7712 the front. With a prefix argument, file is added/moved to the end.
7713 @orgcmd{C-c ],org-remove-file}
7714 Remove current file from the list of agenda files.
7716 @cindex cycling, of agenda files
7717 @orgcmd{C-',org-cycle-agenda-files}
7719 Cycle through agenda file list, visiting one file after the other.
7720 @kindex M-x org-iswitchb
7721 @item M-x org-iswitchb RET
7722 Command to use an @code{iswitchb}-like interface to switch to and between Org
7727 The Org menu contains the current list of files and can be used
7728 to visit any of them.
7730 If you would like to focus the agenda temporarily on a file not in
7731 this list, or on just one file in the list, or even on only a subtree in a
7732 file, then this can be done in different ways. For a single agenda command,
7733 you may press @kbd{<} once or several times in the dispatcher
7734 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7735 extended period, use the following commands:
7738 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7739 Permanently restrict the agenda to the current subtree. When with a
7740 prefix argument, or with the cursor before the first headline in a file,
7741 the agenda scope is set to the entire file. This restriction remains in
7742 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7743 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7744 agenda view, the new restriction takes effect immediately.
7745 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7746 Remove the permanent restriction created by @kbd{C-c C-x <}.
7750 When working with @file{speedbar.el}, you can use the following commands in
7754 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7755 Permanently restrict the agenda to the item---either an Org file or a subtree
7756 in such a file---at the cursor in the Speedbar frame.
7757 If there is a window displaying an agenda view, the new restriction takes
7759 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7760 Lift the restriction.
7763 @node Agenda dispatcher
7764 @section The agenda dispatcher
7765 @cindex agenda dispatcher
7766 @cindex dispatching agenda commands
7767 The views are created through a dispatcher, which should be bound to a
7768 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7769 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7770 is accessed and list keyboard access to commands accordingly. After
7771 pressing @kbd{C-c a}, an additional letter is required to execute a
7772 command. The dispatcher offers the following default commands:
7776 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7778 Create a list of all TODO items (@pxref{Global TODO list}).
7780 Create a list of headlines matching a TAGS expression (@pxref{Matching
7781 tags and properties}).
7783 Create the timeline view for the current buffer (@pxref{Timeline}).
7785 Create a list of entries selected by a boolean expression of keywords
7786 and/or regular expressions that must or must not occur in the entry.
7788 @vindex org-agenda-text-search-extra-files
7789 Search for a regular expression in all agenda files and additionally in
7790 the files listed in @code{org-agenda-text-search-extra-files}. This
7791 uses the Emacs command @code{multi-occur}. A prefix argument can be
7792 used to specify the number of context lines for each match, default is
7795 Create a list of stuck projects (@pxref{Stuck projects}).
7797 Restrict an agenda command to the current buffer@footnote{For backward
7798 compatibility, you can also press @kbd{1} to restrict to the current
7799 buffer.}. After pressing @kbd{<}, you still need to press the character
7800 selecting the command.
7802 If there is an active region, restrict the following agenda command to
7803 the region. Otherwise, restrict it to the current subtree@footnote{For
7804 backward compatibility, you can also press @kbd{0} to restrict to the
7805 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7806 character selecting the command.
7809 @cindex agenda, sticky
7810 @vindex org-agenda-sticky
7811 Toggle sticky agenda views. By default, Org maintains only a single agenda
7812 buffer and rebuilds it each time you change the view, to make sure everything
7813 is always up to date. If you often switch between agenda views and the build
7814 time bothers you, you can turn on sticky agenda buffers or make this the
7815 default by customizing the variable @code{org-agenda-sticky}. With sticky
7816 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7817 it will only switch to the selected one, and you need to update the agenda by
7818 hand with @kbd{r} or @kbd{g} when needed. You can toggle sticky agenda view
7819 any time with @code{org-toggle-sticky-agenda}.
7822 You can also define custom commands that will be accessible through the
7823 dispatcher, just like the default commands. This includes the
7824 possibility to create extended agenda buffers that contain several
7825 blocks together, for example the weekly agenda, the global TODO list and
7826 a number of special tags matches. @xref{Custom agenda views}.
7828 @node Built-in agenda views
7829 @section The built-in agenda views
7831 In this section we describe the built-in views.
7834 * Weekly/daily agenda:: The calendar page with current tasks
7835 * Global TODO list:: All unfinished action items
7836 * Matching tags and properties:: Structured information with fine-tuned search
7837 * Timeline:: Time-sorted view for single file
7838 * Search view:: Find entries by searching for text
7839 * Stuck projects:: Find projects you need to review
7842 @node Weekly/daily agenda
7843 @subsection The weekly/daily agenda
7845 @cindex weekly agenda
7846 @cindex daily agenda
7848 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7849 paper agenda, showing all the tasks for the current week or day.
7852 @cindex org-agenda, command
7853 @orgcmd{C-c a a,org-agenda-list}
7854 Compile an agenda for the current week from a list of Org files. The agenda
7855 shows the entries for each day. With a numeric prefix@footnote{For backward
7856 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7857 listed before the agenda. This feature is deprecated, use the dedicated TODO
7858 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7859 C-c a a}) you may set the number of days to be displayed.
7862 @vindex org-agenda-span
7863 @vindex org-agenda-ndays
7864 @vindex org-agenda-start-day
7865 @vindex org-agenda-start-on-weekday
7866 The default number of days displayed in the agenda is set by the variable
7867 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7868 variable can be set to any number of days you want to see by default in the
7869 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7870 @code{year}. For weekly agendas, the default is to start on the previous
7871 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7872 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7873 start the agenda ten days from today in the future.
7875 Remote editing from the agenda buffer means, for example, that you can
7876 change the dates of deadlines and appointments from the agenda buffer.
7877 The commands available in the Agenda buffer are listed in @ref{Agenda
7880 @subsubheading Calendar/Diary integration
7881 @cindex calendar integration
7882 @cindex diary integration
7884 Emacs contains the calendar and diary by Edward M. Reingold. The
7885 calendar displays a three-month calendar with holidays from different
7886 countries and cultures. The diary allows you to keep track of
7887 anniversaries, lunar phases, sunrise/set, recurrent appointments
7888 (weekly, monthly) and more. In this way, it is quite complementary to
7889 Org. It can be very useful to combine output from Org with
7892 In order to include entries from the Emacs diary into Org mode's
7893 agenda, you only need to customize the variable
7896 (setq org-agenda-include-diary t)
7899 @noindent After that, everything will happen automatically. All diary
7900 entries including holidays, anniversaries, etc., will be included in the
7901 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7902 @key{RET} can be used from the agenda buffer to jump to the diary
7903 file in order to edit existing diary entries. The @kbd{i} command to
7904 insert new entries for the current date works in the agenda buffer, as
7905 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7906 Sunrise/Sunset times, show lunar phases and to convert to other
7907 calendars, respectively. @kbd{c} can be used to switch back and forth
7908 between calendar and agenda.
7910 If you are using the diary only for sexp entries and holidays, it is
7911 faster to not use the above setting, but instead to copy or even move
7912 the entries into an Org file. Org mode evaluates diary-style sexp
7913 entries, and does it faster because there is no overhead for first
7914 creating the diary display. Note that the sexp entries must start at
7915 the left margin, no whitespace is allowed before them. For example,
7916 the following segment of an Org file will be processed and entries
7917 will be made in the agenda:
7920 * Birthdays and similar stuff
7922 %%(org-calendar-holiday) ; special function for holiday names
7924 %%(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
7925 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7928 @subsubheading Anniversaries from BBDB
7929 @cindex BBDB, anniversaries
7930 @cindex anniversaries, from BBDB
7932 If you are using the Big Brothers Database to store your contacts, you will
7933 very likely prefer to store anniversaries in BBDB rather than in a
7934 separate Org or diary file. Org supports this and will show BBDB
7935 anniversaries as part of the agenda. All you need to do is to add the
7936 following to one of your agenda files:
7943 %%(org-bbdb-anniversaries)
7946 You can then go ahead and define anniversaries for a BBDB record. Basically,
7947 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7948 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7949 followed by a space and the class of the anniversary (@samp{birthday} or
7950 @samp{wedding}, or a format string). If you omit the class, it will default to
7951 @samp{birthday}. Here are a few examples, the header for the file
7952 @file{org-bbdb.el} contains more detailed information.
7958 2008-04-14 %s released version 6.01 of org mode, %d years ago
7961 After a change to BBDB, or for the first agenda display during an Emacs
7962 session, the agenda display will suffer a short delay as Org updates its
7963 hash with anniversaries. However, from then on things will be very fast---much
7964 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7965 in an Org or Diary file.
7967 @subsubheading Appointment reminders
7968 @cindex @file{appt.el}
7969 @cindex appointment reminders
7973 Org can interact with Emacs appointments notification facility. To add the
7974 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7975 This command lets you filter through the list of your appointments and add
7976 only those belonging to a specific category or matching a regular expression.
7977 It also reads a @code{APPT_WARNTIME} property which will then override the
7978 value of @code{appt-message-warning-time} for this appointment. See the
7979 docstring for details.
7981 @node Global TODO list
7982 @subsection The global TODO list
7983 @cindex global TODO list
7984 @cindex TODO list, global
7986 The global TODO list contains all unfinished TODO items formatted and
7987 collected into a single place.
7990 @orgcmd{C-c a t,org-todo-list}
7991 Show the global TODO list. This collects the TODO items from all agenda
7992 files (@pxref{Agenda views}) into a single buffer. By default, this lists
7993 items with a state the is not a DONE state. The buffer is in
7994 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7995 entries directly from that buffer (@pxref{Agenda commands}).
7996 @orgcmd{C-c a T,org-todo-list}
7997 @cindex TODO keyword matching
7998 @vindex org-todo-keywords
7999 Like the above, but allows selection of a specific TODO keyword. You can
8000 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
8001 prompted for a keyword, and you may also specify several keywords by
8002 separating them with @samp{|} as the boolean OR operator. With a numeric
8003 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
8005 The @kbd{r} key in the agenda buffer regenerates it, and you can give
8006 a prefix argument to this command to change the selected TODO keyword,
8007 for example @kbd{3 r}. If you often need a search for a specific
8008 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
8009 Matching specific TODO keywords can also be done as part of a tags
8010 search (@pxref{Tag searches}).
8013 Remote editing of TODO items means that you can change the state of a
8014 TODO entry with a single key press. The commands available in the
8015 TODO list are described in @ref{Agenda commands}.
8017 @cindex sublevels, inclusion into TODO list
8018 Normally the global TODO list simply shows all headlines with TODO
8019 keywords. This list can become very long. There are two ways to keep
8023 @vindex org-agenda-todo-ignore-scheduled
8024 @vindex org-agenda-todo-ignore-deadlines
8025 @vindex org-agenda-todo-ignore-timestamp
8026 @vindex org-agenda-todo-ignore-with-date
8027 Some people view a TODO item that has been @emph{scheduled} for execution or
8028 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8029 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8030 @code{org-agenda-todo-ignore-deadlines},
8031 @code{org-agenda-todo-ignore-timestamp} and/or
8032 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8035 @vindex org-agenda-todo-list-sublevels
8036 TODO items may have sublevels to break up the task into subtasks. In
8037 such cases it may be enough to list only the highest level TODO headline
8038 and omit the sublevels from the global list. Configure the variable
8039 @code{org-agenda-todo-list-sublevels} to get this behavior.
8042 @node Matching tags and properties
8043 @subsection Matching tags and properties
8044 @cindex matching, of tags
8045 @cindex matching, of properties
8049 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8050 or have properties (@pxref{Properties and columns}), you can select headlines
8051 based on this metadata and collect them into an agenda buffer. The match
8052 syntax described here also applies when creating sparse trees with @kbd{C-c /
8056 @orgcmd{C-c a m,org-tags-view}
8057 Produce a list of all headlines that match a given set of tags. The
8058 command prompts for a selection criterion, which is a boolean logic
8059 expression with tags, like @samp{+work+urgent-withboss} or
8060 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
8061 define a custom command for it (@pxref{Agenda dispatcher}).
8062 @orgcmd{C-c a M,org-tags-view}
8063 @vindex org-tags-match-list-sublevels
8064 @vindex org-agenda-tags-todo-honor-ignore-options
8065 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8066 not-DONE state and force checking subitems (see variable
8067 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
8068 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
8069 specific TODO keywords together with a tags match is also possible, see
8073 The commands available in the tags list are described in @ref{Agenda
8076 @subsubheading Match syntax
8078 @cindex Boolean logic, for tag/property searches
8079 A search string can use Boolean operators @samp{&} for @code{AND} and
8080 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8081 Parentheses are not implemented. Each element in the search is either a
8082 tag, a regular expression matching tags, or an expression like
8083 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8084 property value. Each element may be preceded by @samp{-}, to select
8085 against it, and @samp{+} is syntactic sugar for positive selection. The
8086 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8087 present. Here are some examples, using only tags.
8091 Select headlines tagged @samp{:work:}.
8093 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8095 Select headlines tagged @samp{:work:}, but discard those also tagged
8098 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8099 @item work|laptop+night
8100 Like before, but require the @samp{:laptop:} lines to be tagged also
8104 @cindex regular expressions, with tags search
8105 Instead of a tag, you may also specify a regular expression enclosed in curly
8106 braces. For example,
8107 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8108 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8110 @cindex group tags, as regular expressions
8111 Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g.,
8112 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8113 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8114 and searching for @samp{-work} will search for all headlines but those with
8115 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8117 @cindex TODO keyword matching, with tags search
8118 @cindex level, require for tags/property match
8119 @cindex category, require for tags/property match
8120 @vindex org-odd-levels-only
8121 You may also test for properties (@pxref{Properties and columns}) at the same
8122 time as matching tags. The properties may be real properties, or special
8123 properties that represent other metadata (@pxref{Special properties}). For
8124 example, the ``property'' @code{TODO} represents the TODO keyword of the
8125 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8126 the entry. The ITEM special property cannot currently be used in tags/property
8127 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8128 ,skipping entries based on regexp}.}.
8130 In addition to the @pxref{Special properties}, one other ``property'' can
8131 also be used. @code{LEVEL} represents the level of an entry. So a search
8132 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8133 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8134 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8135 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8137 Here are more examples:
8140 @item work+TODO="WAITING"
8141 Select @samp{:work:}-tagged TODO lines with the specific TODO
8142 keyword @samp{WAITING}.
8143 @item work+TODO="WAITING"|home+TODO="WAITING"
8144 Waiting tasks both at work and at home.
8147 When matching properties, a number of different operators can be used to test
8148 the value of a property. Here is a complex example:
8151 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8152 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8156 The type of comparison will depend on how the comparison value is written:
8159 If the comparison value is a plain number, a numerical comparison is done,
8160 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8161 @samp{>=}, and @samp{<>}.
8163 If the comparison value is enclosed in double-quotes,
8164 a string comparison is done, and the same operators are allowed.
8166 If the comparison value is enclosed in double-quotes @emph{and} angular
8167 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8168 assumed to be date/time specifications in the standard Org way, and the
8169 comparison will be done accordingly. Special values that will be recognized
8170 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8171 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8172 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8173 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8174 respectively, can be used.
8176 If the comparison value is enclosed
8177 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8178 regexp matches the property value, and @samp{<>} meaning that it does not
8182 So the search string in the example finds entries tagged @samp{:work:} but
8183 not @samp{:boss:}, which also have a priority value @samp{A}, a
8184 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8185 property that is numerically smaller than 2, a @samp{:With:} property that is
8186 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8187 on or after October 11, 2008.
8189 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
8190 other properties will slow down the search. However, once you have paid the
8191 price by accessing one property, testing additional properties is cheap
8194 You can configure Org mode to use property inheritance during a search, but
8195 beware that this can slow down searches considerably. See @ref{Property
8196 inheritance}, for details.
8198 For backward compatibility, and also for typing speed, there is also a
8199 different way to test TODO states in a search. For this, terminate the
8200 tags/property part of the search string (which may include several terms
8201 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8202 expression just for TODO keywords. The syntax is then similar to that for
8203 tags, but should be applied with care: for example, a positive selection on
8204 several TODO keywords cannot meaningfully be combined with boolean AND@.
8205 However, @emph{negative selection} combined with AND can be meaningful. To
8206 make sure that only lines are checked that actually have any TODO keyword
8207 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8208 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8209 not match TODO keywords in a DONE state. Examples:
8213 Same as @samp{work+TODO="WAITING"}
8214 @item work/!-WAITING-NEXT
8215 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8217 @item work/!+WAITING|+NEXT
8218 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8223 @subsection Timeline for a single file
8224 @cindex timeline, single file
8225 @cindex time-sorted view
8227 The timeline summarizes all time-stamped items from a single Org mode
8228 file in a @emph{time-sorted view}. The main purpose of this command is
8229 to give an overview over events in a project.
8232 @orgcmd{C-c a L,org-timeline}
8233 Show a time-sorted view of the Org file, with all time-stamped items.
8234 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8235 (scheduled or not) are also listed under the current date.
8239 The commands available in the timeline buffer are listed in
8240 @ref{Agenda commands}.
8243 @subsection Search view
8246 @cindex searching, for text
8248 This agenda view is a general text search facility for Org mode entries.
8249 It is particularly useful to find notes.
8252 @orgcmd{C-c a s,org-search-view}
8253 This is a special search that lets you select entries by matching a substring
8254 or specific words using a boolean logic.
8256 For example, the search string @samp{computer equipment} will find entries
8257 that contain @samp{computer equipment} as a substring. If the two words are
8258 separated by more space or a line break, the search will still match.
8259 Search view can also search for specific keywords in the entry, using Boolean
8260 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8261 will search for note entries that contain the keywords @code{computer}
8262 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8263 not matched by the regular expression @code{8\.11[bg]}, meaning to
8264 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8265 word search, other @samp{+} characters are optional. For more details, see
8266 the docstring of the command @code{org-search-view}.
8268 @vindex org-agenda-text-search-extra-files
8269 Note that in addition to the agenda files, this command will also search
8270 the files listed in @code{org-agenda-text-search-extra-files}.
8272 @node Stuck projects
8273 @subsection Stuck projects
8274 @pindex GTD, Getting Things Done
8276 If you are following a system like David Allen's GTD to organize your
8277 work, one of the ``duties'' you have is a regular review to make sure
8278 that all projects move along. A @emph{stuck} project is a project that
8279 has no defined next actions, so it will never show up in the TODO lists
8280 Org mode produces. During the review, you need to identify such
8281 projects and define next actions for them.
8284 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8285 List projects that are stuck.
8288 @vindex org-stuck-projects
8289 Customize the variable @code{org-stuck-projects} to define what a stuck
8290 project is and how to find it.
8293 You almost certainly will have to configure this view before it will
8294 work for you. The built-in default assumes that all your projects are
8295 level-2 headlines, and that a project is not stuck if it has at least
8296 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8298 Let's assume that you, in your own way of using Org mode, identify
8299 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8300 indicate a project that should not be considered yet. Let's further
8301 assume that the TODO keyword DONE marks finished projects, and that NEXT
8302 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8303 is a next action even without the NEXT tag. Finally, if the project
8304 contains the special word IGNORE anywhere, it should not be listed
8305 either. In this case you would start by identifying eligible projects
8306 with a tags/todo match@footnote{@xref{Tag searches}.}
8307 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8308 IGNORE in the subtree to identify projects that are not stuck. The
8309 correct customization for this is
8312 (setq org-stuck-projects
8313 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8317 Note that if a project is identified as non-stuck, the subtree of this entry
8318 will still be searched for stuck projects.
8320 @node Presentation and sorting
8321 @section Presentation and sorting
8322 @cindex presentation, of agenda items
8324 @vindex org-agenda-prefix-format
8325 @vindex org-agenda-tags-column
8326 Before displaying items in an agenda view, Org mode visually prepares the
8327 items and sorts them. Each item occupies a single line. The line starts
8328 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8329 of the item and other important information. You can customize in which
8330 column tags will be displayed through @code{org-agenda-tags-column}. You can
8331 also customize the prefix using the option @code{org-agenda-prefix-format}.
8332 This prefix is followed by a cleaned-up version of the outline headline
8333 associated with the item.
8336 * Categories:: Not all tasks are equal
8337 * Time-of-day specifications:: How the agenda knows the time
8338 * Sorting agenda items:: The order of things
8339 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8343 @subsection Categories
8347 The category is a broad label assigned to each agenda item. By default,
8348 the category is simply derived from the file name, but you can also
8349 specify it with a special line in the buffer, like this@footnote{For
8350 backward compatibility, the following also works: if there are several
8351 such lines in a file, each specifies the category for the text below it.
8352 The first category also applies to any text before the first CATEGORY
8353 line. However, using this method is @emph{strongly} deprecated as it is
8354 incompatible with the outline structure of the document. The correct
8355 method for setting multiple categories in a buffer is using a
8363 @cindex property, CATEGORY
8364 If you would like to have a special CATEGORY for a single entry or a
8365 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8366 special category you want to apply as the value.
8369 The display in the agenda buffer looks best if the category is not
8370 longer than 10 characters.
8373 You can set up icons for category by customizing the
8374 @code{org-agenda-category-icon-alist} variable.
8376 @node Time-of-day specifications
8377 @subsection Time-of-day specifications
8378 @cindex time-of-day specification
8380 Org mode checks each agenda item for a time-of-day specification. The
8381 time can be part of the timestamp that triggered inclusion into the
8382 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8383 ranges can be specified with two timestamps, like
8385 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8387 In the headline of the entry itself, a time(range) may also appear as
8388 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8389 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8390 specifications in diary entries are recognized as well.
8392 For agenda display, Org mode extracts the time and displays it in a
8393 standard 24 hour format as part of the prefix. The example times in
8394 the previous paragraphs would end up in the agenda like this:
8397 8:30-13:00 Arthur Dent lies in front of the bulldozer
8398 12:45...... Ford Prefect arrives and takes Arthur to the pub
8399 19:00...... The Vogon reads his poem
8400 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8404 If the agenda is in single-day mode, or for the display of today, the
8405 timed entries are embedded in a time grid, like
8408 8:00...... ------------------
8409 8:30-13:00 Arthur Dent lies in front of the bulldozer
8410 10:00...... ------------------
8411 12:00...... ------------------
8412 12:45...... Ford Prefect arrives and takes Arthur to the pub
8413 14:00...... ------------------
8414 16:00...... ------------------
8415 18:00...... ------------------
8416 19:00...... The Vogon reads his poem
8417 20:00...... ------------------
8418 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8421 @vindex org-agenda-use-time-grid
8422 @vindex org-agenda-time-grid
8423 The time grid can be turned on and off with the variable
8424 @code{org-agenda-use-time-grid}, and can be configured with
8425 @code{org-agenda-time-grid}.
8427 @node Sorting agenda items
8428 @subsection Sorting agenda items
8429 @cindex sorting, of agenda items
8430 @cindex priorities, of agenda items
8431 Before being inserted into a view, the items are sorted. How this is
8432 done depends on the type of view.
8435 @vindex org-agenda-files
8436 For the daily/weekly agenda, the items for each day are sorted. The
8437 default order is to first collect all items containing an explicit
8438 time-of-day specification. These entries will be shown at the beginning
8439 of the list, as a @emph{schedule} for the day. After that, items remain
8440 grouped in categories, in the sequence given by @code{org-agenda-files}.
8441 Within each category, items are sorted by priority (@pxref{Priorities}),
8442 which is composed of the base priority (2000 for priority @samp{A}, 1000
8443 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8444 overdue scheduled or deadline items.
8446 For the TODO list, items remain in the order of categories, but within
8447 each category, sorting takes place according to priority
8448 (@pxref{Priorities}). The priority used for sorting derives from the
8449 priority cookie, with additions depending on how close an item is to its due
8452 For tags matches, items are not sorted at all, but just appear in the
8453 sequence in which they are found in the agenda files.
8456 @vindex org-agenda-sorting-strategy
8457 Sorting can be customized using the variable
8458 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8459 the estimated effort of an entry (@pxref{Effort estimates}).
8461 @node Filtering/limiting agenda items
8462 @subsection Filtering/limiting agenda items
8464 Agenda built-in or customized commands are statically defined. Agenda
8465 filters and limits provide two ways of dynamically narrowing down the list of
8466 agenda entries: @emph{filters} and @emph{limits}. Filters only act on the
8467 display of the items, while limits take effect before the list of agenda
8468 entries is built. Filters are more often used interactively, while limits are
8469 mostly useful when defined as local variables within custom agenda commands.
8471 @subsubheading Filtering in the agenda
8472 @cindex filtering, by tag, category, top headline and effort, in agenda
8473 @cindex tag filtering, in agenda
8474 @cindex category filtering, in agenda
8475 @cindex top headline filtering, in agenda
8476 @cindex effort filtering, in agenda
8477 @cindex query editing, in agenda
8480 @orgcmd{/,org-agenda-filter-by-tag}
8481 @vindex org-agenda-tag-filter-preset
8482 Filter the agenda view with respect to a tag and/or effort estimates. The
8483 difference between this and a custom agenda command is that filtering is very
8484 fast, so that you can switch quickly between different filters without having
8485 to recreate the agenda.@footnote{Custom commands can preset a filter by
8486 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8487 filter will then be applied to the view and persist as a basic filter through
8488 refreshes and more secondary filtering. The filter is a global property of
8489 the entire agenda view---in a block agenda, you should only set this in the
8490 global options section, not in the section of an individual block.}
8492 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8493 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8494 tag (including any tags that do not have a selection character). The command
8495 then hides all entries that do not contain or inherit this tag. When called
8496 with prefix arg, remove the entries that @emph{do} have the tag. A second
8497 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8498 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8499 will be narrowed by requiring or forbidding the selected additional tag.
8500 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8501 immediately use the @kbd{\} command.
8503 Org also supports automatic, context-aware tag filtering. If the variable
8504 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8505 that function can decide which tags should be excluded from the agenda
8506 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8507 as a sub-option key and runs the auto exclusion logic. For example, let's
8508 say you use a @code{Net} tag to identify tasks which need network access, an
8509 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8510 calls. You could auto-exclude these tags based on the availability of the
8511 Internet, and outside of business hours, with something like this:
8515 (defun org-my-auto-exclude-function (tag)
8517 ((string= tag "Net")
8518 (/= 0 (call-process "/sbin/ping" nil nil nil
8519 "-c1" "-q" "-t1" "mail.gnu.org")))
8520 ((or (string= tag "Errand") (string= tag "Call"))
8521 (let ((hour (nth 2 (decode-time))))
8522 (or (< hour 8) (> hour 21)))))
8525 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8529 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8530 Narrow the current agenda filter by an additional condition. When called with
8531 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8532 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8533 @kbd{-} as the first key after the @kbd{/} command.
8542 @item @r{in} search view
8543 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8544 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8545 add a positive search term prefixed by @samp{+}, indicating that this search
8546 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8547 negative search term which @i{must not} occur/match in the entry for it to be
8551 @orgcmd{<,org-agenda-filter-by-category}
8552 @vindex org-agenda-category-filter-preset
8554 Filter the current agenda view with respect to the category of the item at
8555 point. Pressing @code{<} another time will remove this filter. You can add
8556 a filter preset through the option @code{org-agenda-category-filter-preset}
8559 @orgcmd{^,org-agenda-filter-by-top-headline}
8560 Filter the current agenda view and only display the siblings and the parent
8561 headline of the one at point.
8563 @orgcmd{=,org-agenda-filter-by-regexp}
8564 @vindex org-agenda-regexp-filter-preset
8566 Filter the agenda view by a regular expression: only show agenda entries
8567 matching the regular expression the user entered. When called with a prefix
8568 argument, it will filter @emph{out} entries matching the regexp. With two
8569 universal prefix arguments, it will remove all the regexp filters, which can
8570 be accumulated. You can add a filter preset through the option
8571 @code{org-agenda-category-filter-preset} (see below.)
8573 @orgcmd{_,org-agenda-filter-by-effort}
8574 @vindex org-agenda-effort-filter-preset
8575 @vindex org-sort-agenda-noeffort-is-high
8576 Filter the agenda view with respect to effort estimates.
8577 You first need to set up allowed efforts globally, for example
8579 (setq org-global-properties
8580 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8582 You can then filter for an effort by first typing an operator, one of
8583 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8584 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8585 The filter will then restrict to entries with effort smaller-or-equal, equal,
8586 or larger-or-equal than the selected value. For application of the operator,
8587 entries without a defined effort will be treated according to the value of
8588 @code{org-sort-agenda-noeffort-is-high}.
8590 @orgcmd{|,org-agenda-filter-remove-all}
8591 Remove all filters in the current agenda view.
8594 @subsubheading Setting limits for the agenda
8595 @cindex limits, in agenda
8596 @vindex org-agenda-max-entries
8597 @vindex org-agenda-max-effort
8598 @vindex org-agenda-max-todos
8599 @vindex org-agenda-max-tags
8601 Here is a list of options that you can set, either globally, or locally in
8602 your custom agenda views@pxref{Custom agenda views}.
8605 @item org-agenda-max-entries
8606 Limit the number of entries.
8607 @item org-agenda-max-effort
8608 Limit the duration of accumulated efforts (as minutes).
8609 @item org-agenda-max-todos
8610 Limit the number of entries with TODO keywords.
8611 @item org-agenda-max-tags
8612 Limit the number of tagged entries.
8615 When set to a positive integer, each option will exclude entries from other
8616 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8617 the agenda to 100 minutes of effort and exclude any entry that has no effort
8618 property. If you want to include entries with no effort property, use a
8619 negative value for @code{org-agenda-max-effort}.
8621 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8622 command. For example, this custom command will display the next five entries
8623 with a @code{NEXT} TODO keyword.
8626 (setq org-agenda-custom-commands
8628 ((org-agenda-max-entries 5)))))
8631 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8632 will again the next five entries again, including the first entry that was
8635 You can also dynamically set temporary limits, which will be lost when
8636 rebuilding the agenda:
8639 @orgcmd{~,org-agenda-limit-interactively}
8640 This prompts for the type of limit to apply and its value.
8643 @node Agenda commands
8644 @section Commands in the agenda buffer
8645 @cindex commands, in agenda buffer
8647 Entries in the agenda buffer are linked back to the Org file or diary
8648 file where they originate. You are not allowed to edit the agenda
8649 buffer itself, but commands are provided to show and jump to the
8650 original entry location, and to edit the Org files ``remotely'' from
8651 the agenda buffer. In this way, all information is stored only once,
8652 removing the risk that your agenda and note files may diverge.
8654 Some commands can be executed with mouse clicks on agenda lines. For
8655 the other commands, the cursor needs to be in the desired line.
8658 @tsubheading{Motion}
8659 @cindex motion commands in agenda
8660 @orgcmd{n,org-agenda-next-line}
8661 Next line (same as @key{down} and @kbd{C-n}).
8662 @orgcmd{p,org-agenda-previous-line}
8663 Previous line (same as @key{up} and @kbd{C-p}).
8664 @orgcmd{N,org-agenda-next-item}
8665 Next item: same as next line, but only consider items.
8666 @orgcmd{P,org-agenda-previous-item}
8667 Previous item: same as previous line, but only consider items.
8668 @tsubheading{View/Go to Org file}
8669 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8670 Display the original location of the item in another window.
8671 With prefix arg, make sure that the entire entry is made visible in the
8672 outline, not only the heading.
8674 @orgcmd{L,org-agenda-recenter}
8675 Display original location and recenter that window.
8677 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8678 Go to the original location of the item in another window.
8680 @orgcmd{@key{RET},org-agenda-switch-to}
8681 Go to the original location of the item and delete other windows.
8683 @orgcmd{F,org-agenda-follow-mode}
8684 @vindex org-agenda-start-with-follow-mode
8685 Toggle Follow mode. In Follow mode, as you move the cursor through
8686 the agenda buffer, the other window always shows the corresponding
8687 location in the Org file. The initial setting for this mode in new
8688 agenda buffers can be set with the variable
8689 @code{org-agenda-start-with-follow-mode}.
8691 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8692 Display the entire subtree of the current item in an indirect buffer. With a
8693 numeric prefix argument N, go up to level N and then take that tree. If N is
8694 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8695 previously used indirect buffer.
8697 @orgcmd{C-c C-o,org-agenda-open-link}
8698 Follow a link in the entry. This will offer a selection of any links in the
8699 text belonging to the referenced Org node. If there is only one link, it
8700 will be followed without a selection prompt.
8702 @tsubheading{Change display}
8703 @cindex display changing, in agenda
8706 Interactively select another agenda view and append it to the current view.
8710 Delete other windows.
8712 @orgcmdkskc{v d,d,org-agenda-day-view}
8713 @xorgcmdkskc{v w,w,org-agenda-week-view}
8714 @xorgcmd{v t,org-agenda-fortnight-view}
8715 @xorgcmd{v m,org-agenda-month-view}
8716 @xorgcmd{v y,org-agenda-year-view}
8717 @xorgcmd{v SPC,org-agenda-reset-view}
8718 @vindex org-agenda-span
8719 Switch to day/week/month/year view. When switching to day or week view, this
8720 setting becomes the default for subsequent agenda refreshes. Since month and
8721 year views are slow to create, they do not become the default. A numeric
8722 prefix argument may be used to jump directly to a specific day of the year,
8723 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8724 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8725 month view, a year may be encoded in the prefix argument as well. For
8726 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8727 specification has only one or two digits, it will be mapped to the interval
8728 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8729 @code{org-agenda-span}.
8731 @orgcmd{f,org-agenda-later}
8732 Go forward in time to display the following @code{org-agenda-current-span} days.
8733 For example, if the display covers a week, switch to the following week.
8734 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8736 @orgcmd{b,org-agenda-earlier}
8737 Go backward in time to display earlier dates.
8739 @orgcmd{.,org-agenda-goto-today}
8742 @orgcmd{j,org-agenda-goto-date}
8743 Prompt for a date and go there.
8745 @orgcmd{J,org-agenda-clock-goto}
8746 Go to the currently clocked-in task @i{in the agenda buffer}.
8748 @orgcmd{D,org-agenda-toggle-diary}
8749 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8751 @orgcmdkskc{v l,l,org-agenda-log-mode}
8753 @vindex org-log-done
8754 @vindex org-agenda-log-mode-items
8755 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8756 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8757 entries that have been clocked on that day. You can configure the entry
8758 types that should be included in log mode using the variable
8759 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8760 all possible logbook entries, including state changes. When called with two
8761 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8762 @kbd{v L} is equivalent to @kbd{C-u v l}.
8764 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8765 Include inactive timestamps into the current view. Only for weekly/daily
8766 agenda and timeline views.
8768 @orgcmd{v a,org-agenda-archives-mode}
8769 @xorgcmd{v A,org-agenda-archives-mode 'files}
8770 Toggle Archives mode. In Archives mode, trees that are marked
8771 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8772 capital @kbd{A}, even all archive files are included. To exit archives mode,
8773 press @kbd{v a} again.
8775 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8776 @vindex org-agenda-start-with-clockreport-mode
8777 @vindex org-clock-report-include-clocking-task
8778 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8779 always show a table with the clocked times for the time span and file scope
8780 covered by the current agenda view. The initial setting for this mode in new
8781 agenda buffers can be set with the variable
8782 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8783 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8784 contributions from entries that are hidden by agenda filtering@footnote{Only
8785 tags filtering will be respected here, effort filtering is ignored.}. See
8786 also the variable @code{org-clock-report-include-clocking-task}.
8789 @vindex org-agenda-clock-consistency-checks
8790 Show overlapping clock entries, clocking gaps, and other clocking problems in
8791 the current agenda range. You can then visit clocking lines and fix them
8792 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8793 information on how to customize the definition of what constituted a clocking
8794 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8797 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8798 @vindex org-agenda-start-with-entry-text-mode
8799 @vindex org-agenda-entry-text-maxlines
8800 Toggle entry text mode. In entry text mode, a number of lines from the Org
8801 outline node referenced by an agenda line will be displayed below the line.
8802 The maximum number of lines is given by the variable
8803 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8804 prefix argument will temporarily modify that number to the prefix value.
8806 @orgcmd{G,org-agenda-toggle-time-grid}
8807 @vindex org-agenda-use-time-grid
8808 @vindex org-agenda-time-grid
8809 Toggle the time grid on and off. See also the variables
8810 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8812 @orgcmd{r,org-agenda-redo}
8813 Recreate the agenda buffer, for example to reflect the changes after
8814 modification of the timestamps of items with @kbd{S-@key{left}} and
8815 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8816 argument is interpreted to create a selective list for a specific TODO
8818 @orgcmd{g,org-agenda-redo}
8821 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8822 Save all Org buffers in the current Emacs session, and also the locations of
8825 @orgcmd{C-c C-x C-c,org-agenda-columns}
8826 @vindex org-columns-default-format
8827 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8828 view format is taken from the entry at point, or (if there is no entry at
8829 point), from the first entry in the agenda view. So whatever the format for
8830 that entry would be in the original buffer (taken from a property, from a
8831 @code{#+COLUMNS} line, or from the default variable
8832 @code{org-columns-default-format}), will be used in the agenda.
8834 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8835 Remove the restriction lock on the agenda, if it is currently restricted to a
8836 file or subtree (@pxref{Agenda files}).
8838 @tsubheading{Secondary filtering and query editing}
8840 For a detailed description of these commands, see @pxref{Filtering/limiting
8843 @orgcmd{/,org-agenda-filter-by-tag}
8844 @vindex org-agenda-tag-filter-preset
8845 Filter the agenda view with respect to a tag and/or effort estimates.
8847 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8848 Narrow the current agenda filter by an additional condition.
8850 @orgcmd{<,org-agenda-filter-by-category}
8851 @vindex org-agenda-category-filter-preset
8853 Filter the current agenda view with respect to the category of the item at
8854 point. Pressing @code{<} another time will remove this filter.
8856 @orgcmd{^,org-agenda-filter-by-top-headline}
8857 Filter the current agenda view and only display the siblings and the parent
8858 headline of the one at point.
8860 @orgcmd{=,org-agenda-filter-by-regexp}
8861 @vindex org-agenda-regexp-filter-preset
8863 Filter the agenda view by a regular expression: only show agenda entries
8864 matching the regular expression the user entered. When called with a prefix
8865 argument, it will filter @emph{out} entries matching the regexp. With two
8866 universal prefix arguments, it will remove all the regexp filters, which can
8867 be accumulated. You can add a filter preset through the option
8868 @code{org-agenda-category-filter-preset} (see below.)
8870 @orgcmd{|,org-agenda-filter-remove-all}
8871 Remove all filters in the current agenda view.
8873 @tsubheading{Remote editing}
8874 @cindex remote editing, from agenda
8879 @cindex undoing remote-editing events
8880 @cindex remote editing, undo
8881 @orgcmd{C-_,org-agenda-undo}
8882 Undo a change due to a remote editing command. The change is undone
8883 both in the agenda buffer and in the remote buffer.
8885 @orgcmd{t,org-agenda-todo}
8886 Change the TODO state of the item, both in the agenda and in the
8889 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8890 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8891 Switch to the next/previous set of TODO keywords.
8893 @orgcmd{C-k,org-agenda-kill}
8894 @vindex org-agenda-confirm-kill
8895 Delete the current agenda item along with the entire subtree belonging
8896 to it in the original Org file. If the text to be deleted remotely
8897 is longer than one line, the kill needs to be confirmed by the user. See
8898 variable @code{org-agenda-confirm-kill}.
8900 @orgcmd{C-c C-w,org-agenda-refile}
8901 Refile the entry at point.
8903 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8904 @vindex org-archive-default-command
8905 Archive the subtree corresponding to the entry at point using the default
8906 archiving command set in @code{org-archive-default-command}. When using the
8907 @code{a} key, confirmation will be required.
8909 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8910 Toggle the ARCHIVE tag for the current headline.
8912 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8913 Move the subtree corresponding to the current entry to its @emph{archive
8916 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8917 Archive the subtree corresponding to the current headline. This means the
8918 entry will be moved to the configured archive location, most likely a
8921 @orgcmd{T,org-agenda-show-tags}
8922 @vindex org-agenda-show-inherited-tags
8923 Show all tags associated with the current item. This is useful if you have
8924 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8925 tags of a headline occasionally.
8927 @orgcmd{:,org-agenda-set-tags}
8928 Set tags for the current headline. If there is an active region in the
8929 agenda, change a tag for all headings in the region.
8933 Set the priority for the current item (@command{org-agenda-priority}).
8934 Org mode prompts for the priority character. If you reply with @key{SPC},
8935 the priority cookie is removed from the entry.
8937 @orgcmd{P,org-agenda-show-priority}
8938 Display weighted priority of current item.
8940 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8941 Increase the priority of the current item. The priority is changed in
8942 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8945 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8946 Decrease the priority of the current item.
8948 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8949 @vindex org-log-into-drawer
8950 Add a note to the entry. This note will be recorded, and then filed to the
8951 same location where state change notes are put. Depending on
8952 @code{org-log-into-drawer}, this may be inside a drawer.
8954 @orgcmd{C-c C-a,org-attach}
8955 Dispatcher for all command related to attachments.
8957 @orgcmd{C-c C-s,org-agenda-schedule}
8958 Schedule this item. With prefix arg remove the scheduling timestamp
8960 @orgcmd{C-c C-d,org-agenda-deadline}
8961 Set a deadline for this item. With prefix arg remove the deadline.
8963 @orgcmd{S-@key{right},org-agenda-do-date-later}
8964 Change the timestamp associated with the current line by one day into the
8965 future. If the date is in the past, the first call to this command will move
8967 With a numeric prefix argument, change it by that many days. For example,
8968 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8969 change the time by one hour. If you immediately repeat the command, it will
8970 continue to change hours even without the prefix arg. With a double @kbd{C-u
8971 C-u} prefix, do the same for changing minutes.@*
8972 The stamp is changed in the original Org file, but the change is not directly
8973 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8975 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8976 Change the timestamp associated with the current line by one day
8979 @orgcmd{>,org-agenda-date-prompt}
8980 Change the timestamp associated with the current line. The key @kbd{>} has
8981 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8983 @orgcmd{I,org-agenda-clock-in}
8984 Start the clock on the current item. If a clock is running already, it
8987 @orgcmd{O,org-agenda-clock-out}
8988 Stop the previously started clock.
8990 @orgcmd{X,org-agenda-clock-cancel}
8991 Cancel the currently running clock.
8993 @orgcmd{J,org-agenda-clock-goto}
8994 Jump to the running clock in another window.
8996 @orgcmd{k,org-agenda-capture}
8997 Like @code{org-capture}, but use the date at point as the default date for
8998 the capture template. See @code{org-capture-use-agenda-date} to make this
8999 the default behavior of @code{org-capture}.
9000 @cindex capturing, from agenda
9001 @vindex org-capture-use-agenda-date
9003 @tsubheading{Dragging agenda lines forward/backward}
9004 @cindex dragging, agenda lines
9006 @orgcmd{M-<up>,org-agenda-drag-line-backward}
9007 Drag the line at point backward one line@footnote{Moving agenda lines does
9008 not persist after an agenda refresh and does not modify the contributing
9009 @file{.org} files}. With a numeric prefix argument, drag backward by that
9012 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9013 Drag the line at point forward one line. With a numeric prefix argument,
9014 drag forward by that many lines.
9016 @tsubheading{Bulk remote editing selected entries}
9017 @cindex remote editing, bulk, from agenda
9018 @vindex org-agenda-bulk-custom-functions
9020 @orgcmd{m,org-agenda-bulk-mark}
9021 Mark the entry at point for bulk action. With numeric prefix argument, mark
9022 that many successive entries.
9024 @orgcmd{*,org-agenda-bulk-mark-all}
9025 Mark all visible agenda entries for bulk action.
9027 @orgcmd{u,org-agenda-bulk-unmark}
9028 Unmark entry at point for bulk action.
9030 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9031 Unmark all marked entries for bulk action.
9033 @orgcmd{M-m,org-agenda-bulk-toggle}
9034 Toggle mark of the entry at point for bulk action.
9036 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9037 Toggle marks of all visible entries for bulk action.
9039 @orgcmd{%,org-agenda-bulk-mark-regexp}
9040 Mark entries matching a regular expression for bulk action.
9042 @orgcmd{B,org-agenda-bulk-action}
9043 Bulk action: act on all marked entries in the agenda. This will prompt for
9044 another key to select the action to be applied. The prefix arg to @kbd{B}
9045 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9046 these special timestamps. By default, marks are removed after the bulk. If
9047 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
9048 @code{t} or hit @kbd{p} at the prompt.
9052 Toggle persistent marks.
9054 Archive all selected entries.
9056 Archive entries by moving them to their respective archive siblings.
9058 Change TODO state. This prompts for a single TODO keyword and changes the
9059 state of all selected entries, bypassing blocking and suppressing logging
9060 notes (but not timestamps).
9062 Add a tag to all selected entries.
9064 Remove a tag from all selected entries.
9066 Schedule all items to a new date. To shift existing schedule dates by a
9067 fixed number of days, use something starting with double plus at the prompt,
9068 for example @samp{++8d} or @samp{++2w}.
9070 Set deadline to a specific date.
9072 Prompt for a single refile target and move all entries. The entries will no
9073 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9075 Reschedule randomly into the coming N days. N will be prompted for. With
9076 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9078 Apply a function@footnote{You can also create persistent custom functions
9079 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
9080 example, the function below sets the CATEGORY property of the entries to web.
9084 (defun set-category ()
9086 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9087 (org-agenda-error)))
9088 (buffer (marker-buffer marker)))
9089 (with-current-buffer buffer
9094 (org-back-to-heading t)
9095 (org-set-property "CATEGORY" "web"))))))
9100 @tsubheading{Calendar commands}
9101 @cindex calendar commands, from agenda
9103 @orgcmd{c,org-agenda-goto-calendar}
9104 Open the Emacs calendar and move to the date at the agenda cursor.
9106 @orgcmd{c,org-calendar-goto-agenda}
9107 When in the calendar, compute and show the Org mode agenda for the
9110 @cindex diary entries, creating from agenda
9111 @orgcmd{i,org-agenda-diary-entry}
9112 @vindex org-agenda-diary-file
9113 Insert a new entry into the diary, using the date at the cursor and (for
9114 block entries) the date at the mark. This will add to the Emacs diary
9115 file@footnote{This file is parsed for the agenda when
9116 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9117 command in the calendar. The diary file will pop up in another window, where
9118 you can add the entry.
9120 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9121 Org will create entries (in Org mode syntax) in that file instead. Most
9122 entries will be stored in a date-based outline tree that will later make it
9123 easy to archive appointments from previous months/years. The tree will be
9124 built under an entry with a @code{DATE_TREE} property, or else with years as
9125 top-level entries. Emacs will prompt you for the entry text---if you specify
9126 it, the entry will be created in @code{org-agenda-diary-file} without further
9127 interaction. If you directly press @key{RET} at the prompt without typing
9128 text, the target file will be shown in another window for you to finish the
9129 entry there. See also the @kbd{k r} command.
9131 @orgcmd{M,org-agenda-phases-of-moon}
9132 Show the phases of the moon for the three months around current date.
9134 @orgcmd{S,org-agenda-sunrise-sunset}
9135 Show sunrise and sunset times. The geographical location must be set
9136 with calendar variables, see the documentation for the Emacs calendar.
9138 @orgcmd{C,org-agenda-convert-date}
9139 Convert the date at cursor into many other cultural and historic
9142 @orgcmd{H,org-agenda-holidays}
9143 Show holidays for three months around the cursor date.
9145 @item M-x org-icalendar-combine-agenda-files RET
9146 Export a single iCalendar file containing entries from all agenda files.
9147 This is a globally available command, and also available in the agenda menu.
9149 @tsubheading{Exporting to a file}
9150 @orgcmd{C-x C-w,org-agenda-write}
9151 @cindex exporting agenda views
9152 @cindex agenda views, exporting
9153 @vindex org-agenda-exporter-settings
9154 Write the agenda view to a file. Depending on the extension of the selected
9155 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9156 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9157 (any other extension). When exporting to Org, only the body of original
9158 headlines are exported, not subtrees or inherited tags. When called with a
9159 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9160 variable @code{org-agenda-exporter-settings} to set options for
9161 @file{ps-print} and for @file{htmlize} to be used during export.
9163 @tsubheading{Quit and Exit}
9164 @orgcmd{q,org-agenda-quit}
9165 Quit agenda, remove the agenda buffer.
9167 @cindex agenda files, removing buffers
9168 @orgcmd{x,org-agenda-exit}
9169 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9170 for the compilation of the agenda. Buffers created by the user to
9171 visit Org files will not be removed.
9175 @node Custom agenda views
9176 @section Custom agenda views
9177 @cindex custom agenda views
9178 @cindex agenda views, custom
9180 Custom agenda commands serve two purposes: to store and quickly access
9181 frequently used TODO and tags searches, and to create special composite
9182 agenda buffers. Custom agenda commands will be accessible through the
9183 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9186 * Storing searches:: Type once, use often
9187 * Block agenda:: All the stuff you need in a single buffer
9188 * Setting options:: Changing the rules
9191 @node Storing searches
9192 @subsection Storing searches
9194 The first application of custom searches is the definition of keyboard
9195 shortcuts for frequently used searches, either creating an agenda
9196 buffer, or a sparse tree (the latter covering of course only the current
9199 @vindex org-agenda-custom-commands
9200 @cindex agenda views, main example
9201 @cindex agenda, as an agenda views
9202 @cindex agenda*, as an agenda views
9203 @cindex tags, as an agenda view
9204 @cindex todo, as an agenda view
9210 Custom commands are configured in the variable
9211 @code{org-agenda-custom-commands}. You can customize this variable, for
9212 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9213 Lisp in @file{.emacs}. The following example contains all valid agenda
9218 (setq org-agenda-custom-commands
9221 ("w" todo "WAITING")
9222 ("W" todo-tree "WAITING")
9223 ("u" tags "+boss-urgent")
9224 ("v" tags-todo "+boss-urgent")
9225 ("U" tags-tree "+boss-urgent")
9226 ("f" occur-tree "\\<FIXME\\>")
9227 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9228 ("hl" tags "+home+Lisa")
9229 ("hp" tags "+home+Peter")
9230 ("hk" tags "+home+Kim")))
9235 The initial string in each entry defines the keys you have to press
9236 after the dispatcher command @kbd{C-c a} in order to access the command.
9237 Usually this will be just a single character, but if you have many
9238 similar commands, you can also define two-letter combinations where the
9239 first character is the same in several combinations and serves as a
9240 prefix key@footnote{You can provide a description for a prefix key by
9241 inserting a cons cell with the prefix and the description.}. The second
9242 parameter is the search type, followed by the string or regular
9243 expression to be used for the matching. The example above will
9248 as a global search for agenda entries planned@footnote{@emph{Planned} means
9249 here that these entries have some planning information attached to them, like
9250 a time-stamp, a scheduled or a deadline string. See
9251 @code{org-agenda-entry-types} on how to set what planning information will be
9252 taken into account.} this week/day.
9254 as a global search for agenda entries planned this week/day, but only those
9255 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9257 as a global search for TODO entries with @samp{WAITING} as the TODO
9260 as the same search, but only in the current buffer and displaying the
9261 results as a sparse tree
9263 as a global tags search for headlines marked @samp{:boss:} but not
9266 as the same search as @kbd{C-c a u}, but limiting the search to
9267 headlines that are also TODO items
9269 as the same search as @kbd{C-c a u}, but only in the current buffer and
9270 displaying the result as a sparse tree
9272 to create a sparse tree (again: current buffer only) with all entries
9273 containing the word @samp{FIXME}
9275 as a prefix command for a HOME tags search where you have to press an
9276 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9277 Peter, or Kim) as additional tag to match.
9280 Note that the @code{*-tree} agenda views need to be called from an
9281 Org buffer as they operate on the current buffer only.
9284 @subsection Block agenda
9285 @cindex block agenda
9286 @cindex agenda, with block views
9288 Another possibility is the construction of agenda views that comprise
9289 the results of @emph{several} commands, each of which creates a block in
9290 the agenda buffer. The available commands include @code{agenda} for the
9291 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9292 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9293 matching commands discussed above: @code{todo}, @code{tags}, and
9294 @code{tags-todo}. Here are two examples:
9298 (setq org-agenda-custom-commands
9299 '(("h" "Agenda and Home-related tasks"
9303 ("o" "Agenda and Office-related tasks"
9311 This will define @kbd{C-c a h} to create a multi-block view for stuff
9312 you need to attend to at home. The resulting agenda buffer will contain
9313 your agenda for the current week, all TODO items that carry the tag
9314 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9315 command @kbd{C-c a o} provides a similar view for office tasks.
9317 @node Setting options
9318 @subsection Setting options for custom commands
9319 @cindex options, for custom agenda views
9321 @vindex org-agenda-custom-commands
9322 Org mode contains a number of variables regulating agenda construction
9323 and display. The global variables define the behavior for all agenda
9324 commands, including the custom commands. However, if you want to change
9325 some settings just for a single custom view, you can do so. Setting
9326 options requires inserting a list of variable names and values at the
9327 right spot in @code{org-agenda-custom-commands}. For example:
9331 (setq org-agenda-custom-commands
9332 '(("w" todo "WAITING"
9333 ((org-agenda-sorting-strategy '(priority-down))
9334 (org-agenda-prefix-format " Mixed: ")))
9335 ("U" tags-tree "+boss-urgent"
9336 ((org-show-following-heading nil)
9337 (org-show-hierarchy-above nil)))
9339 ((org-agenda-files '("~org/notes.org"))
9340 (org-agenda-text-search-extra-files nil)))))
9345 Now the @kbd{C-c a w} command will sort the collected entries only by
9346 priority, and the prefix format is modified to just say @samp{ Mixed: }
9347 instead of giving the category of the entry. The sparse tags tree of
9348 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9349 headline hierarchy above the match, nor the headline following the match
9350 will be shown. The command @kbd{C-c a N} will do a text search limited
9351 to only a single file.
9353 @vindex org-agenda-custom-commands
9354 For command sets creating a block agenda,
9355 @code{org-agenda-custom-commands} has two separate spots for setting
9356 options. You can add options that should be valid for just a single
9357 command in the set, and options that should be valid for all commands in
9358 the set. The former are just added to the command entry; the latter
9359 must come after the list of command entries. Going back to the block
9360 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9361 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9362 the results for GARDEN tags query in the opposite order,
9363 @code{priority-up}. This would look like this:
9367 (setq org-agenda-custom-commands
9368 '(("h" "Agenda and Home-related tasks"
9372 ((org-agenda-sorting-strategy '(priority-up)))))
9373 ((org-agenda-sorting-strategy '(priority-down))))
9374 ("o" "Agenda and Office-related tasks"
9381 As you see, the values and parentheses setting is a little complex.
9382 When in doubt, use the customize interface to set this variable---it
9383 fully supports its structure. Just one caveat: when setting options in
9384 this interface, the @emph{values} are just Lisp expressions. So if the
9385 value is a string, you need to add the double-quotes around the value
9388 @vindex org-agenda-custom-commands-contexts
9389 To control whether an agenda command should be accessible from a specific
9390 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9391 say for example that you have an agenda command @code{"o"} displaying a view
9392 that you only need when reading emails. Then you would configure this option
9396 (setq org-agenda-custom-commands-contexts
9397 '(("o" (in-mode . "message-mode"))))
9400 You can also tell that the command key @code{"o"} should refer to another
9401 command key @code{"r"}. In that case, add this command key like this:
9404 (setq org-agenda-custom-commands-contexts
9405 '(("o" "r" (in-mode . "message-mode"))))
9408 See the docstring of the variable for more information.
9410 @node Exporting agenda views
9411 @section Exporting agenda views
9412 @cindex agenda views, exporting
9414 If you are away from your computer, it can be very useful to have a printed
9415 version of some agenda views to carry around. Org mode can export custom
9416 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9417 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9418 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9419 a PDF file will also create the postscript file.}, and iCalendar files. If
9420 you want to do this only occasionally, use the command
9423 @orgcmd{C-x C-w,org-agenda-write}
9424 @cindex exporting agenda views
9425 @cindex agenda views, exporting
9426 @vindex org-agenda-exporter-settings
9427 Write the agenda view to a file. Depending on the extension of the selected
9428 file name, the view will be exported as HTML (extension @file{.html} or
9429 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9430 @file{.ics}), or plain text (any other extension). Use the variable
9431 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9432 for @file{htmlize} to be used during export, for example
9434 @vindex org-agenda-add-entry-text-maxlines
9435 @vindex htmlize-output-type
9436 @vindex ps-number-of-columns
9437 @vindex ps-landscape-mode
9439 (setq org-agenda-exporter-settings
9440 '((ps-number-of-columns 2)
9441 (ps-landscape-mode t)
9442 (org-agenda-add-entry-text-maxlines 5)
9443 (htmlize-output-type 'css)))
9447 If you need to export certain agenda views frequently, you can associate
9448 any custom agenda command with a list of output file names
9449 @footnote{If you want to store standard views like the weekly agenda
9450 or the global TODO list as well, you need to define custom commands for
9451 them in order to be able to specify file names.}. Here is an example
9452 that first defines custom commands for the agenda and the global
9453 TODO list, together with a number of files to which to export them.
9454 Then we define two block agenda commands and specify file names for them
9455 as well. File names can be relative to the current working directory,
9460 (setq org-agenda-custom-commands
9461 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9462 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9463 ("h" "Agenda and Home-related tasks"
9468 ("~/views/home.html"))
9469 ("o" "Agenda and Office-related tasks"
9474 ("~/views/office.ps" "~/calendars/office.ics"))))
9478 The extension of the file name determines the type of export. If it is
9479 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9480 the buffer to HTML and save it to this file name. If the extension is
9481 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9482 Postscript output. If the extension is @file{.ics}, iCalendar export is
9483 run export over all files that were used to construct the agenda, and
9484 limit the export to entries listed in the agenda. Any other
9485 extension produces a plain ASCII file.
9487 The export files are @emph{not} created when you use one of those
9488 commands interactively because this might use too much overhead.
9489 Instead, there is a special command to produce @emph{all} specified
9493 @orgcmd{C-c a e,org-store-agenda-views}
9494 Export all agenda views that have export file names associated with
9498 You can use the options section of the custom agenda commands to also
9499 set options for the export commands. For example:
9502 (setq org-agenda-custom-commands
9504 ((ps-number-of-columns 2)
9505 (ps-landscape-mode t)
9506 (org-agenda-prefix-format " [ ] ")
9507 (org-agenda-with-colors nil)
9508 (org-agenda-remove-tags t))
9513 This command sets two options for the Postscript exporter, to make it
9514 print in two columns in landscape format---the resulting page can be cut
9515 in two and then used in a paper agenda. The remaining settings modify
9516 the agenda prefix to omit category and scheduling information, and
9517 instead include a checkbox to check off items. We also remove the tags
9518 to make the lines compact, and we don't want to use colors for the
9519 black-and-white printer. Settings specified in
9520 @code{org-agenda-exporter-settings} will also apply, but the settings
9521 in @code{org-agenda-custom-commands} take precedence.
9524 From the command line you may also use
9526 emacs -eval (org-batch-store-agenda-views) -kill
9529 or, if you need to modify some parameters@footnote{Quoting depends on the
9530 system you use, please check the FAQ for examples.}
9532 emacs -eval '(org-batch-store-agenda-views \
9533 org-agenda-span (quote month) \
9534 org-agenda-start-day "2007-11-01" \
9535 org-agenda-include-diary nil \
9536 org-agenda-files (quote ("~/org/project.org")))' \
9540 which will create the agenda views restricted to the file
9541 @file{~/org/project.org}, without diary entries and with a 30-day
9544 You can also extract agenda information in a way that allows further
9545 processing by other programs. See @ref{Extracting agenda information}, for
9549 @node Agenda column view
9550 @section Using column view in the agenda
9551 @cindex column view, in agenda
9552 @cindex agenda, column view
9554 Column view (@pxref{Column view}) is normally used to view and edit
9555 properties embedded in the hierarchical structure of an Org file. It can be
9556 quite useful to use column view also from the agenda, where entries are
9557 collected by certain criteria.
9560 @orgcmd{C-c C-x C-c,org-agenda-columns}
9561 Turn on column view in the agenda.
9564 To understand how to use this properly, it is important to realize that the
9565 entries in the agenda are no longer in their proper outline environment.
9566 This causes the following issues:
9570 @vindex org-columns-default-format
9571 @vindex org-overriding-columns-format
9572 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9573 entries in the agenda are collected from different files, and different files
9574 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9575 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9576 currently set, and if so, takes the format from there. Otherwise it takes
9577 the format associated with the first item in the agenda, or, if that item
9578 does not have a specific format (defined in a property, or in its file), it
9579 uses @code{org-columns-default-format}.
9581 @cindex property, special, CLOCKSUM
9582 If any of the columns has a summary type defined (@pxref{Column attributes}),
9583 turning on column view in the agenda will visit all relevant agenda files and
9584 make sure that the computations of this property are up to date. This is
9585 also true for the special @code{CLOCKSUM} property. Org will then sum the
9586 values displayed in the agenda. In the daily/weekly agenda, the sums will
9587 cover a single day; in all other views they cover the entire block. It is
9588 vital to realize that the agenda may show the same entry @emph{twice} (for
9589 example as scheduled and as a deadline), and it may show two entries from the
9590 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9591 cases, the summation in the agenda will lead to incorrect results because
9592 some values will count double.
9594 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9595 the entire clocked time for this item. So even in the daily/weekly agenda,
9596 the clocksum listed in column view may originate from times outside the
9597 current view. This has the advantage that you can compare these values with
9598 a column listing the planned total effort for a task---one of the major
9599 applications for column view in the agenda. If you want information about
9600 clocked time in the displayed period use clock table mode (press @kbd{R} in
9604 @cindex property, special, CLOCKSUM_T
9605 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9606 always today's clocked time for this item. So even in the weekly agenda,
9607 the clocksum listed in column view only originates from today. This lets
9608 you compare the time you spent on a task for today, with the time already
9609 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9614 @chapter Markup for rich export
9616 When exporting Org mode documents, the exporter tries to reflect the
9617 structure of the document as accurately as possible in the back-end. Since
9618 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9619 rules on how to prepare text for rich export. This section summarizes the
9620 markup rules used in an Org mode buffer.
9623 * Structural markup elements:: The basic structure as seen by the exporter
9624 * Images and tables:: Images, tables and caption mechanism
9625 * Literal examples:: Source code examples with special formatting
9626 * Include files:: Include additional files into a document
9627 * Index entries:: Making an index
9628 * Macro replacement:: Use macros to create templates
9629 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9630 * Special blocks:: Containers targeted at export back-ends
9633 @node Structural markup elements
9634 @section Structural markup elements
9637 * Document title:: Where the title is taken from
9638 * Headings and sections:: The document structure as seen by the exporter
9639 * Table of contents:: The if and where of the table of contents
9641 * Paragraphs:: Paragraphs
9642 * Footnote markup:: Footnotes
9643 * Emphasis and monospace:: Bold, italic, etc.
9644 * Horizontal rules:: Make a line
9645 * Comment lines:: What will *not* be exported
9648 @node Document title
9649 @subheading Document title
9650 @cindex document title, markup rules
9653 The title of the exported document is taken from the special line
9657 #+TITLE: This is the title of the document
9660 @cindex property, EXPORT_TITLE
9661 If you are exporting only a subtree, its heading will become the title of the
9662 document. If the subtree has a property @code{EXPORT_TITLE}, that will take
9665 @node Headings and sections
9666 @subheading Headings and sections
9667 @cindex headings and sections, markup rules
9669 @vindex org-export-headline-levels
9670 The outline structure of the document as described in @ref{Document
9671 structure}, forms the basis for defining sections of the exported document.
9672 However, since the outline structure is also used for (for example) lists of
9673 tasks, only the first three outline levels will be used as headings. Deeper
9674 levels will become itemized lists. You can change the location of this
9675 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9676 per-file basis with a line
9683 @node Table of contents
9684 @subheading Table of contents
9685 @cindex table of contents, markup rules
9688 @vindex org-export-with-toc
9689 The table of contents is normally inserted directly before the first headline
9690 of the file. The depth of the table is by default the same as the number of
9691 headline levels, but you can choose a smaller number, or turn off the table
9692 of contents entirely, by configuring the variable @code{org-export-with-toc},
9693 or on a per-file basis with a line like
9696 #+OPTIONS: toc:2 (only to two levels in TOC)
9697 #+OPTIONS: toc:nil (no default TOC at all)
9700 If you would like to move the table of contents to a different location, you
9701 should turn off the default table using @code{org-export-with-toc} or
9702 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9706 #+OPTIONS: toc:nil (no default TOC)
9708 #+TOC: headlines 2 (insert TOC here, with two headline levels)
9711 Multiple @code{#+TOC: headline} lines are allowed. The same @code{TOC}
9712 keyword can also generate a list of all tables (resp.@: all listings) with a
9713 caption in the buffer.
9716 #+TOC: listings (build a list of listings)
9717 #+TOC: tables (build a list of tables)
9720 @cindex property, ALT_TITLE
9721 The headline's title usually determines its corresponding entry in a table of
9722 contents. However, it is possible to specify an alternative title by
9723 setting @code{ALT_TITLE} property accordingly. It will then be used when
9728 @cindex lists, markup rules
9730 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9731 syntax for such lists. Most back-ends support unordered, ordered, and
9735 @subheading Paragraphs, line breaks, and quoting
9736 @cindex paragraphs, markup rules
9738 Paragraphs are separated by at least one empty line. If you need to enforce
9739 a line break within a paragraph, use @samp{\\} at the end of a line.
9741 To keep the line breaks in a region, but otherwise use normal formatting, you
9742 can use this construct, which can also be used to format poetry.
9744 @cindex #+BEGIN_VERSE
9747 Great clouds overhead
9748 Tiny black birds rise and fall
9755 When quoting a passage from another document, it is customary to format this
9756 as a paragraph that is indented on both the left and the right margin. You
9757 can include quotations in Org mode documents like this:
9759 @cindex #+BEGIN_QUOTE
9762 Everything should be made as simple as possible,
9763 but not any simpler -- Albert Einstein
9767 If you would like to center some text, do it like this:
9768 @cindex #+BEGIN_CENTER
9771 Everything should be made as simple as possible, \\
9777 @node Footnote markup
9778 @subheading Footnote markup
9779 @cindex footnotes, markup rules
9780 @cindex @file{footnote.el}
9782 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9783 by all back-ends. Org allows multiple references to the same note, and
9784 multiple footnotes side by side.
9786 @node Emphasis and monospace
9787 @subheading Emphasis and monospace
9789 @cindex underlined text, markup rules
9790 @cindex bold text, markup rules
9791 @cindex italic text, markup rules
9792 @cindex verbatim text, markup rules
9793 @cindex code text, markup rules
9794 @cindex strike-through text, markup rules
9795 @vindex org-fontify-emphasized-text
9796 @vindex org-emphasis-regexp-components
9797 @vindex org-emphasis-alist
9798 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9799 and @code{~code~}, and, if you must, @samp{+strike-through+}. Text
9800 in the code and verbatim string is not processed for Org mode specific
9801 syntax, it is exported verbatim.
9803 To turn off fontification for marked up text, you can set
9804 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9805 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9806 tune what characters are allowed before and after the markup characters, you
9807 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9808 the above variables will no take effect until you reload Org, for which you
9809 may need to restart Emacs.
9811 @node Horizontal rules
9812 @subheading Horizontal rules
9813 @cindex horizontal rules, markup rules
9814 A line consisting of only dashes, and at least 5 of them, will be exported as
9818 @subheading Comment lines
9819 @cindex comment lines
9820 @cindex exporting, not
9821 @cindex #+BEGIN_COMMENT
9823 Lines starting with zero or more whitespace characters followed by one
9824 @samp{#} and a whitespace are treated as comments and, as such, are not
9827 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9828 ... @samp{#+END_COMMENT} are not exported.
9830 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9831 other keyword or priority cookie, comments out the entire subtree. In this
9832 case, the subtree is not exported and no code block within it is executed
9833 either. The command below helps changing the comment status of a headline.
9838 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9842 @node Images and tables
9843 @section Images and Tables
9845 @cindex tables, markup rules
9848 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9849 the @file{table.el} package will be exported properly. For Org mode tables,
9850 the lines before the first horizontal separator line will become table header
9851 lines. You can use the following lines somewhere before the table to assign
9852 a caption and a label for cross references, and in the text you can refer to
9853 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9856 #+CAPTION: This is the caption for the next table (or link)
9857 #+NAME: tab:basic-data
9862 Optionally, the caption can take the form:
9864 #+CAPTION[Caption for list of tables]: Caption for table.
9867 @cindex inlined images, markup rules
9868 Some back-ends allow you to directly include images into the exported
9869 document. Org does this, if a link to an image files does not have
9870 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9871 define a caption for the image and maybe a label for internal cross
9872 references, make sure that the link is on a line by itself and precede it
9873 with @code{#+CAPTION} and @code{#+NAME} as follows:
9876 #+CAPTION: This is the caption for the next figure link (or table)
9877 #+NAME: fig:SED-HR4049
9882 Such images can be displayed within the buffer. @xref{Handling links,the
9883 discussion of image links}.
9885 Even though images and tables are prominent examples of captioned structures,
9886 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9887 equations, source code blocks). Depending on the export back-end, those may
9888 or may not be handled.
9890 @node Literal examples
9891 @section Literal examples
9892 @cindex literal examples, markup rules
9893 @cindex code line references, markup rules
9895 You can include literal examples that should not be subjected to
9896 markup. Such examples will be typeset in monospace, so this is well suited
9897 for source code and similar examples.
9898 @cindex #+BEGIN_EXAMPLE
9902 Some example from a text file.
9906 Note that such blocks may be @i{indented} in order to align nicely with
9907 indented text and in particular with plain list structure (@pxref{Plain
9908 lists}). For simplicity when using small examples, you can also start the
9909 example lines with a colon followed by a space. There may also be additional
9910 whitespace before the colon:
9914 : Some example from a text file.
9917 @cindex formatting source code, markup rules
9918 @vindex org-latex-listings
9919 If the example is source code from a programming language, or any other text
9920 that can be marked up by font-lock in Emacs, you can ask for the example to
9921 look like the fontified Emacs buffer@footnote{This works automatically for
9922 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9923 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9924 achieved using either the listings or the
9925 @url{http://code.google.com/p/minted, minted,} package. Refer to
9926 @code{org-latex-listings} documentation for details.}. This is done
9927 with the @samp{src} block, where you also need to specify the name of the
9928 major mode that should be used to fontify the example@footnote{Code in
9929 @samp{src} blocks may also be evaluated either interactively or on export.
9930 See @pxref{Working with source code} for more information on evaluating code
9931 blocks.}, see @ref{Easy templates} for shortcuts to easily insert code
9936 #+BEGIN_SRC emacs-lisp
9937 (defun org-xor (a b)
9943 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9944 switch to the end of the @code{BEGIN} line, to get the lines of the example
9945 numbered. If you use a @code{+n} switch, the numbering from the previous
9946 numbered snippet will be continued in the current one. In literal examples,
9947 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9948 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9949 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9950 link will remote-highlight the corresponding code line, which is kind of
9953 You can also add a @code{-r} switch which @i{removes} the labels from the
9954 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9955 labels in the source code while using line numbers for the links, which might
9956 be useful to explain those in an Org mode example code.}. With the @code{-n}
9957 switch, links to these references will be labeled by the line numbers from
9958 the code listing, otherwise links will use the labels with no parentheses.
9962 #+BEGIN_SRC emacs-lisp -n -r
9963 (save-excursion (ref:sc)
9964 (goto-char (point-min))) (ref:jump)
9966 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9970 @cindex indentation, in source blocks
9971 Finally, you can use @code{-i} to preserve the indentation of a specific code
9972 block (@pxref{Editing source code}).
9974 @vindex org-coderef-label-format
9975 If the syntax for the label format conflicts with the language syntax, use a
9976 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9977 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9979 HTML export also allows examples to be published as text areas (@pxref{Text
9980 areas in HTML export}).
9982 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9983 so often, shortcuts are provided using the Easy templates facility
9984 (@pxref{Easy templates}).
9989 Edit the source code example at point in its native mode. This works by
9990 switching to a temporary buffer with the source code. You need to exit by
9991 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9992 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9993 from being interpreted by Org as outline nodes or special syntax. These
9994 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9995 The edited version will then replace the old version in the Org buffer.
9996 Fixed-width regions (where each line starts with a colon followed by a space)
9997 will be edited using @code{artist-mode}@footnote{You may select
9998 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9999 to allow creating ASCII drawings easily. Using this command in an empty line
10000 will create a new fixed-width region.
10003 Calling @code{org-store-link} while editing a source code example in a
10004 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
10005 that it is unique in the current buffer, and insert it with the proper
10006 formatting like @samp{(ref:label)} at the end of the current line. Then the
10007 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
10011 @node Include files
10012 @section Include files
10013 @cindex include files, markup rules
10015 During export, you can include the content of another file. For example, to
10016 include your @file{.emacs} file, you could use:
10020 #+INCLUDE: "~/.emacs" src emacs-lisp
10024 The first parameter names the the file to include. The optional second and
10025 third parameter specify the markup (i.e., @samp{example} or @samp{src}), and,
10026 if the markup is @samp{src}, the language for formatting the contents.
10028 If markup is requested, the included content will be placed within an
10029 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10030 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10031 of content that is permissible}. No changes to the included content are made
10032 and it is the responsibility of the user to ensure that the result is valid
10033 Org syntax. For markup @samp{example} and @samp{src}, which is requesting a
10034 literal example, the content will be code-escaped before inclusion.
10036 If no markup is requested, the text will be assumed to be in Org mode format
10037 and will be processed normally. However, footnote labels (@pxref{Footnotes})
10038 in the file will be made local to that file. Contents of the included file
10039 will belong to the same structure (headline, item) containing the
10040 @code{INCLUDE} keyword. In particular, headlines within the file will become
10041 children of the current section. That behavior can be changed by providing
10042 an additional keyword parameter, @code{:minlevel}. In that case, all
10043 headlines in the included file will be shifted so the one with the lowest
10044 level reaches that specified level. For example, to make a file become a
10045 sibling of the current top-level headline, use
10048 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10051 You can also include a portion of a file by specifying a lines range using
10052 the @code{:lines} keyword parameter. The line at the upper end of the range
10053 will not be included. The start and/or the end of the range may be omitted
10054 to use the obvious defaults.
10057 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
10058 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
10059 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
10062 Finally, you may use a file-link to extract an object as matched by
10063 @code{org-link-search}@footnote{Note that
10064 @code{org-link-search-must-match-exact-headline} is locally bound to non-nil.
10065 Therefore, @code{org-link-search} only matches headlines and named elements.}
10066 (@pxref{Search options}). If the @code{:only-contents} property is non-nil,
10067 only the contents of the requested element will be included, omitting
10068 properties drawer and planning-line if present. The @code{:lines} keyword
10069 operates locally with respect to the requested element. Some examples:
10072 #+INCLUDE: "./paper.org::#theory" :only-contents t
10073 @r{Include the body of the heading with the custom id @code{theory}}
10074 #+INCLUDE: "./paper.org::mytable" @r{Include named element.}
10075 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10076 @r{Include the first 20 lines of the headline named conclusion.}
10082 Visit the include file at point.
10085 @node Index entries
10086 @section Index entries
10087 @cindex index entries, for publishing
10089 You can specify entries that will be used for generating an index during
10090 publishing. This is done by lines starting with @code{#+INDEX}. An entry
10091 the contains an exclamation mark will create a sub item. See @ref{Generating
10092 an index} for more information.
10097 #+INDEX: Application!CV
10103 @node Macro replacement
10104 @section Macro replacement
10105 @cindex macro replacement, during export
10108 You can define text snippets with
10111 #+MACRO: name replacement text $1, $2 are arguments
10114 @noindent which can be referenced
10115 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10116 commas within arguments have to be escaped with a backslash character.
10117 Conversely, backslash characters before a comma, and only them, need to be
10118 escaped with another backslash character.}.
10120 These references, called macros, can be inserted anywhere Org markup is
10121 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10122 They cannot be used within ordinary keywords (starting with @code{#+}) but
10123 are allowed in @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR} and
10126 In addition to user-defined macros, a set of already defined macros can be
10127 used: @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will
10128 reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
10129 similar lines. Also, @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10130 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
10131 and to the modification time of the file being exported, respectively.
10132 @var{FORMAT} should be a format string understood by
10133 @code{format-time-string}.
10135 The surrounding brackets can be made invisible by setting
10136 @code{org-hide-macro-markers} to @code{t}.
10138 Macro expansion takes place during the very beginning of the export process.
10141 @node Embedded @LaTeX{}
10142 @section Embedded @LaTeX{}
10143 @cindex @TeX{} interpretation
10144 @cindex @LaTeX{} interpretation
10146 Plain ASCII is normally sufficient for almost all note taking. Exceptions
10147 include scientific notes, which often require mathematical symbols and the
10148 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10149 Donald E. Knuth's @TeX{} system. Many of the features described here as
10150 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10151 distinction.} is widely used to typeset scientific documents. Org mode
10152 supports embedding @LaTeX{} code into its files, because many academics are
10153 used to writing and reading @LaTeX{} source code, and because it can be
10154 readily processed to produce pretty output for a number of export back-ends.
10157 * Special symbols:: Greek letters and other symbols
10158 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10159 * @LaTeX{} fragments:: Complex formulas made easy
10160 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10161 * CDLaTeX mode:: Speed up entering of formulas
10164 @node Special symbols
10165 @subsection Special symbols
10166 @cindex math symbols
10167 @cindex special symbols
10168 @cindex @TeX{} macros
10169 @cindex @LaTeX{} fragments, markup rules
10170 @cindex HTML entities
10171 @cindex @LaTeX{} entities
10173 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10174 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10175 for these symbols is available, just type @samp{\} and maybe a few letters,
10176 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10177 code, Org mode allows these symbols to be present without surrounding math
10178 delimiters, for example:
10181 Angles are written as Greek letters \alpha, \beta and \gamma.
10184 @vindex org-entities
10185 During export, these symbols will be transformed into the native format of
10186 the exporter back-end. Strings like @code{\alpha} will be exported as
10187 @code{α} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10188 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10189 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10190 like this: @samp{\Aacute@{@}stor}.
10192 A large number of entities is provided, with names taken from both HTML and
10193 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10194 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10195 @samp{...} are all converted into special commands creating hyphens of
10196 different lengths or a compact set of dots.
10198 If you would like to see entities displayed as UTF-8 characters, use the
10199 following command@footnote{You can turn this on by default by setting the
10200 variable @code{org-pretty-entities}, or on a per-file base with the
10201 @code{#+STARTUP} option @code{entitiespretty}.}:
10204 @cindex @code{entitiespretty}, STARTUP keyword
10207 Toggle display of entities as UTF-8 characters. This does not change the
10208 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10209 for display purposes only.
10212 @node Subscripts and superscripts
10213 @subsection Subscripts and superscripts
10215 @cindex superscript
10217 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10218 subscripts. Again, these can be used without embedding them in math-mode
10219 delimiters. To increase the readability of ASCII text, it is not necessary
10220 (but OK) to surround multi-character sub- and superscripts with curly braces.
10224 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10225 the sun is R_@{sun@} = 6.96 x 10^8 m.
10228 @vindex org-use-sub-superscripts
10229 If you write a text where the underscore is often used in a different
10230 context, Org's convention to always interpret these as subscripts can get in
10231 your way. Configure the variable @code{org-use-sub-superscripts} to change
10232 this convention. For example, when setting this variable to @code{@{@}},
10233 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10238 In addition to showing entities as UTF-8 characters, this command will also
10239 format sub- and superscripts in a WYSIWYM way.
10242 @node @LaTeX{} fragments
10243 @subsection @LaTeX{} fragments
10244 @cindex @LaTeX{} fragments
10246 @vindex org-format-latex-header
10247 Going beyond symbols and sub- and superscripts, a full formula language is
10248 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10249 to process these for several export back-ends. When exporting to @LaTeX{},
10250 the code is obviously left as it is. When exporting to HTML, Org can invoke
10251 the @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10252 HTML export}) to process and display the math@footnote{If you plan to use
10253 this regularly or on pages with significant page views, you should install
10254 @file{MathJax} on your own server in order to limit the load of our server.}.
10255 It can also process the mathematical expressions into images that can be
10256 displayed in a browser (see @pxref{Previewing @LaTeX{} fragments}).
10258 @LaTeX{} fragments don't need any special marking at all. The following
10259 snippets will be identified as @LaTeX{} source code:
10262 Environments of any kind@footnote{When @file{MathJax} is used, only the
10263 environments recognized by @file{MathJax} will be processed. When
10264 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10265 any @LaTeX{} environment will be handled.}. The only requirement is that the
10266 @code{\begin} statement appears on a new line, at the beginning of the line
10267 or after whitespaces only.
10269 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10270 currency specifications, single @samp{$} characters are only recognized as
10271 math delimiters if the enclosed text contains at most two line breaks, is
10272 directly attached to the @samp{$} characters with no whitespace in between,
10273 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10274 For the other delimiters, there is no such restriction, so when in doubt, use
10275 @samp{\(...\)} as inline math delimiters.
10278 @noindent For example:
10285 If $a^2=b$ and \( b=2 \), then the solution must be
10286 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10291 @c @vindex org-format-latex-options
10292 @c If you need any of the delimiter ASCII sequences for other purposes, you
10293 @c can configure the option @code{org-format-latex-options} to deselect the
10294 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10296 @vindex org-export-with-latex
10297 @LaTeX{} processing can be configured with the variable
10298 @code{org-export-with-latex}. The default setting is @code{t} which means
10299 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10300 You can also set this variable on a per-file basis using one of these
10304 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10305 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10306 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10309 @node Previewing @LaTeX{} fragments
10310 @subsection Previewing @LaTeX{} fragments
10311 @cindex @LaTeX{} fragments, preview
10313 @vindex org-latex-create-formula-image-program
10314 If you have a working @LaTeX{} installation and either @file{dvipng} or
10315 @file{convert} installed@footnote{These are respectively available at
10316 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10317 suite. Choose the converter by setting the variable
10318 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10319 fragments can be processed to produce images of the typeset expressions to be
10320 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10321 or for inline previewing within Org mode.
10323 @vindex org-format-latex-options
10324 @vindex org-format-latex-header
10325 You can customize the variables @code{org-format-latex-options} and
10326 @code{org-format-latex-header} to influence some aspects of the preview. In
10327 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10328 property of the former can be used to adjust the size of the preview images.
10331 @kindex C-c C-x C-l
10333 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10334 over the source code. If there is no fragment at point, process all
10335 fragments in the current entry (between two headlines). When called
10336 with a prefix argument, process the entire subtree. When called with
10337 two prefix arguments, or when the cursor is before the first headline,
10338 process the entire buffer.
10341 Remove the overlay preview images.
10344 @vindex org-startup-with-latex-preview
10345 You can turn on the previewing of all @LaTeX{} fragments in a file with
10348 #+STARTUP: latexpreview
10351 To disable it, simply use
10354 #+STARTUP: nolatexpreview
10358 @subsection Using CD@LaTeX{} to enter math
10361 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10362 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10363 environments and math templates. Inside Org mode, you can make use of
10364 some of the features of CD@LaTeX{} mode. You need to install
10365 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10366 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10367 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10368 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10369 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10373 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10376 When this mode is enabled, the following features are present (for more
10377 details see the documentation of CD@LaTeX{} mode):
10381 Environment templates can be inserted with @kbd{C-c @{}.
10384 The @key{TAB} key will do template expansion if the cursor is inside a
10385 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10386 inside such a fragment, see the documentation of the function
10387 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10388 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10389 correctly inside the first brace. Another @key{TAB} will get you into
10390 the second brace. Even outside fragments, @key{TAB} will expand
10391 environment abbreviations at the beginning of a line. For example, if
10392 you write @samp{equ} at the beginning of a line and press @key{TAB},
10393 this abbreviation will be expanded to an @code{equation} environment.
10394 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10398 @vindex cdlatex-simplify-sub-super-scripts
10399 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10400 characters together with a pair of braces. If you use @key{TAB} to move
10401 out of the braces, and if the braces surround only a single character or
10402 macro, they are removed again (depending on the variable
10403 @code{cdlatex-simplify-sub-super-scripts}).
10406 Pressing the backquote @kbd{`} followed by a character inserts math
10407 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10408 after the backquote, a help window will pop up.
10411 Pressing the single-quote @kbd{'} followed by another character modifies
10412 the symbol before point with an accent or a font. If you wait more than
10413 1.5 seconds after the single-quote, a help window will pop up. Character
10414 modification will work only inside @LaTeX{} fragments; outside the quote
10418 @node Special blocks
10419 @section Special blocks
10420 @cindex Special blocks
10422 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10423 examples}). It is also possible to create blocks containing raw code
10424 targeted at a specific back-end (e.g., @samp{#+BEGIN_LATEX}).
10426 Any other block is a @emph{special block}. Its name is case-sensitive.
10428 For example, @samp{#+BEGIN_abstract} and @samp{#+BEGIN_video} are special
10429 blocks. The first one is useful when exporting to @LaTeX{}, the second one
10430 when exporting to HTML5.
10432 Each export back-end decides if they should be exported, and how. When the
10433 block is ignored, its contents are still exported, as if the opening and
10434 closing block lines were not there. For example, when exporting a
10435 @samp{#+BEGIN_test} block, HTML back-end wraps its contents within a
10436 @samp{<div name="test">} tag.
10438 Refer to back-end specific documentation for more information.
10444 The Org mode export facilities can be used to export Org documents or parts
10445 of Org documents to a variety of other formats. In addition, these
10446 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10447 in foreign buffers so you can author tables and lists in Org syntax and
10448 convert them in place to the target language.
10450 ASCII export produces a readable and simple version of an Org file for
10451 printing and sharing notes. HTML export allows you to easily publish notes
10452 on the web, or to build full-fledged websites. @LaTeX{} export lets you use
10453 Org mode and its structured editing functions to create arbitrarily complex
10454 @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export
10455 allows seamless collaboration across organizational boundaries. Markdown
10456 export lets you seamlessly collaborate with other developers. Finally, iCal
10457 export can extract entries with deadlines or appointments to produce a file
10458 in the iCalendar format.
10461 * The export dispatcher:: The main exporter interface
10462 * Export back-ends:: Built-in export formats
10463 * Export settings:: Generic export settings
10464 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10465 * Beamer export:: Exporting as a Beamer presentation
10466 * HTML export:: Exporting to HTML
10467 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
10468 * Markdown export:: Exporting to Markdown
10469 * OpenDocument Text export:: Exporting to OpenDocument Text
10470 * Org export:: Exporting to Org
10471 * Texinfo export:: Exporting to Texinfo
10472 * iCalendar export:: Exporting to iCalendar
10473 * Other built-in back-ends:: Exporting to a man page
10474 * Export in foreign buffers:: Author tables and lists in Org syntax
10475 * Advanced configuration:: Fine-tuning the export output
10478 @node The export dispatcher
10479 @section The export dispatcher
10480 @vindex org-export-dispatch-use-expert-ui
10481 @cindex Export, dispatcher
10483 The main entry point for export related tasks is the dispatcher, a
10484 hierarchical menu from which it is possible to select an export format and
10485 toggle export options@footnote{It is also possible to use a less intrusive
10486 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10487 non-@code{nil} value. In that case, only a prompt is visible from the
10488 minibuffer. From there one can still switch back to regular menu by pressing
10489 @key{?}.} from which it is possible to select an export format and to toggle
10494 @orgcmd{C-c C-e,org-export-dispatch}
10496 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10497 prefix argument, repeat the last export command on the current buffer while
10498 preserving toggled options. If the current buffer hasn't changed and subtree
10499 export was activated, the command will affect that same subtree.
10503 Normally the entire buffer is exported, but if there is an active region
10504 only that part of the buffer will be exported.
10506 Several export options (@pxref{Export settings}) can be toggled from the
10507 export dispatcher with the following key combinations:
10511 @vindex org-export-async-init-file
10512 Toggle asynchronous export. Asynchronous export uses an external Emacs
10513 process that is configured with a specified initialization file.
10515 While exporting asynchronously, the output is not displayed, but stored in
10516 a place called ``the export stack''. This stack can be displayed by calling
10517 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10518 from the dispatcher menu.
10520 @vindex org-export-in-background
10521 To make this behavior the default, customize the variable
10522 @code{org-export-in-background}.
10525 Toggle body-only export. Its effect depends on the back-end used.
10526 Typically, if the back-end has a header section (like @code{<head>...</head>}
10527 in the HTML back-end), a body-only export will not include this header.
10530 @vindex org-export-initial-scope
10531 Toggle subtree export. The top heading becomes the document title.
10533 You can change the default state of this option by setting
10534 @code{org-export-initial-scope}.
10537 Toggle visible-only export. Only export the text that is currently
10538 visible, i.e. not hidden by outline visibility in the buffer.
10541 @node Export back-ends
10542 @section Export back-ends
10543 @cindex Export, back-ends
10545 An export back-end is a library that translates Org syntax into a foreign
10546 format. An export format is not available until the proper back-end has been
10549 @vindex org-export-backends
10550 By default, the following four back-ends are loaded: @code{ascii},
10551 @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
10552 (or remove some) by customizing @code{org-export-backends}.
10554 Built-in back-ends include:
10557 @item ascii (ASCII format)
10558 @item beamer (@LaTeX{} Beamer format)
10559 @item html (HTML format)
10560 @item icalendar (iCalendar format)
10561 @item latex (@LaTeX{} format)
10562 @item man (Man page format)
10563 @item md (Markdown format)
10564 @item odt (OpenDocument Text format)
10565 @item org (Org format)
10566 @item texinfo (Texinfo format)
10569 Other back-ends might be found in the @code{contrib/} directory
10570 (@pxref{Installation}).
10572 @node Export settings
10573 @section Export settings
10574 @cindex Export, settings
10577 Export options can be set: globally with variables; for an individual file by
10578 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10579 settings}), by setting individual keywords, or by specifying them in a
10580 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10581 properties (@pxref{Properties and columns}). Options set at a specific level
10582 override options set at a more general level.
10584 @cindex #+SETUPFILE
10585 In-buffer settings may appear anywhere in the file, either directly or
10586 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10587 Option keyword sets tailored to a particular back-end can be inserted from
10588 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10589 template} command by pressing @key{#}. To insert keywords individually,
10590 a good way to make sure the keyword is correct is to type @code{#+} and then
10591 to use @kbd{M-<TAB>} for completion.
10593 The export keywords available for every back-end, and their equivalent global
10594 variables, include:
10599 @vindex user-full-name
10600 The document author (@code{user-full-name}).
10604 @vindex org-export-creator-string
10605 Entity responsible for output generation (@code{org-export-creator-string}).
10609 @vindex org-export-date-timestamp-format
10610 A date or a time-stamp@footnote{The variable
10611 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10615 @cindex #+DESCRIPTION
10616 The document description. Back-ends handle it as they see fit (e.g., for the
10617 XHTML meta tag), if at all. You can use several such keywords for long
10622 @vindex user-mail-address
10623 The email address (@code{user-mail-address}).
10627 The keywords defining the contents of the document. Back-ends handle it as
10628 they see fit (e.g., for the XHTML meta tag), if at all. You can use several
10629 such keywords if the list is long.
10633 @vindex org-export-default-language
10634 The language used for translating some strings
10635 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10636 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10640 @cindex #+SELECT_TAGS
10641 @vindex org-export-select-tags
10642 The tags that select a tree for export (@code{org-export-select-tags}). The
10643 default value is @code{:export:}. Within a subtree tagged with
10644 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10645 below). When headlines are selectively exported with @code{:export:}
10646 anywhere in a file, text before the first headline is ignored.
10649 @cindex #+EXCLUDE_TAGS
10650 @vindex org-export-exclude-tags
10651 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10652 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10653 tag will be unconditionally excluded from the export, even if they have an
10654 @code{:export:} tag. Code blocks contained in excluded subtrees will still
10655 be executed during export even though the subtree is not exported.
10659 The title to be shown. You can use several such keywords for long titles.
10662 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10663 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10664 recognizes the following arguments:
10668 @vindex org-export-with-smart-quotes
10669 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10672 Toggle emphasized text (@code{org-export-with-emphasize}).
10675 @vindex org-export-with-special-strings
10676 Toggle conversion of special strings
10677 (@code{org-export-with-special-strings}).
10680 @vindex org-export-with-fixed-width
10681 Toggle fixed-width sections
10682 (@code{org-export-with-fixed-width}).
10685 @vindex org-export-with-timestamps
10686 Toggle inclusion of any time/date active/inactive stamps
10687 (@code{org-export-with-timestamps}).
10690 @vindex org-export-preserve-breaks
10691 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10694 @vindex org-export-with-sub-superscripts
10695 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10696 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10697 it is (@code{org-export-with-sub-superscripts}).
10700 @vindex org-export-with-archived-trees
10701 Configure export of archived trees. Can be set to @code{headline} to only
10702 process the headline, skipping its contents
10703 (@code{org-export-with-archived-trees}).
10706 @vindex org-export-with-author
10707 Toggle inclusion of author name into exported file
10708 (@code{org-export-with-author}).
10711 @vindex org-export-with-clocks
10712 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10715 @vindex org-export-with-creator
10716 Configure inclusion of creator info into exported file. It may be set to
10717 @code{comment} (@code{org-export-with-creator}).
10720 @vindex org-export-with-drawers
10721 Toggle inclusion of drawers, or list drawers to include
10722 (@code{org-export-with-drawers}).
10725 @vindex org-export-with-entities
10726 Toggle inclusion of entities (@code{org-export-with-entities}).
10729 @vindex org-export-with-email
10730 Toggle inclusion of the author's e-mail into exported file
10731 (@code{org-export-with-email}).
10734 @vindex org-export-with-footnotes
10735 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10738 @vindex org-export-headline-levels
10739 Set the number of headline levels for export
10740 (@code{org-export-headline-levels}). Below that level, headlines are treated
10741 differently. In most back-ends, they become list items.
10744 @vindex org-export-with-inlinetasks
10745 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10748 @vindex org-export-with-section-numbers
10749 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10750 be set to a number @samp{n}, so only headlines at that level or above will be
10754 @vindex org-export-with-planning
10755 Toggle export of planning information (@code{org-export-with-planning}).
10756 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10757 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10760 @vindex org-export-with-priority
10761 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10764 @vindex org-export-with-properties
10765 Toggle inclusion of property drawers, or list properties to include
10766 (@code{org-export-with-properties}).
10769 @vindex org-export-with-statistics-cookies
10770 Toggle inclusion of statistics cookies
10771 (@code{org-export-with-statistics-cookies}).
10774 @vindex org-export-with-tags
10775 Toggle inclusion of tags, may also be @code{not-in-toc}
10776 (@code{org-export-with-tags}).
10779 @vindex org-export-with-tasks
10780 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10781 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10782 (@code{org-export-with-tasks}).
10785 @vindex org-export-with-latex
10786 Configure export of @LaTeX{} fragments and environments. It may be set to
10787 @code{verbatim} (@code{org-export-with-latex}).
10790 @vindex org-export-time-stamp-file
10791 Toggle inclusion of the creation time into exported file
10792 (@code{org-export-time-stamp-file}).
10795 @vindex org-export-with-toc
10796 Toggle inclusion of the table of contents, or set the level limit
10797 (@code{org-export-with-toc}).
10800 @vindex org-export-with-todo-keywords
10801 Toggle inclusion of TODO keywords into exported text
10802 (@code{org-export-with-todo-keywords}).
10805 @vindex org-export-with-tables
10806 Toggle inclusion of tables (@code{org-export-with-tables}).
10809 When exporting only a subtree, each of the previous keywords@footnote{With
10810 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10811 properties. These begin with @samp{EXPORT_}, followed by the name of the
10812 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10813 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10817 @vindex org-export-allow-bind-keywords
10818 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10819 can become buffer-local during export by using the BIND keyword. Its syntax
10820 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10821 settings that cannot be changed using specific keywords.
10823 @cindex property, EXPORT_FILE_NAME
10824 The name of the output file to be generated is taken from the file associated
10825 to the buffer, when possible, or asked to you otherwise. For subtree export,
10826 you can also set @samp{EXPORT_FILE_NAME} property. In all cases, only the
10827 base name of the file is retained, and a back-end specific extension is
10830 @node ASCII/Latin-1/UTF-8 export
10831 @section ASCII/Latin-1/UTF-8 export
10832 @cindex ASCII export
10833 @cindex Latin-1 export
10834 @cindex UTF-8 export
10836 ASCII export produces a simple and very readable version of an Org mode
10837 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10838 with special characters and symbols available in these encodings.
10840 @vindex org-ascii-text-width
10841 Upon exporting, text is filled and justified, when appropriate, according the
10842 text width set in @code{org-ascii-text-width}.
10844 @vindex org-ascii-links-to-notes
10845 Links are exported in a footnote-like style, with the descriptive part in the
10846 text and the link in a note before the next heading. See the variable
10847 @code{org-ascii-links-to-notes} for details and other options.
10849 @subheading ASCII export commands
10852 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10853 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10854 will be @file{myfile.txt}. The file will be overwritten without warning.
10855 When the original file is @file{myfile.txt}, the resulting file becomes
10856 @file{myfile.txt.txt} in order to prevent data loss.
10857 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10858 Export to a temporary buffer. Do not create a file.
10861 @subheading Header and sectioning structure
10863 In the exported version, the first three outline levels become headlines,
10864 defining a general document structure. Additional levels are exported as
10865 lists. The transition can also occur at a different level (@pxref{Export
10868 @subheading Quoting ASCII text
10870 You can insert text that will only appear when using @code{ASCII} back-end
10871 with the following constructs:
10874 @cindex #+BEGIN_ASCII
10876 Text @@@@ascii:and additional text@@@@ within a paragraph.
10881 All lines in this block will appear only when using this back-end.
10885 @subheading ASCII specific attributes
10886 @cindex #+ATTR_ASCII
10887 @cindex horizontal rules, in ASCII export
10889 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10890 specifies the length, in characters, of a given horizontal rule. It must be
10891 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10894 #+ATTR_ASCII: :width 10
10898 @subheading ASCII special blocks
10899 @cindex special blocks, in ASCII export
10900 @cindex #+BEGIN_JUSTIFYLEFT
10901 @cindex #+BEGIN_JUSTIFYRIGHT
10903 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
10904 possible to justify contents to the left or the right of the page with the
10905 following dedicated blocks.
10908 #+BEGIN_JUSTIFYLEFT
10909 It's just a jump to the left...
10912 #+BEGIN_JUSTIFYRIGHT
10913 ...and then a step to the right.
10917 @node Beamer export
10918 @section Beamer export
10919 @cindex Beamer export
10921 The @LaTeX{} class @emph{Beamer} allows production of high quality
10922 presentations using @LaTeX{} and pdf processing. Org mode has special
10923 support for turning an Org mode file or tree into a Beamer presentation.
10925 @subheading Beamer export commands
10928 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10929 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
10930 file will be @file{myfile.tex}. The file will be overwritten without
10932 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10933 Export to a temporary buffer. Do not create a file.
10934 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10935 Export as @LaTeX{} and then process to PDF.
10937 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10940 @subheading Sectioning, Frames and Blocks
10942 Any tree with not-too-deep level nesting should in principle be exportable as
10943 a Beamer presentation. Headlines fall into three categories: sectioning
10944 elements, frames and blocks.
10948 @vindex org-beamer-frame-level
10949 Headlines become frames when their level is equal to
10950 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10951 (@pxref{Export settings}).
10953 @cindex property, BEAMER_ENV
10954 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10955 set to either to @code{frame} or @code{fullframe}, its level overrides the
10956 variable. A @code{fullframe} is a frame with an empty (ignored) title.
10959 @vindex org-beamer-environments-default
10960 @vindex org-beamer-environments-extra
10961 All frame's children become @code{block} environments. Special block types
10962 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10963 this property is set, the entry will also get a @code{:B_environment:} tag to
10964 make this visible. This tag has no semantic meaning, it is only a visual
10965 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10966 supported values and @code{org-beamer-environments-extra} for adding more).
10969 @cindex property, BEAMER_REF
10970 As a special case, if the @code{BEAMER_ENV} property is set to either
10971 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10972 headline will become, respectively, an appendix, a note (within frame or
10973 between frame, depending on its level), a note with its title ignored or an
10974 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
10975 is mandatory in order to refer to the frame being resumed, and contents are
10978 Also, a headline with an @code{ignoreheading} environment will have its
10979 contents only inserted in the output. This special value is useful to have
10980 data between frames, or to properly close a @code{column} environment.
10983 @cindex property, BEAMER_ACT
10984 @cindex property, BEAMER_OPT
10985 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
10986 The former is translated as an overlay/action specification, or a default
10987 overlay specification when enclosed within square brackets. The latter
10988 specifies options@footnote{The @code{fragile} option is added automatically
10989 if it contains code that requires a verbatim environment, though.} for the
10990 current frame or block. The export back-end will automatically wrap
10991 properties within angular or square brackets when appropriate.
10993 @cindex property, BEAMER_COL
10994 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
10995 be a decimal number representing the width of the column as a fraction of the
10996 total text width. If the headline has no specific environment, its title
10997 will be ignored and its contents will fill the column created. Otherwise,
10998 the block will fill the whole column and the title will be preserved. Two
10999 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
11000 @code{columns} @LaTeX{} environment. It will end before the next headline
11001 without such a property. This environment is generated automatically.
11002 Although, it can also be explicitly created, with a special @code{columns}
11003 value for @code{BEAMER_ENV} property (if it needs to be set up with some
11004 specific options, for example).
11006 @subheading Beamer specific syntax
11008 Beamer back-end is an extension of @LaTeX{} back-end. As such, all @LaTeX{}
11009 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
11010 recognized. See @ref{@LaTeX{} and PDF export} for more information.
11012 @cindex #+BEAMER_THEME
11013 @cindex #+BEAMER_COLOR_THEME
11014 @cindex #+BEAMER_FONT_THEME
11015 @cindex #+BEAMER_INNER_THEME
11016 @cindex #+BEAMER_OUTER_THEME
11017 Beamer export introduces a number of keywords to insert code in the
11018 document's header. Four control appearance of the presentation:
11019 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
11020 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
11021 @code{#+BEAMER_OUTER_THEME}. All of them accept optional arguments
11022 within square brackets. The last one, @code{#+BEAMER_HEADER}, is more
11023 generic and allows you to append any line of code in the header.
11026 #+BEAMER_THEME: Rochester [height=20pt]
11027 #+BEAMER_COLOR_THEME: spruce
11030 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11031 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
11032 keyword (@pxref{Table of contents}) are not. In that case, it is also
11033 possible to specify options, enclosed within square brackets.
11036 #+TOC: headlines [currentsection]
11039 Beamer specific code can be inserted with the following constructs:
11042 @cindex #+BEGIN_BEAMER
11047 All lines in this block will appear only when using this back-end.
11050 Text @@@@beamer:some code@@@@ within a paragraph.
11053 In particular, this last example can be used to add overlay specifications to
11054 objects whose type is among @code{bold}, @code{item}, @code{link},
11055 @code{radio-target} and @code{target}, when the value is enclosed within
11056 angular brackets and put at the beginning the object.
11059 A *@@@@beamer:<2->@@@@useful* feature
11062 @cindex #+ATTR_BEAMER
11063 Eventually, every plain list has support for @code{:environment},
11064 @code{:overlay} and @code{:options} attributes through
11065 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
11066 of a different environment, the second sets overlay specifications and
11067 the last one inserts optional arguments in current list environment.
11070 #+ATTR_BEAMER: :overlay +-
11075 @subheading Editing support
11077 You can turn on a special minor mode @code{org-beamer-mode} for faster
11085 @orgcmd{C-c C-b,org-beamer-select-environment}
11086 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11087 environment or the @code{BEAMER_COL} property.
11090 @subheading An example
11092 Here is a simple example Org document that is intended for Beamer export.
11095 #+TITLE: Example Presentation
11096 #+AUTHOR: Carsten Dominik
11097 #+OPTIONS: H:2 toc:t num:t
11098 #+LATEX_CLASS: beamer
11099 #+LATEX_CLASS_OPTIONS: [presentation]
11100 #+BEAMER_THEME: Madrid
11101 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11103 * This is the first structural section
11106 *** Thanks to Eric Fraga :B_block:
11111 for the first viable Beamer setup in Org
11112 *** Thanks to everyone else :B_block:
11118 for contributing to the discussion
11119 **** This will be formatted as a beamer note :B_note:
11123 ** Frame 2 (where we will not use columns)
11125 Please test this stuff!
11129 @section HTML export
11130 @cindex HTML export
11132 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11133 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11134 language, but with additional support for tables.
11137 * HTML Export commands:: How to invoke HTML export
11138 * HTML doctypes:: Org can export to various (X)HTML flavors
11139 * HTML preamble and postamble:: How to insert a preamble and a postamble
11140 * Quoting HTML tags:: Using direct HTML in Org mode
11141 * Links in HTML export:: How links will be interpreted and formatted
11142 * Tables in HTML export:: How to modify the formatting of tables
11143 * Images in HTML export:: How to insert figures into HTML output
11144 * Math formatting in HTML export:: Beautiful math also on the web
11145 * Text areas in HTML export:: An alternative way to show an example
11146 * CSS support:: Changing the appearance of the output
11147 * JavaScript support:: Info and Folding in a web browser
11150 @node HTML Export commands
11151 @subsection HTML export commands
11154 @orgcmd{C-c C-e h h,org-html-export-to-html}
11155 Export as an HTML file. For an Org file @file{myfile.org},
11156 the HTML file will be @file{myfile.html}. The file will be overwritten
11159 Export as an HTML file and immediately open it with a browser.
11160 @orgcmd{C-c C-e h H,org-html-export-as-html}
11161 Export to a temporary buffer. Do not create a file.
11164 @c FIXME Exporting sublevels
11165 @c @cindex headline levels, for exporting
11166 @c In the exported version, the first 3 outline levels will become headlines,
11167 @c defining a general document structure. Additional levels will be exported as
11168 @c itemized lists. If you want that transition to occur at a different level,
11169 @c specify it with a numeric prefix argument. For example,
11172 @c @kbd{C-2 C-c C-e b}
11176 @c creates two levels of headings and does the rest as items.
11178 @node HTML doctypes
11179 @subsection HTML doctypes
11180 @vindex org-html-doctype
11181 @vindex org-html-doctype-alist
11183 Org can export to various (X)HTML flavors.
11185 Setting the variable @code{org-html-doctype} allows you to export to different
11186 (X)HTML variants. The exported HTML will be adjusted according to the syntax
11187 requirements of that variant. You can either set this variable to a doctype
11188 string directly, in which case the exporter will try to adjust the syntax
11189 automatically, or you can use a ready-made doctype. The ready-made options
11196 ``html4-transitional''
11202 ``xhtml-transitional''
11213 See the variable @code{org-html-doctype-alist} for details. The default is
11216 @subsubheading Fancy HTML5 export
11217 @vindex org-html-html5-fancy
11218 @vindex org-html-html5-elements
11220 HTML5 introduces several new element types. By default, Org will not make
11221 use of these element types, but you can set @code{org-html-html5-fancy} to
11222 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11223 enable a few new block-level elements. These are created using arbitrary
11224 #+BEGIN and #+END blocks. For instance:
11243 #+ATTR_HTML: :controls controls :width 350
11245 #+HTML: <source src="movie.mp4" type="video/mp4">
11246 #+HTML: <source src="movie.ogg" type="video/ogg">
11247 Your browser does not support the video tag.
11254 <video controls="controls" width="350">
11255 <source src="movie.mp4" type="video/mp4">
11256 <source src="movie.ogg" type="video/ogg">
11257 <p>Your browser does not support the video tag.</p>
11261 Special blocks that do not correspond to HTML5 elements (see
11262 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11263 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11265 Headlines cannot appear within special blocks. To wrap a headline and its
11266 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11267 @code{HTML_CONTAINER} property on the headline itself.
11269 @node HTML preamble and postamble
11270 @subsection HTML preamble and postamble
11271 @vindex org-html-preamble
11272 @vindex org-html-postamble
11273 @vindex org-html-preamble-format
11274 @vindex org-html-postamble-format
11275 @vindex org-html-validation-link
11276 @vindex org-export-creator-string
11277 @vindex org-export-time-stamp-file
11279 The HTML exporter lets you define a preamble and a postamble.
11281 The default value for @code{org-html-preamble} is @code{t}, which means
11282 that the preamble is inserted depending on the relevant format string in
11283 @code{org-html-preamble-format}.
11285 Setting @code{org-html-preamble} to a string will override the default format
11286 string. If you set it to a function, it will insert the output of the
11287 function, which must be a string. Setting to @code{nil} will not insert any
11290 The default value for @code{org-html-postamble} is @code{'auto}, which means
11291 that the HTML exporter will look for information about the author, the email,
11292 the creator and the date, and build the postamble from these values. Setting
11293 @code{org-html-postamble} to @code{t} will insert the postamble from the
11294 relevant format string found in @code{org-html-postamble-format}. Setting it
11295 to @code{nil} will not insert any postamble.
11297 @node Quoting HTML tags
11298 @subsection Quoting HTML tags
11300 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11301 @samp{>} in HTML export. If you want to include raw HTML code, which
11302 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11303 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11304 that should be copied verbatim to the exported file use either
11307 @cindex #+BEGIN_HTML
11309 #+HTML: Literal HTML code for export
11313 @cindex #+BEGIN_HTML
11317 All lines between these markers are exported literally
11322 @node Links in HTML export
11323 @subsection Links in HTML export
11325 @cindex links, in HTML export
11326 @cindex internal links, in HTML export
11327 @cindex external links, in HTML export
11328 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11329 includes automatic links created by radio targets (@pxref{Radio
11330 targets}). Links to external files will still work if the target file is on
11331 the same @i{relative} path as the published Org file. Links to other
11332 @file{.org} files will be translated into HTML links under the assumption
11333 that an HTML version also exists of the linked file, at the same relative
11334 path. @samp{id:} links can then be used to jump to specific entries across
11335 files. For information related to linking files while publishing them to a
11336 publishing directory see @ref{Publishing links}.
11338 If you want to specify attributes for links, you can do so using a special
11339 @code{#+ATTR_HTML} line to define attributes that will be added to the
11340 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11341 and @code{style} attributes for a link:
11343 @cindex #+ATTR_HTML
11345 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11346 [[http://orgmode.org]]
11349 @node Tables in HTML export
11350 @subsection Tables in HTML export
11351 @cindex tables, in HTML
11352 @vindex org-html-table-default-attributes
11354 Org mode tables are exported to HTML using the table attributes defined in
11355 @code{org-html-table-default-attributes}. The default setting makes tables
11356 without cell borders and frame. If you would like to change this for
11357 individual tables, place something like the following before the table:
11360 @cindex #+ATTR_HTML
11362 #+CAPTION: This is a table with lines around and between cells
11363 #+ATTR_HTML: :border 2 :rules all :frame border
11366 You can also group columns in the HTML output (@pxref{Column groups}).
11368 Below is a list of options for customizing tables HTML export.
11371 @vindex org-html-table-align-individual-fields
11372 @item org-html-table-align-individual-fields
11373 Non-nil means attach style attributes for alignment to each table field.
11375 @vindex org-html-table-caption-above
11376 @item org-html-table-caption-above
11377 When non-nil, place caption string at the beginning of the table.
11379 @vindex org-html-table-data-tags
11380 @item org-html-table-data-tags
11381 The opening and ending tags for table data fields.
11383 @vindex org-html-table-default-attributes
11384 @item org-html-table-default-attributes
11385 Default attributes and values which will be used in table tags.
11387 @vindex org-html-table-header-tags
11388 @item org-html-table-header-tags
11389 The opening and ending tags for table header fields.
11391 @vindex org-html-table-row-tags
11392 @item org-html-table-row-tags
11393 The opening and ending tags for table rows.
11395 @vindex org-html-table-use-header-tags-for-first-column
11396 @item org-html-table-use-header-tags-for-first-column
11397 Non-nil means format column one in tables with header tags.
11400 @node Images in HTML export
11401 @subsection Images in HTML export
11403 @cindex images, inline in HTML
11404 @cindex inlining images in HTML
11405 @vindex org-html-inline-images
11406 HTML export can inline images given as links in the Org file, and
11407 it can make an image the clickable part of a link. By
11408 default@footnote{But see the variable
11409 @code{org-html-inline-images}.}, images are inlined if a link does
11410 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11411 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11412 @samp{the image} that points to the image. If the description part
11413 itself is a @code{file:} link or a @code{http:} URL pointing to an
11414 image, this image will be inlined and activated so that clicking on the
11415 image will activate the link. For example, to include a thumbnail that
11416 will link to a high resolution version of the image, you could use:
11419 [[file:highres.jpg][file:thumb.jpg]]
11422 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11423 In the example below we specify the @code{alt} and @code{title} attributes to
11424 support text viewers and accessibility, and align it to the right.
11427 @cindex #+ATTR_HTML
11429 #+CAPTION: A black cat stalking a spider
11430 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11435 You could use @code{http} addresses just as well.
11437 @node Math formatting in HTML export
11438 @subsection Math formatting in HTML export
11441 @cindex imagemagick
11443 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11444 different ways on HTML pages. The default is to use the
11445 @uref{http://www.mathjax.org, MathJax system} which should work out of the
11446 box with Org mode installation because @uref{http://orgmode.org} serves
11447 @file{MathJax} for Org mode users for small applications and for testing
11448 purposes. @b{If you plan to use this regularly or on pages with significant
11449 page views, you should install@footnote{Installation instructions can be
11450 found on the MathJax website, see
11451 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
11452 your own server in order to limit the load of our server.} To configure
11453 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
11454 insert something like the following into the buffer:
11457 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
11460 @noindent See the docstring of the variable
11461 @code{org-html-mathjax-options} for the meaning of the parameters in
11464 If you prefer, you can also request that @LaTeX{} fragments are processed
11465 into small images that will be inserted into the browser page. Before the
11466 availability of MathJax, this was the default method for Org files. This
11467 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11468 available on your system. You can still get this processing with
11471 #+OPTIONS: tex:dvipng
11477 #+OPTIONS: tex:imagemagick
11480 @node Text areas in HTML export
11481 @subsection Text areas in HTML export
11483 @cindex text areas, in HTML
11484 An alternative way to publish literal code examples in HTML is to use text
11485 areas, where the example can even be edited before pasting it into an
11486 application. It is triggered by @code{:textarea} attribute at an
11487 @code{example} or @code{src} block.
11489 You may also use @code{:height} and @code{:width} attributes to specify the
11490 height and width of the text area, which default to the number of lines in
11491 the example, and 80, respectively. For example
11494 #+ATTR_HTML: :textarea t :width 40
11496 (defun org-xor (a b)
11504 @subsection CSS support
11505 @cindex CSS, for HTML export
11506 @cindex HTML export, CSS
11508 @vindex org-html-todo-kwd-class-prefix
11509 @vindex org-html-tag-class-prefix
11510 You can modify the CSS style definitions for the exported file. The HTML
11511 exporter assigns the following special CSS classes@footnote{If the classes on
11512 TODO keywords and tags lead to conflicts, use the variables
11513 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11514 make them unique.} to appropriate parts of the document---your style
11515 specifications may change these, in addition to any of the standard classes
11516 like for headlines, tables, etc.
11518 p.author @r{author information, including email}
11519 p.date @r{publishing date}
11520 p.creator @r{creator info, about org mode version}
11521 .title @r{document title}
11522 .todo @r{TODO keywords, all not-done states}
11523 .done @r{the DONE keywords, all states that count as done}
11524 .WAITING @r{each TODO keyword also uses a class named after itself}
11525 .timestamp @r{timestamp}
11526 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11527 .timestamp-wrapper @r{span around keyword plus timestamp}
11528 .tag @r{tag in a headline}
11529 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11530 .target @r{target for links}
11531 .linenr @r{the line number in a code example}
11532 .code-highlighted @r{for highlighting referenced code lines}
11533 div.outline-N @r{div for outline level N (headline plus text))}
11534 div.outline-text-N @r{extra div for text at outline level N}
11535 .section-number-N @r{section number in headlines, different for each level}
11536 .figure-number @r{label like "Figure 1:"}
11537 .table-number @r{label like "Table 1:"}
11538 .listing-number @r{label like "Listing 1:"}
11539 div.figure @r{how to format an inlined image}
11540 pre.src @r{formatted source code}
11541 pre.example @r{normal example}
11542 p.verse @r{verse paragraph}
11543 div.footnotes @r{footnote section headline}
11544 p.footnote @r{footnote definition paragraph, containing a footnote}
11545 .footref @r{a footnote reference number (always a <sup>)}
11546 .footnum @r{footnote number in footnote definition (always <sup>)}
11549 @vindex org-html-style-default
11550 @vindex org-html-head-include-default-style
11551 @vindex org-html-head
11552 @vindex org-html-head-extra
11553 @cindex #+HTML_INCLUDE_STYLE
11554 Each exported file contains a compact default style that defines these
11555 classes in a basic way@footnote{This style is defined in the constant
11556 @code{org-html-style-default}, which you should not modify. To turn
11557 inclusion of these defaults off, customize
11558 @code{org-html-head-include-default-style} or set @code{html-style} to
11559 @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or
11560 add to them by using the variables @code{org-html-head} and
11561 @code{org-html-head-extra}. You can override the global values of these
11562 variables for each file by using these keywords:
11564 @cindex #+HTML_HEAD
11565 @cindex #+HTML_HEAD_EXTRA
11567 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11568 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11572 For longer style definitions, you can use several such lines. You could also
11573 directly write a @code{<style>} @code{</style>} section in this way, without
11574 referring to an external file.
11576 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11577 property to assign a class to the tree. In order to specify CSS styles for a
11578 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11581 @c FIXME: More about header and footer styles
11582 @c FIXME: Talk about links and targets.
11584 @node JavaScript support
11585 @subsection JavaScript supported display of web pages
11587 @cindex Rose, Sebastian
11588 Sebastian Rose has written a JavaScript program especially designed to
11589 enhance the web viewing experience of HTML files created with Org. This
11590 program allows you to view large files in two different ways. The first one
11591 is an @emph{Info}-like mode where each section is displayed separately and
11592 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11593 as well, press @kbd{?} for an overview of the available keys). The second
11594 view type is a @emph{folding} view much like Org provides inside Emacs. The
11595 script is available at @url{http://orgmode.org/org-info.js} and you can find
11596 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11597 We host the script at our site, but if you use it a lot, you might not want
11598 to be dependent on @url{http://orgmode.org} and prefer to install a local
11599 copy on your own web server.
11601 All it then takes to use this program is adding a single line to the Org
11604 @cindex #+INFOJS_OPT
11606 #+INFOJS_OPT: view:info toc:nil
11610 If this line is found, the HTML header will automatically contain the code
11611 needed to invoke the script. Using the line above, you can set the following
11615 path: @r{The path to the script. The default is to grab the script from}
11616 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11617 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11618 view: @r{Initial view when the website is first shown. Possible values are:}
11619 info @r{Info-like interface with one section per page.}
11620 overview @r{Folding interface, initially showing only top-level.}
11621 content @r{Folding interface, starting with all headlines visible.}
11622 showall @r{Folding interface, all headlines and text visible.}
11623 sdepth: @r{Maximum headline level that will still become an independent}
11624 @r{section for info and folding modes. The default is taken from}
11625 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11626 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11627 @r{info/folding section can still contain child headlines.}
11628 toc: @r{Should the table of contents @emph{initially} be visible?}
11629 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11630 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11631 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11632 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11633 @r{If yes, the toc will never be displayed as a section.}
11634 ltoc: @r{Should there be short contents (children) in each section?}
11635 @r{Make this @code{above} if the section should be above initial text.}
11636 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11637 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11638 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11639 @r{default), only one such button will be present.}
11642 @vindex org-html-infojs-options
11643 @vindex org-html-use-infojs
11644 You can choose default values for these options by customizing the variable
11645 @code{org-html-infojs-options}. If you always want to apply the script to your
11646 pages, configure the variable @code{org-html-use-infojs}.
11648 @node @LaTeX{} and PDF export
11649 @section @LaTeX{} and PDF export
11650 @cindex @LaTeX{} export
11653 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11654 standard or custom document class. With further processing@footnote{The
11655 default @LaTeX{} output is designed for processing with @code{pdftex} or
11656 @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
11657 possibly @code{luatex}. The @LaTeX{} exporter can be configured to support
11658 alternative TeX engines, see the options
11659 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11660 which the @LaTeX{} exporter is able to control, this back-end is able to
11661 produce PDF output. Because the @LaTeX{} exporter can be configured to use
11662 the @code{hyperref} package, the default setup produces fully-linked PDF
11665 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11666 will not be started if two contiguous syntactical elements are not separated
11669 This back-end also offers enhanced support for footnotes. Thus, it handles
11670 nested footnotes, footnotes in tables and footnotes in a list item's
11674 * @LaTeX{} export commands:: How to export to LaTeX and PDF
11675 * Header and sectioning:: Setting up the export file structure
11676 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11677 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
11680 @node @LaTeX{} export commands
11681 @subsection @LaTeX{} export commands
11684 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11685 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11686 file will be @file{myfile.tex}. The file will be overwritten without
11688 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11689 Export to a temporary buffer. Do not create a file.
11690 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11691 Export as @LaTeX{} and then process to PDF.
11693 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11696 @node Header and sectioning
11697 @subsection Header and sectioning structure
11698 @cindex @LaTeX{} class
11699 @cindex @LaTeX{} sectioning structure
11700 @cindex @LaTeX{} header
11701 @cindex header, for @LaTeX{} files
11702 @cindex sectioning structure, for @LaTeX{} export
11704 By default, the first three outline levels become headlines, defining a
11705 general document structure. Additional levels are exported as @code{itemize}
11706 or @code{enumerate} lists. The transition can also occur at a different
11707 level (@pxref{Export settings}).
11709 By default, the @LaTeX{} output uses the class @code{article}.
11711 @vindex org-latex-default-class
11712 @vindex org-latex-classes
11713 @vindex org-latex-default-packages-alist
11714 @vindex org-latex-packages-alist
11715 You can change this globally by setting a different value for
11716 @code{org-latex-default-class} or locally by adding an option like
11717 @code{#+LATEX_CLASS: myclass} in your file, or with
11718 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11719 containing only this (sub)tree. The class must be listed in
11720 @code{org-latex-classes}. This variable defines a header template for each
11721 class@footnote{Into which the values of
11722 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11723 are spliced.}, and allows you to define the sectioning structure for each
11724 class. You can also define your own classes there.
11726 @cindex #+LATEX_CLASS
11727 @cindex #+LATEX_CLASS_OPTIONS
11728 @cindex property, EXPORT_LATEX_CLASS
11729 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11730 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11731 property can specify the options for the @code{\documentclass} macro. These
11732 options have to be provided, as expected by @LaTeX{}, within square brackets.
11734 @cindex #+LATEX_HEADER
11735 @cindex #+LATEX_HEADER_EXTRA
11736 You can also use the @code{LATEX_HEADER} and
11737 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11738 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11739 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11740 to add lines to the header. See the docstring of @code{org-latex-classes} for
11743 An example is shown below.
11746 #+LATEX_CLASS: article
11747 #+LATEX_CLASS_OPTIONS: [a4paper]
11748 #+LATEX_HEADER: \usepackage@{xyz@}
11754 @node Quoting @LaTeX{} code
11755 @subsection Quoting @LaTeX{} code
11757 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11758 inserted into the @LaTeX{} file. Furthermore, you can add special code that
11759 should only be present in @LaTeX{} export with the following constructs:
11762 @cindex #+BEGIN_LATEX
11764 Code within @@@@latex:some code@@@@ a paragraph.
11766 #+LATEX: Literal @LaTeX{} code for export
11769 All lines between these markers are exported literally
11773 @node @LaTeX{} specific attributes
11774 @subsection @LaTeX{} specific attributes
11775 @cindex #+ATTR_LATEX
11777 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
11778 affect tables, images, plain lists, special blocks and source blocks.
11780 @subsubheading Tables in @LaTeX{} export
11781 @cindex tables, in @LaTeX{} export
11783 For @LaTeX{} export of a table, you can specify a label and a caption
11784 (@pxref{Images and tables}). You can also use attributes to control table
11785 layout and contents. Valid @LaTeX{} attributes include:
11789 @vindex org-latex-default-table-mode
11790 Nature of table's contents. It can be set to @code{table}, @code{math},
11791 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
11792 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11793 ignored and the table will be wrapped in a math environment. Also,
11794 contiguous tables sharing the same math mode will be wrapped within the same
11795 environment. Default mode is determined in
11796 @code{org-latex-default-table-mode}.
11798 @vindex org-latex-default-table-environment
11799 Environment used for the table. It can be set to any @LaTeX{} table
11800 environment, like @code{tabularx}@footnote{Requires adding the
11801 @code{tabularx} package to @code{org-latex-packages-alist}.},
11802 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11803 @code{tabu} package to @code{org-latex-packages-alist}.},
11804 @code{bmatrix}@enddots{} It defaults to
11805 @code{org-latex-default-table-environment} value.
11807 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11808 (@pxref{Images and tables}). If you need more advanced commands for that
11809 task, you can use @code{:caption} attribute instead. Its value should be raw
11810 @LaTeX{} code. It has precedence over @code{#+CAPTION}.
11813 The @code{:float} specifies the float environment for the table. Possible
11814 values are @code{sideways}@footnote{Formerly, the value was
11815 @code{sidewaystable}. This is deprecated since Org 8.3.},
11816 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
11817 a caption will have a @code{table} environment. Moreover, the
11818 @code{:placement} attribute can specify the positioning of the float. Note:
11819 @code{:placement} is ignored for @code{:float sideways} tables.
11823 Set, respectively, the alignment string of the table, its font size and its
11824 width. They only apply on regular tables.
11826 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11827 only takes effect when used in conjunction with the @code{:width} attribute.
11828 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11829 value of @code{:width}.
11833 @vindex org-latex-tables-booktabs
11834 @vindex org-latex-tables-centered
11835 They toggle, respectively, @code{booktabs} usage (assuming the package is
11836 properly loaded), table centering and removal of every horizontal rule but
11837 the first one (in a "table.el" table only). In particular,
11838 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11839 activates the first (respectively second) attribute globally.
11841 @itemx :math-suffix
11842 @itemx :math-arguments
11843 A string that will be inserted, respectively, before the table within the
11844 math environment, after the table within the math environment, and between
11845 the macro name and the contents of the table. The @code{:math-arguments}
11846 attribute is used for matrix macros that require more than one argument
11847 (e.g., @code{qbordermatrix}).
11850 Thus, attributes can be used in a wide array of situations, like writing
11851 a table that will span over multiple pages, or a matrix product:
11854 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11858 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11861 #+ATTR_LATEX: :mode math :environment bmatrix
11866 In the example below, @LaTeX{} command
11867 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11870 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11876 @subsubheading Images in @LaTeX{} export
11877 @cindex images, inline in @LaTeX{}
11878 @cindex inlining images in @LaTeX{}
11880 Images that are linked to without a description part in the link, like
11881 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11882 output file resulting from @LaTeX{} processing. Org will use an
11883 @code{\includegraphics} macro to insert the image@footnote{In the case of
11884 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11885 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11887 You can specify specify image width or height with, respectively,
11888 @code{:width} and @code{:height} attributes. It is also possible to add any
11889 other option with the @code{:options} attribute, as shown in the following
11893 #+ATTR_LATEX: :width 5cm :options angle=90
11894 [[./img/sed-hr4049.pdf]]
11897 If you need a specific command for the caption, use @code{:caption}
11898 attribute. It will override standard @code{#+CAPTION} value, if any.
11901 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11902 [[./img/sed-hr4049.pdf]]
11905 If you have specified a caption as described in @ref{Images and tables}, the
11906 picture will be wrapped into a @code{figure} environment and thus become
11907 a floating element. You can also ask Org to export an image as a float
11908 without specifying caption by setting the @code{:float} attribute. You may
11912 @code{t}: if you want to use the standard @samp{figure} environment. It is
11913 used by default if you provide a caption to the image.
11915 @code{multicolumn}: if you wish to include an image which spans multiple
11916 columns in a page. This will export the image wrapped in a @code{figure*}
11919 @code{wrap}: if you would like to let text flow around the image. It will
11920 make the figure occupy the left half of the page.
11922 @code{sideways}: if you would like the image to appear alone on a separate
11923 page rotated ninety degrees using the @code{sidewaysfigure}
11924 environment. Setting this @code{:float} option will ignore the
11925 @code{:placement} setting.
11927 @code{nil}: if you need to avoid any floating environment, even when
11928 a caption is provided.
11931 To modify the placement option of any floating environment, set the
11932 @code{placement} attribute.
11935 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11939 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11940 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11942 @subsubheading Plain lists in @LaTeX{} export
11943 @cindex plain lists, in @LaTeX{} export
11945 Plain lists accept two optional attributes: @code{:environment} and
11946 @code{:options}. The first one allows the use of a non-standard environment
11947 (e.g., @samp{inparaenum}). The second one specifies additional arguments for
11951 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
11952 - you need ``paralist'' package to reproduce this example.
11955 @subsubheading Source blocks in @LaTeX{} export
11956 @cindex source blocks, in @LaTeX{} export
11958 In addition to syntax defined in @ref{Literal examples}, names and captions
11959 (@pxref{Images and tables}), source blocks also accept two additional
11960 attributes: @code{:float} and @code{:options}.
11962 You may set the former to
11965 @code{t}: if you want to make the source block a float. It is the default
11966 value when a caption is provided.
11968 @code{multicolumn}: if you wish to include a source block which spans multiple
11971 @code{nil}: if you need to avoid any floating environment, even when a caption
11972 is provided. It is useful for source code that may not fit in a single page.
11976 #+ATTR_LATEX: :float nil
11977 #+BEGIN_SRC emacs-lisp
11978 Code that may not fit in a single page.
11982 @vindex org-latex-listings-options
11983 @vindex org-latex-minted-options
11984 The latter allows to specify options relative to the package used to
11985 highlight code in the output (e.g., @code{listings}). This is the local
11986 counterpart to @code{org-latex-listings-options} and
11987 @code{org-latex-minted-options} variables, which see.
11990 #+ATTR_LATEX: :options commentstyle=\bfseries
11991 #+BEGIN_SRC emacs-lisp
11992 (defun Fib (n) ; Count rabbits.
11993 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
11997 @subsubheading Special blocks in @LaTeX{} export
11998 @cindex special blocks, in @LaTeX{} export
11999 @cindex abstract, in @LaTeX{} export
12000 @cindex proof, in @LaTeX{} export
12002 In @LaTeX{} back-end, special blocks become environments of the same name.
12003 Value of @code{:options} attribute will be appended as-is to that
12004 environment's opening string. For example:
12008 We demonstrate how to solve the Syracuse problem.
12011 #+ATTR_LATEX: :options [Proof of important theorem]
12014 Therefore, any even number greater than 2 is the sum of two primes.
12023 We demonstrate how to solve the Syracuse problem.
12026 \begin@{proof@}[Proof of important theorem]
12028 Therefore, any even number greater than 2 is the sum of two primes.
12032 If you need to insert a specific caption command, use @code{:caption}
12033 attribute. It will override standard @code{#+CAPTION} value, if any. For
12037 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12043 @subsubheading Horizontal rules
12044 @cindex horizontal rules, in @LaTeX{} export
12046 Width and thickness of a given horizontal rule can be controlled with,
12047 respectively, @code{:width} and @code{:thickness} attributes:
12050 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12054 @node Markdown export
12055 @section Markdown export
12056 @cindex Markdown export
12058 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12059 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12062 It is built over HTML back-end: any construct not supported by Markdown
12063 syntax (e.g., tables) will be controlled and translated by @code{html}
12064 back-end (@pxref{HTML export}).
12066 @subheading Markdown export commands
12069 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12070 Export as a text file written in Markdown syntax. For an Org file,
12071 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
12072 will be overwritten without warning.
12073 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12074 Export to a temporary buffer. Do not create a file.
12076 Export as a text file with Markdown syntax, then open it.
12079 @subheading Header and sectioning structure
12081 @vindex org-md-headline-style
12082 Markdown export can generate both @code{atx} and @code{setext} types for
12083 headlines, according to @code{org-md-headline-style}. The former introduces
12084 a hard limit of two levels, whereas the latter pushes it to six. Headlines
12085 below that limit are exported as lists. You can also set a soft limit before
12086 that one (@pxref{Export settings}).
12088 @c begin opendocument
12090 @node OpenDocument Text export
12091 @section OpenDocument Text export
12093 @cindex OpenDocument
12094 @cindex export, OpenDocument
12095 @cindex LibreOffice
12097 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12098 (ODT) format. Documents created by this exporter use the
12099 @cite{OpenDocument-v1.2
12100 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12101 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12102 are compatible with LibreOffice 3.4.
12105 * Pre-requisites for ODT export:: What packages ODT exporter relies on
12106 * ODT export commands:: How to invoke ODT export
12107 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
12108 * Applying custom styles:: How to apply custom styles to the output
12109 * Links in ODT export:: How links will be interpreted and formatted
12110 * Tables in ODT export:: How Tables are exported
12111 * Images in ODT export:: How to insert images
12112 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
12113 * Labels and captions in ODT export:: How captions are rendered
12114 * Literal examples in ODT export:: How source and example blocks are formatted
12115 * Advanced topics in ODT export:: Read this if you are a power user
12118 @node Pre-requisites for ODT export
12119 @subsection Pre-requisites for ODT export
12121 The ODT exporter relies on the @file{zip} program to create the final
12122 output. Check the availability of this program before proceeding further.
12124 @node ODT export commands
12125 @subsection ODT export commands
12127 @subsubheading Exporting to ODT
12128 @anchor{x-export-to-odt}
12130 @cindex region, active
12131 @cindex active region
12132 @cindex transient-mark-mode
12134 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12135 @cindex property EXPORT_FILE_NAME
12137 Export as OpenDocument Text file.
12139 @vindex org-odt-preferred-output-format
12140 If @code{org-odt-preferred-output-format} is specified, automatically convert
12141 the exported file to that format. @xref{x-export-to-other-formats, ,
12142 Automatically exporting to other formats}.
12144 For an Org file @file{myfile.org}, the ODT file will be
12145 @file{myfile.odt}. The file will be overwritten without warning. If there
12146 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12147 turned on} only the region will be exported. If the selected region is a
12148 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12149 tree head will become the document title. If the tree head entry has, or
12150 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12154 Export as an OpenDocument Text file and open the resulting file.
12156 @vindex org-odt-preferred-output-format
12157 If @code{org-odt-preferred-output-format} is specified, open the converted
12158 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
12162 @node Extending ODT export
12163 @subsection Extending ODT export
12165 The ODT exporter can interface with a variety of document
12166 converters and supports popular converters out of the box. As a result, you
12167 can use it to export to formats like @samp{doc} or convert a document from
12168 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12170 @cindex @file{unoconv}
12171 @cindex LibreOffice
12172 If you have a working installation of LibreOffice, a document converter is
12173 pre-configured for you and you can use it right away. If you would like to
12174 use @file{unoconv} as your preferred converter, customize the variable
12175 @code{org-odt-convert-process} to point to @code{unoconv}. You can
12176 also use your own favorite converter or tweak the default settings of the
12177 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
12178 document converter}.
12180 @subsubheading Automatically exporting to other formats
12181 @anchor{x-export-to-other-formats}
12183 @vindex org-odt-preferred-output-format
12184 Very often, you will find yourself exporting to ODT format, only to
12185 immediately save the exported document to other formats like @samp{doc},
12186 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
12187 preferred output format by customizing the variable
12188 @code{org-odt-preferred-output-format}. This way, the export commands
12189 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12190 format that is of immediate interest to you.
12192 @subsubheading Converting between document formats
12193 @anchor{x-convert-to-other-formats}
12195 There are many document converters in the wild which support conversion to
12196 and from various file formats, including, but not limited to the
12197 ODT format. LibreOffice converter, mentioned above, is one such
12198 converter. Once a converter is configured, you can interact with it using
12199 the following command.
12201 @vindex org-odt-convert
12204 @item M-x org-odt-convert RET
12205 Convert an existing document from one format to another. With a prefix
12206 argument, also open the newly produced file.
12209 @node Applying custom styles
12210 @subsection Applying custom styles
12211 @cindex styles, custom
12212 @cindex template, custom
12214 The ODT exporter ships with a set of OpenDocument styles
12215 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12216 output. These factory styles, however, may not cater to your specific
12217 tastes. To customize the output, you can either modify the above styles
12218 files directly, or generate the required styles using an application like
12219 LibreOffice. The latter method is suitable for expert and non-expert
12220 users alike, and is described here.
12222 @subsubheading Applying custom styles: the easy way
12226 Create a sample @file{example.org} file with the below settings and export it
12230 #+OPTIONS: H:10 num:t
12234 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
12235 to locate the target styles---these typically have the @samp{Org} prefix---and
12236 modify those to your taste. Save the modified file either as an
12237 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12240 @cindex #+ODT_STYLES_FILE
12241 @vindex org-odt-styles-file
12242 Customize the variable @code{org-odt-styles-file} and point it to the
12243 newly created file. For additional configuration options
12244 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12246 If you would like to choose a style on a per-file basis, you can use the
12247 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
12250 #+ODT_STYLES_FILE: "/path/to/example.ott"
12256 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12261 @subsubheading Using third-party styles and templates
12263 You can use third-party styles and templates for customizing your output.
12264 This will produce the desired output only if the template provides all
12265 style names that the @samp{ODT} exporter relies on. Unless this condition is
12266 met, the output is going to be less than satisfactory. So it is highly
12267 recommended that you only work with templates that are directly derived from
12268 the factory settings.
12270 @node Links in ODT export
12271 @subsection Links in ODT export
12272 @cindex links, in ODT export
12274 ODT exporter creates native cross-references for internal links. It creates
12275 Internet-style links for all other links.
12277 A link with no description and destined to a regular (un-itemized) outline
12278 heading is replaced with a cross-reference and section number of the heading.
12280 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12281 with a cross-reference and sequence number of the labeled entity.
12282 @xref{Labels and captions in ODT export}.
12284 @node Tables in ODT export
12285 @subsection Tables in ODT export
12286 @cindex tables, in ODT export
12288 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12289 tables is supported. However, export of complex @file{table.el} tables---tables
12290 that have column or row spans---is not supported. Such tables are
12291 stripped from the exported document.
12293 By default, a table is exported with top and bottom frames and with rules
12294 separating row and column groups (@pxref{Column groups}). Furthermore, all
12295 tables are typeset to occupy the same width. If the table specifies
12296 alignment and relative width for its columns (@pxref{Column width and
12297 alignment}) then these are honored on export.@footnote{The column widths are
12298 interpreted as weighted ratios with the default weight being 1}
12301 You can control the width of the table by specifying @code{:rel-width}
12302 property using an @code{#+ATTR_ODT} line.
12304 For example, consider the following table which makes use of all the rules
12308 #+ATTR_ODT: :rel-width 50
12309 | Area/Month | Jan | Feb | Mar | Sum |
12310 |---------------+-------+-------+-------+-------|
12312 | <l13> | <r5> | <r5> | <r5> | <r6> |
12313 | North America | 1 | 21 | 926 | 948 |
12314 | Middle East | 6 | 75 | 844 | 925 |
12315 | Asia Pacific | 9 | 27 | 790 | 826 |
12316 |---------------+-------+-------+-------+-------|
12317 | Sum | 16 | 123 | 2560 | 2699 |
12320 On export, the table will occupy 50% of text area. The columns will be sized
12321 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12322 and rest of the columns will be right-aligned. There will be vertical rules
12323 after separating the header and last columns from other columns. There will
12324 be horizontal rules separating the header and last rows from other rows.
12326 If you are not satisfied with the above formatting options, you can create
12327 custom table styles and associate them with a table using the
12328 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12330 @node Images in ODT export
12331 @subsection Images in ODT export
12332 @cindex images, embedding in ODT
12333 @cindex embedding images in ODT
12335 @subsubheading Embedding images
12336 You can embed images within the exported document by providing a link to the
12337 desired image file with no link description. For example, to embed
12338 @samp{img.png} do either of the following:
12348 @subsubheading Embedding clickable images
12349 You can create clickable images by providing a link whose description is a
12350 link to an image file. For example, to embed a image
12351 @file{org-mode-unicorn.png} which when clicked jumps to
12352 @uref{http://Orgmode.org} website, do the following
12355 [[http://orgmode.org][./org-mode-unicorn.png]]
12358 @subsubheading Sizing and scaling of embedded images
12361 You can control the size and scale of the embedded images using the
12362 @code{#+ATTR_ODT} attribute.
12364 @cindex identify, ImageMagick
12365 @vindex org-odt-pixels-per-inch
12366 The exporter specifies the desired size of the image in the final document in
12367 units of centimeters. In order to scale the embedded images, the exporter
12368 queries for pixel dimensions of the images using one of a) ImageMagick's
12369 @file{identify} program or b) Emacs `create-image' and `image-size'
12370 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12371 routinely produce documents that have large images or you export your Org
12372 files that has images using a Emacs batch script, then the use of
12373 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12374 converted in to units of centimeters using
12375 @code{org-odt-pixels-per-inch}. The default value of this variable is
12376 set to @code{display-pixels-per-inch}. You can tweak this variable to
12377 achieve the best results.
12379 The examples below illustrate the various possibilities.
12382 @item Explicitly size the image
12383 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12386 #+ATTR_ODT: :width 10 :height 10
12390 @item Scale the image
12391 To embed @file{img.png} at half its size, do the following:
12394 #+ATTR_ODT: :scale 0.5
12398 @item Scale the image to a specific width
12399 To embed @file{img.png} with a width of 10 cm while retaining the original
12400 height:width ratio, do the following:
12403 #+ATTR_ODT: :width 10
12407 @item Scale the image to a specific height
12408 To embed @file{img.png} with a height of 10 cm while retaining the original
12409 height:width ratio, do the following
12412 #+ATTR_ODT: :height 10
12417 @subsubheading Anchoring of images
12420 You can control the manner in which an image is anchored by setting the
12421 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
12422 of the following three values for the @code{:anchor} property:
12423 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12425 To create an image that is anchored to a page, do the following:
12427 #+ATTR_ODT: :anchor "page"
12431 @node Math formatting in ODT export
12432 @subsection Math formatting in ODT export
12434 The ODT exporter has special support for handling math.
12437 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12438 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12441 @node Working with @LaTeX{} math snippets
12442 @subsubheading Working with @LaTeX{} math snippets
12444 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12445 document in one of the following ways:
12451 This option is activated on a per-file basis with
12457 With this option, @LaTeX{} fragments are first converted into MathML
12458 fragments using an external @LaTeX{}-to-MathML converter program. The
12459 resulting MathML fragments are then embedded as an OpenDocument Formula in
12460 the exported document.
12462 @vindex org-latex-to-mathml-convert-command
12463 @vindex org-latex-to-mathml-jar-file
12465 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12466 @code{org-latex-to-mathml-convert-command} and
12467 @code{org-latex-to-mathml-jar-file}.
12469 If you prefer to use @file{MathToWeb}@footnote{See
12470 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
12471 converter, you can configure the above variables as shown below.
12474 (setq org-latex-to-mathml-convert-command
12475 "java -jar %j -unicode -force -df %o %I"
12476 org-latex-to-mathml-jar-file
12477 "/path/to/mathtoweb.jar")
12480 You can use the following commands to quickly verify the reliability of
12481 the @LaTeX{}-to-MathML converter.
12484 @item M-x org-odt-export-as-odf RET
12485 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12487 @item M-x org-odt-export-as-odf-and-open RET
12488 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12489 and open the formula file with the system-registered application.
12493 @cindex imagemagick
12496 This option is activated on a per-file basis with
12499 #+OPTIONS: tex:dvipng
12505 #+OPTIONS: tex:imagemagick
12508 With this option, @LaTeX{} fragments are processed into PNG images and the
12509 resulting images are embedded in the exported document. This method requires
12510 that the @file{dvipng} program or @file{imagemagick} suite be available on
12514 @node Working with MathML or OpenDocument formula files
12515 @subsubheading Working with MathML or OpenDocument formula files
12517 For various reasons, you may find embedding @LaTeX{} math snippets in an
12518 ODT document less than reliable. In that case, you can embed a
12519 math equation by linking to its MathML (@file{.mml}) source or its
12520 OpenDocument formula (@file{.odf}) file as shown below:
12532 @node Labels and captions in ODT export
12533 @subsection Labels and captions in ODT export
12535 You can label and caption various category of objects---an inline image, a
12536 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12537 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12538 each labeled or captioned object of a given category separately. As a
12539 result, each such object is assigned a sequence number based on order of it's
12540 appearance in the Org file.
12542 In the exported document, a user-provided caption is augmented with the
12543 category and sequence number. Consider the following inline image in an Org
12547 #+CAPTION: Bell curve
12548 #+LABEL: fig:SED-HR4049
12552 It could be rendered as shown below in the exported document.
12555 Figure 2: Bell curve
12558 @vindex org-odt-category-map-alist
12559 You can modify the category component of the caption by customizing the
12560 option @code{org-odt-category-map-alist}. For example, to tag all embedded
12561 images with the string @samp{Illustration} (instead of the default
12562 @samp{Figure}) use the following setting:
12565 (setq org-odt-category-map-alist
12566 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12569 With this, previous image will be captioned as below in the exported
12573 Illustration 2: Bell curve
12576 @node Literal examples in ODT export
12577 @subsection Literal examples in ODT export
12579 Export of literal examples (@pxref{Literal examples}) with full fontification
12580 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
12581 generate all style definitions needed for a fancy listing.@footnote{Your
12582 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12583 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
12584 as prefix and inherit their color from the faces used by Emacs
12585 @code{font-lock} library for the source language.
12587 @vindex org-odt-fontify-srcblocks
12588 If you prefer to use your own custom styles for fontification, you can do
12589 so by customizing the option
12590 @code{org-odt-create-custom-styles-for-srcblocks}.
12592 @vindex org-odt-create-custom-styles-for-srcblocks
12593 You can turn off fontification of literal examples by customizing the
12594 option @code{org-odt-fontify-srcblocks}.
12596 @node Advanced topics in ODT export
12597 @subsection Advanced topics in ODT export
12599 If you rely heavily on ODT export, you may want to exploit the full
12600 set of features that the exporter offers. This section describes features
12601 that would be of interest to power users.
12604 * Configuring a document converter:: How to register a document converter
12605 * Working with OpenDocument style files:: Explore the internals
12606 * Creating one-off styles:: How to produce custom highlighting etc
12607 * Customizing tables in ODT export:: How to define and use Table templates
12608 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
12611 @node Configuring a document converter
12612 @subsubheading Configuring a document converter
12614 @cindex doc, docx, rtf
12617 The ODT exporter can work with popular converters with little or no
12618 extra configuration from your side. @xref{Extending ODT export}.
12619 If you are using a converter that is not supported by default or if you would
12620 like to tweak the default converter settings, proceed as below.
12623 @item Register the converter
12625 @vindex org-odt-convert-processes
12626 Name your converter and add it to the list of known converters by
12627 customizing the option @code{org-odt-convert-processes}. Also specify how
12628 the converter can be invoked via command-line to effect the conversion.
12630 @item Configure its capabilities
12632 @vindex org-odt-convert-capabilities
12633 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12634 converter can handle by customizing the variable
12635 @code{org-odt-convert-capabilities}. Use the default value for this
12636 variable as a guide for configuring your converter. As suggested by the
12637 default setting, you can specify the full set of formats supported by the
12638 converter and not limit yourself to specifying formats that are related to
12639 just the OpenDocument Text format.
12641 @item Choose the converter
12643 @vindex org-odt-convert-process
12644 Select the newly added converter as the preferred one by customizing the
12645 option @code{org-odt-convert-process}.
12648 @node Working with OpenDocument style files
12649 @subsubheading Working with OpenDocument style files
12650 @cindex styles, custom
12651 @cindex template, custom
12653 This section explores the internals of the ODT exporter and the
12654 means by which it produces styled documents. Read this section if you are
12655 interested in exploring the automatic and custom OpenDocument styles used by
12658 @anchor{x-factory-styles}
12659 @subsubheading a) Factory styles
12661 The ODT exporter relies on two files for generating its output.
12662 These files are bundled with the distribution under the directory pointed to
12663 by the variable @code{org-odt-styles-dir}. The two files are:
12666 @anchor{x-orgodtstyles-xml}
12668 @file{OrgOdtStyles.xml}
12670 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12671 document. This file gets modified for the following purposes:
12675 To control outline numbering based on user settings.
12678 To add styles generated by @file{htmlfontify.el} for fontification of code
12682 @anchor{x-orgodtcontenttemplate-xml}
12684 @file{OrgOdtContentTemplate.xml}
12686 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12687 document. The contents of the Org outline are inserted between the
12688 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12690 Apart from serving as a template file for the final @file{content.xml}, the
12691 file serves the following purposes:
12695 It contains automatic styles for formatting of tables which are referenced by
12699 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12700 elements that control how various entities---tables, images, equations,
12701 etc.---are numbered.
12705 @anchor{x-overriding-factory-styles}
12706 @subsubheading b) Overriding factory styles
12707 The following two variables control the location from which the ODT
12708 exporter picks up the custom styles and content template files. You can
12709 customize these variables to override the factory styles used by the
12713 @anchor{x-org-odt-styles-file}
12715 @code{org-odt-styles-file}
12717 Use this variable to specify the @file{styles.xml} that will be used in the
12718 final output. You can specify one of the following values:
12721 @item A @file{styles.xml} file
12723 Use this file instead of the default @file{styles.xml}
12725 @item A @file{.odt} or @file{.ott} file
12727 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12730 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12732 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12733 Template file. Additionally extract the specified member files and embed
12734 those within the final @samp{ODT} document.
12736 Use this option if the @file{styles.xml} file references additional files
12737 like header and footer images.
12741 Use the default @file{styles.xml}
12744 @anchor{x-org-odt-content-template-file}
12746 @code{org-odt-content-template-file}
12748 Use this variable to specify the blank @file{content.xml} that will be used
12749 in the final output.
12752 @node Creating one-off styles
12753 @subsubheading Creating one-off styles
12755 There are times when you would want one-off formatting in the exported
12756 document. You can achieve this by embedding raw OpenDocument XML in the Org
12757 file. The use of this feature is better illustrated with couple of examples.
12760 @item Embedding ODT tags as part of regular text
12762 You can inline OpenDocument syntax by enclosing it within
12763 @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do
12767 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12768 text</text:span>@@@@. But this is a regular text.
12771 @strong{Hint:} To see the above example in action, edit your
12772 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12773 custom @samp{Highlight} style as shown below.
12776 <style:style style:name="Highlight" style:family="text">
12777 <style:text-properties fo:background-color="#ff0000"/>
12781 @item Embedding a one-line OpenDocument XML
12783 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12784 directive. For example, to force a page break do the following:
12787 #+ODT: <text:p text:style-name="PageBreak"/>
12790 @strong{Hint:} To see the above example in action, edit your
12791 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12792 custom @samp{PageBreak} style as shown below.
12795 <style:style style:name="PageBreak" style:family="paragraph"
12796 style:parent-style-name="Text_20_body">
12797 <style:paragraph-properties fo:break-before="page"/>
12801 @item Embedding a block of OpenDocument XML
12803 You can add a large block of OpenDocument XML using the
12804 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12806 For example, to create a one-off paragraph that uses bold text, do the
12811 <text:p text:style-name="Text_20_body_20_bold">
12812 This paragraph is specially formatted and uses bold text.
12819 @node Customizing tables in ODT export
12820 @subsubheading Customizing tables in ODT export
12821 @cindex tables, in ODT export
12824 You can override the default formatting of the table by specifying a custom
12825 table style with the @code{#+ATTR_ODT} line. For a discussion on default
12826 formatting of tables @pxref{Tables in ODT export}.
12828 This feature closely mimics the way table templates are defined in the
12830 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12831 OpenDocument-v1.2 Specification}}
12833 @vindex org-odt-table-styles
12834 To have a quick preview of this feature, install the below setting and
12835 export the table that follows:
12838 (setq org-odt-table-styles
12839 (append org-odt-table-styles
12840 '(("TableWithHeaderRowAndColumn" "Custom"
12841 ((use-first-row-styles . t)
12842 (use-first-column-styles . t)))
12843 ("TableWithFirstRowandLastRow" "Custom"
12844 ((use-first-row-styles . t)
12845 (use-last-row-styles . t))))))
12849 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12850 | Name | Phone | Age |
12851 | Peter | 1234 | 17 |
12852 | Anna | 4321 | 25 |
12855 In the above example, you used a template named @samp{Custom} and installed
12856 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12857 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
12858 styles needed for producing the above template have been pre-defined for
12859 you. These styles are available under the section marked @samp{Custom
12860 Table Template} in @file{OrgOdtContentTemplate.xml}
12861 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
12862 additional templates you have to define these styles yourselves.
12864 To use this feature proceed as follows:
12868 Create a table template@footnote{See the @code{<table:table-template>}
12869 element of the OpenDocument-v1.2 specification}
12871 A table template is nothing but a set of @samp{table-cell} and
12872 @samp{paragraph} styles for each of the following table cell categories:
12886 The names for the above styles must be chosen based on the name of the table
12887 template using a well-defined convention.
12889 The naming convention is better illustrated with an example. For a table
12890 template with the name @samp{Custom}, the needed style names are listed in
12891 the following table.
12893 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12894 @headitem Table cell type
12895 @tab @code{table-cell} style
12896 @tab @code{paragraph} style
12901 @tab @samp{CustomTableCell}
12902 @tab @samp{CustomTableParagraph}
12904 @tab @samp{CustomFirstColumnTableCell}
12905 @tab @samp{CustomFirstColumnTableParagraph}
12907 @tab @samp{CustomLastColumnTableCell}
12908 @tab @samp{CustomLastColumnTableParagraph}
12910 @tab @samp{CustomFirstRowTableCell}
12911 @tab @samp{CustomFirstRowTableParagraph}
12913 @tab @samp{CustomLastRowTableCell}
12914 @tab @samp{CustomLastRowTableParagraph}
12916 @tab @samp{CustomEvenRowTableCell}
12917 @tab @samp{CustomEvenRowTableParagraph}
12919 @tab @samp{CustomOddRowTableCell}
12920 @tab @samp{CustomOddRowTableParagraph}
12922 @tab @samp{CustomEvenColumnTableCell}
12923 @tab @samp{CustomEvenColumnTableParagraph}
12925 @tab @samp{CustomOddColumnTableCell}
12926 @tab @samp{CustomOddColumnTableParagraph}
12929 To create a table template with the name @samp{Custom}, define the above
12931 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12932 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12936 Define a table style@footnote{See the attributes @code{table:template-name},
12937 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12938 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12939 @code{table:use-banding-rows-styles}, and
12940 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12941 the OpenDocument-v1.2 specification}
12943 @vindex org-odt-table-styles
12944 To define a table style, create an entry for the style in the variable
12945 @code{org-odt-table-styles} and specify the following:
12948 @item the name of the table template created in step (1)
12949 @item the set of cell styles in that template that are to be activated
12952 For example, the entry below defines two different table styles
12953 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12954 based on the same template @samp{Custom}. The styles achieve their intended
12955 effect by selectively activating the individual cell styles in that template.
12958 (setq org-odt-table-styles
12959 (append org-odt-table-styles
12960 '(("TableWithHeaderRowAndColumn" "Custom"
12961 ((use-first-row-styles . t)
12962 (use-first-column-styles . t)))
12963 ("TableWithFirstRowandLastRow" "Custom"
12964 ((use-first-row-styles . t)
12965 (use-last-row-styles . t))))))
12969 Associate a table with the table style
12971 To do this, specify the table style created in step (2) as part of
12972 the @code{ATTR_ODT} line as shown below.
12975 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12976 | Name | Phone | Age |
12977 | Peter | 1234 | 17 |
12978 | Anna | 4321 | 25 |
12982 @node Validating OpenDocument XML
12983 @subsubheading Validating OpenDocument XML
12985 Occasionally, you will discover that the document created by the
12986 ODT exporter cannot be opened by your favorite application. One of
12987 the common reasons for this is that the @file{.odt} file is corrupt. In such
12988 cases, you may want to validate the document against the OpenDocument RELAX
12989 NG Compact Syntax (RNC) schema.
12991 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12992 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
12993 general help with validation (and schema-sensitive editing) of XML files:
12994 @inforef{Introduction,,nxml-mode}.
12996 @vindex org-odt-schema-dir
12997 If you have ready access to OpenDocument @file{.rnc} files and the needed
12998 schema-locating rules in a single folder, you can customize the variable
12999 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
13000 will take care of updating the @code{rng-schema-locating-files} for you.
13002 @c end opendocument
13005 @section Org export
13008 @code{org} export back-end creates a normalized version of the Org document
13009 in current buffer. In particular, it evaluates Babel code (@pxref{Evaluating
13010 code blocks}) and removes other back-ends specific contents.
13012 @subheading Org export commands
13015 @orgcmd{C-c C-e O o,org-org-export-to-org}
13016 Export as an Org document. For an Org file, @file{myfile.org}, the resulting
13017 file will be @file{myfile.org.org}. The file will be overwritten without
13019 @orgcmd{C-c C-e O O,org-org-export-as-org}
13020 Export to a temporary buffer. Do not create a file.
13022 Export to an Org file, then open it.
13025 @node Texinfo export
13026 @section Texinfo export
13027 @cindex Texinfo export
13029 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13033 * Texinfo export commands:: How to invoke Texinfo export
13034 * Document preamble:: File header, title and copyright page
13035 * Headings and sectioning structure:: Building document structure
13036 * Indices:: Creating indices
13037 * Quoting Texinfo code:: Incorporating literal Texinfo code
13038 * Texinfo specific attributes:: Controlling Texinfo output
13042 @node Texinfo export commands
13043 @subsection Texinfo export commands
13045 @vindex org-texinfo-info-process
13047 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13048 Export as a Texinfo file. For an Org file, @file{myfile.org}, the resulting
13049 file will be @file{myfile.texi}. The file will be overwritten without
13051 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13052 Export to Texinfo and then process to an Info file@footnote{By setting
13053 @code{org-texinfo-info-process}, it is possible to generate other formats,
13054 including DocBook.}.
13057 @node Document preamble
13058 @subsection Document preamble
13060 When processing a document, @samp{texinfo} back-end generates a minimal file
13061 header along with a title page, a copyright page, and a menu. You control
13062 the latter through the structure of the document (@pxref{Headings and
13063 sectioning structure}). Various keywords allow to tweak the other parts. It
13064 is also possible to give directions to install the document in the @samp{Top}
13067 @subsubheading File header
13069 @cindex #+TEXINFO_FILENAME
13070 Upon creating the header of a Texinfo file, the back-end guesses a name for
13071 the Info file to be compiled. This may not be a sensible choice, e.g., if
13072 you want to produce the final document in a different directory. Specify an
13073 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13076 @vindex org-texinfo-coding-system
13077 @vindex org-texinfo-classes
13078 @cindex #+TEXINFO_HEADER
13079 @cindex #+TEXINFO_CLASS
13080 Along with the output file name, the header contains information about the
13081 language (@pxref{Export settings}) and current encoding used@footnote{See
13082 @code{org-texinfo-coding-system} for more information.}. Insert
13083 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13084 @@code@{@@synindex@}.
13086 If you happen to regularly install the same set of commands, it may be easier
13087 to define your own class in @code{org-texinfo-classes}, which see. Set
13088 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13090 @subsubheading Title and copyright page
13092 @cindex #+TEXINFO_PRINTED_TITLE
13094 The default template includes a title page for hard copy output. The title
13095 and author displayed on this page are extracted from, respectively,
13096 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}). It is
13097 also possible to print a different, more specific, title with
13098 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13099 @code{#+SUBTITLE} keyword. Both expect raw Texinfo code in their value.
13101 @cindex #+SUBAUTHOR
13102 Likewise, information brought by @code{#+AUTHOR} may not be enough. You can
13103 include other authors with several @code{#+SUBAUTHOR} keywords. Values are
13104 also expected to be written in Texinfo code.
13107 #+AUTHOR: Jane Smith
13108 #+SUBAUTHOR: John Doe
13109 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13112 @cindex property, COPYING
13113 Copying material is defined in a dedicated headline with a non-nil
13114 @code{:COPYING:} property. The contents are inserted within
13115 a @code{@@copying} command at the beginning of the document whereas the
13116 heading itself does not appear in the structure of the document.
13118 Copyright information is printed on the back of the title page.
13126 This is a short example of a complete Texinfo file, version 1.0.
13128 Copyright \copy 2014 Free Software Foundation, Inc.
13131 @subsubheading The Top node
13133 @cindex #+TEXINFO_DIR_CATEGORY
13134 @cindex #+TEXINFO_DIR_TITLE
13135 @cindex #+TEXINFO_DIR_DESC
13136 You may ultimately want to install your new Info file to your system. You
13137 can write an appropriate entry in the top level directory specifying its
13138 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13139 @code{#+TEXINFO_DIR_TITLE}. Optionally, you can add a short description
13140 using @code{#+TEXINFO_DIR_DESC}. The following example would write an entry
13141 similar to Org's in the @samp{Top} node.
13144 #+TEXINFO_DIR_CATEGORY: Emacs
13145 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13146 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13149 @node Headings and sectioning structure
13150 @subsection Headings and sectioning structure
13152 @vindex org-texinfo-classes
13153 @vindex org-texinfo-default-class
13154 @cindex #+TEXINFO_CLASS
13155 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13156 Texinfo structuring commands. For example, a top level headline appears as
13157 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13158 otherwise. If you need to use a different set of commands, e.g., to start
13159 with @code{@@part} instead of @code{@@chapter}, install a new class in
13160 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13161 keyword. Export process defaults to @code{org-texinfo-default-class} when
13162 there is no such keyword in the document.
13164 If a headline's level has no associated structuring command, or is below
13165 a certain threshold @pxref{Export settings}, that headline becomes a list in
13168 @cindex property, APPENDIX
13169 As an exception, a headline with a non-nil @code{:APPENDIX:} property becomes
13170 an appendix, independently on its level and the class used.
13172 @cindex property, DESCRIPTION
13173 Each regular sectioning structure creates a menu entry, named after the
13174 heading. You can provide a different, e.g., shorter, title in
13175 @code{:ALT_TITLE:} property (@pxref{Table of contents}). Optionally, you can
13176 specify a description for the item in @code{:DESCRIPTION:} property. E.g.,
13179 * Controlling Screen Display
13181 :ALT_TITLE: Display
13182 :DESCRIPTION: Controlling Screen Display
13187 @subsection Indices
13195 Index entries are created using dedicated keywords. @samp{texinfo} back-end
13196 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13197 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}. For
13198 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13202 #+CINDEX: Defining indexing entries
13205 @cindex property, INDEX
13206 To generate an index, you need to set the @code{:INDEX:} property of
13207 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13208 The headline is then exported as an unnumbered chapter or section command and
13209 the index is inserted after its contents.
13218 @node Quoting Texinfo code
13219 @subsection Quoting Texinfo code
13221 It is possible to insert raw Texinfo code using any of the following
13225 @cindex #+BEGIN_TEXINFO
13227 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13229 #+TEXINFO: @@need800
13230 This paragraph is preceded by...
13233 @@auindex Johnson, Mark
13234 @@auindex Lakoff, George
13238 @node Texinfo specific attributes
13239 @subsection Texinfo specific attributes
13241 @cindex #+ATTR_TEXINFO
13242 @samp{texinfo} back-end understands several attributes in plain lists and
13243 tables. They must be specified using an @code{#+ATTR_TEXINFO} keyword,
13244 written just above the list or table.
13246 @subsubheading Plain lists
13248 In Texinfo output, description lists appear as two-column tables, using the
13249 default command @code{@@table}. You can use @code{@@ftable} or
13250 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13251 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13253 @vindex org-texinfo-def-table-markup
13254 In any case, these constructs require a highlighting command for entries in
13255 the list. You can provide one with @code{:indic} attribute. If you do not,
13256 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13260 #+ATTR_TEXINFO: :indic @@asis
13261 - foo :: This is the text for /foo/, with no highlighting.
13264 @subsubheading Tables
13266 When exporting a table, column widths are deduced from the longest cell in
13267 each column. You can also define them explicitly as fractions of the line
13268 length, using @code{:columns} attribute.
13271 #+ATTR_TEXINFO: :columns .5 .5
13272 | a cell | another cell |
13276 @subsection An example
13278 Here is a thorough example. @inforef{GNU Sample Texts,,texinfo} for an
13279 equivalent Texinfo code.
13282 #+MACRO: version 2.0
13283 #+MACRO: updated last updated 4 March 2014
13285 #+OPTIONS: ':t toc:t author:t email:t
13286 #+TITLE: GNU Sample @{@{@{version@}@}@}
13287 #+AUTHOR: A.U. Thor
13288 #+EMAIL: bug-sample@@gnu.org
13291 #+TEXINFO_FILENAME: sample.info
13292 #+TEXINFO_HEADER: @@syncodeindex pg cp
13294 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13295 #+TEXINFO_DIR_TITLE: sample: (sample)
13296 #+TEXINFO_DIR_DESC: Invoking sample
13298 #+TEXINFO_PRINTED_TITLE: GNU Sample
13299 #+SUBTITLE: for version 2.0, last updated 4 March 2014
13306 This manual is for GNU Sample (version @{@{@{version@}@}@},
13307 @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13309 Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13313 Permission is granted to copy, distribute and/or modify this
13314 document under the terms of the GNU Free Documentation License,
13315 Version 1.3 or any later version published by the Free Software
13316 Foundation; with no Invariant Sections, with no Front-Cover Texts,
13317 and with no Back-Cover Texts. A copy of the license is included in
13318 the section entitled "GNU Free Documentation License".
13324 #+CINDEX: invoking @@command@{sample@}
13326 This is a sample manual. There is no sample program to invoke, but
13327 if there were, you could see its basic usage and command line
13330 * GNU Free Documentation License
13335 #+TEXINFO: @@include fdl.texi
13343 @node iCalendar export
13344 @section iCalendar export
13345 @cindex iCalendar export
13347 @vindex org-icalendar-include-todo
13348 @vindex org-icalendar-use-deadline
13349 @vindex org-icalendar-use-scheduled
13350 @vindex org-icalendar-categories
13351 @vindex org-icalendar-alarm-time
13352 Some people use Org mode for keeping track of projects, but still prefer a
13353 standard calendar application for anniversaries and appointments. In this
13354 case it can be useful to show deadlines and other time-stamped items in Org
13355 files in the calendar application. Org mode can export calendar information
13356 in the standard iCalendar format. If you also want to have TODO entries
13357 included in the export, configure the variable
13358 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
13359 and TODO items as VTODO@. It will also create events from deadlines that are
13360 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
13361 to set the start and due dates for the TODO entry@footnote{See the variables
13362 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13363 As categories, it will use the tags locally defined in the heading, and the
13364 file/tree category@footnote{To add inherited tags or the TODO state,
13365 configure the variable @code{org-icalendar-categories}.}. See the variable
13366 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13369 @vindex org-icalendar-store-UID
13370 @cindex property, ID
13371 The iCalendar standard requires each entry to have a globally unique
13372 identifier (UID). Org creates these identifiers during export. If you set
13373 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13374 @code{:ID:} property of the entry and re-used next time you report this
13375 entry. Since a single entry can give rise to multiple iCalendar entries (as
13376 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13377 prefixes to the UID, depending on what triggered the inclusion of the entry.
13378 In this way the UID remains unique, but a synchronization program can still
13379 figure out from which entry all the different instances originate.
13382 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13383 Create iCalendar entries for the current buffer and store them in the same
13384 directory, using a file extension @file{.ics}.
13385 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13386 @vindex org-agenda-files
13387 Like @kbd{C-c C-e c f}, but do this for all files in
13388 @code{org-agenda-files}. For each of these files, a separate iCalendar
13389 file will be written.
13390 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13391 @vindex org-icalendar-combined-agenda-file
13392 Create a single large iCalendar file from all files in
13393 @code{org-agenda-files} and write it to the file given by
13394 @code{org-icalendar-combined-agenda-file}.
13397 @vindex org-use-property-inheritance
13398 @vindex org-icalendar-include-body
13399 @cindex property, SUMMARY
13400 @cindex property, DESCRIPTION
13401 @cindex property, LOCATION
13402 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13403 property can be inherited from higher in the hierarchy if you configure
13404 @code{org-use-property-inheritance} accordingly.} properties if the selected
13405 entries have them. If not, the summary will be derived from the headline,
13406 and the description from the body (limited to
13407 @code{org-icalendar-include-body} characters).
13409 How this calendar is best read and updated, depends on the application
13410 you are using. The FAQ covers this issue.
13412 @node Other built-in back-ends
13413 @section Other built-in back-ends
13414 @cindex export back-ends, built-in
13415 @vindex org-export-backends
13417 On top of the aforementioned back-ends, Org comes with other built-in ones:
13420 @item @file{ox-man.el}: export to a man page.
13423 To activate these export back-end, customize @code{org-export-backends} or
13424 load them directly with e.g., @code{(require 'ox-man)}. This will add new
13425 keys in the export dispatcher (@pxref{The export dispatcher}).
13427 See the comment section of these files for more information on how to use
13430 @node Export in foreign buffers
13431 @section Export in foreign buffers
13433 Most built-in back-ends come with a command to convert the selected region
13434 into a selected format and replace this region by the exported output. Here
13435 is a list of such conversion commands:
13438 @item org-html-convert-region-to-html
13439 Convert the selected region into HTML.
13440 @item org-latex-convert-region-to-latex
13441 Convert the selected region into @LaTeX{}.
13442 @item org-texinfo-convert-region-to-texinfo
13443 Convert the selected region into @code{Texinfo}.
13444 @item org-md-convert-region-to-md
13445 Convert the selected region into @code{MarkDown}.
13448 This is particularly useful for converting tables and lists in foreign
13449 buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13450 use Org commands for editing a list, and finally select and convert the list
13451 with @code{M-x org-html-convert-region-to-html RET}.
13453 @node Advanced configuration
13454 @section Advanced configuration
13458 @vindex org-export-before-processing-hook
13459 @vindex org-export-before-parsing-hook
13460 Two hooks are run during the first steps of the export process. The first
13461 one, @code{org-export-before-processing-hook} is called before expanding
13462 macros, Babel code and include keywords in the buffer. The second one,
13463 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13464 before parsing the buffer. Their main use is for heavy duties, that is
13465 duties involving structural modifications of the document. For example, one
13466 may want to remove every headline in the buffer during export. The following
13467 code can achieve this:
13471 (defun my-headline-removal (backend)
13472 "Remove all headlines in the current buffer.
13473 BACKEND is the export back-end being used, as a symbol."
13475 (lambda () (delete-region (point) (progn (forward-line) (point))))))
13477 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13481 Note that functions used in these hooks require a mandatory argument,
13482 a symbol representing the back-end used.
13484 @subheading Filters
13486 @cindex Filters, exporting
13487 Filters are lists of functions applied on a specific part of the output from
13488 a given back-end. More explicitly, each time a back-end transforms an Org
13489 object or element into another language, all functions within a given filter
13490 type are called in turn on the string produced. The string returned by the
13491 last function will be the one used in the final output.
13493 There are filter sets for each type of element or object, for plain text,
13494 for the parse tree, for the export options and for the final output. They
13495 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13496 where @code{TYPE} is the type targeted by the filter. Valid types are:
13498 @multitable @columnfractions .33 .33 .33
13511 @item example-block
13513 @tab export-snippet
13516 @tab footnote-definition
13517 @item footnote-reference
13519 @tab horizontal-rule
13520 @item inline-babel-call
13521 @tab inline-src-block
13526 @item latex-environment
13527 @tab latex-fragment
13537 @tab property-drawer
13544 @item statistics-cookie
13545 @tab strike-through
13558 For example, the following snippet allows me to use non-breaking spaces in
13559 the Org buffer and get them translated into @LaTeX{} without using the
13560 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13564 (defun my-latex-filter-nobreaks (text backend info)
13565 "Ensure \"Â \" are properly handled in LaTeX export."
13566 (when (org-export-derived-backend-p backend 'latex)
13567 (replace-regexp-in-string "Â " "~" text)))
13569 (add-to-list 'org-export-filter-plain-text-functions
13570 'my-latex-filter-nobreaks)
13574 Three arguments must be provided to a filter: the code being changed, the
13575 back-end used, and some information about the export process. You can safely
13576 ignore the third argument for most purposes. Note the use of
13577 @code{org-export-derived-backend-p}, which ensures that the filter will only
13578 be applied when using @code{latex} back-end or any other back-end derived
13579 from it (e.g., @code{beamer}).
13581 @subheading Defining filters for individual files
13583 You can customize the export for just a specific file by binding export
13584 filter variables using @code{#+BIND}. Here is an example where we introduce
13585 two filters, one to remove brackets from time stamps, and one to entirely
13586 remove any strike-through text. The functions doing the filtering are
13587 defined in an src block that allows the filter function definitions to exist
13588 in the file itself and ensures that the functions will be there when needed.
13591 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
13592 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
13593 #+begin_src emacs-lisp :exports results :results none
13594 (defun tmp-f-timestamp (s backend info)
13595 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
13596 (defun tmp-f-strike-through (s backend info) "")
13600 @subheading Extending an existing back-end
13602 This is obviously the most powerful customization, since the changes happen
13603 at the parser level. Indeed, some export back-ends are built as extensions
13604 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13606 Extending a back-end means that if an element type is not transcoded by the
13607 new back-end, it will be handled by the original one. Hence you can extend
13608 specific parts of a back-end without too much work.
13610 As an example, imagine we want the @code{ascii} back-end to display the
13611 language used in a source block, when it is available, but only when some
13612 attribute is non-@code{nil}, like the following:
13615 #+ATTR_ASCII: :language t
13618 Because that back-end is lacking in that area, we are going to create a new
13619 back-end, @code{my-ascii} that will do the job.
13623 (defun my-ascii-src-block (src-block contents info)
13624 "Transcode a SRC-BLOCK element from Org to ASCII.
13625 CONTENTS is nil. INFO is a plist used as a communication
13627 (if (not (org-export-read-attribute :attr_ascii src-block :language))
13628 (org-export-with-backend 'ascii src-block contents info)
13630 (format ",--[ %s ]--\n%s`----"
13631 (org-element-property :language src-block)
13632 (replace-regexp-in-string
13634 (org-element-normalize-string
13635 (org-export-format-code-default src-block info)))))))
13637 (org-export-define-derived-backend 'my-ascii 'ascii
13638 :translate-alist '((src-block . my-ascii-src-block)))
13642 The @code{my-ascii-src-block} function looks at the attribute above the
13643 element. If it isn't true, it gives hand to the @code{ascii} back-end.
13644 Otherwise, it creates a box around the code, leaving room for the language.
13645 A new back-end is then created. It only changes its behavior when
13646 translating @code{src-block} type element. Now, all it takes to use the new
13647 back-end is calling the following from an Org buffer:
13650 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13653 It is obviously possible to write an interactive function for this, install
13654 it in the export dispatcher menu, and so on.
13658 @chapter Publishing
13661 Org includes a publishing management system that allows you to configure
13662 automatic HTML conversion of @emph{projects} composed of interlinked org
13663 files. You can also configure Org to automatically upload your exported HTML
13664 pages and related attachments, such as images and source code files, to a web
13667 You can also use Org to convert files into PDF, or even combine HTML and PDF
13668 conversion so that files are available in both formats on the server.
13670 Publishing has been contributed to Org by David O'Toole.
13673 * Configuration:: Defining projects
13674 * Uploading files:: How to get files up on the server
13675 * Sample configuration:: Example projects
13676 * Triggering publication:: Publication commands
13679 @node Configuration
13680 @section Configuration
13682 Publishing needs significant configuration to specify files, destination
13683 and many other properties of a project.
13686 * Project alist:: The central configuration variable
13687 * Sources and destinations:: From here to there
13688 * Selecting files:: What files are part of the project?
13689 * Publishing action:: Setting the function doing the publishing
13690 * Publishing options:: Tweaking HTML/@LaTeX{} export
13691 * Publishing links:: Which links keep working after publishing?
13692 * Sitemap:: Generating a list of all pages
13693 * Generating an index:: An index that reaches across pages
13696 @node Project alist
13697 @subsection The variable @code{org-publish-project-alist}
13698 @cindex org-publish-project-alist
13699 @cindex projects, for publishing
13701 @vindex org-publish-project-alist
13702 Publishing is configured almost entirely through setting the value of one
13703 variable, called @code{org-publish-project-alist}. Each element of the list
13704 configures one project, and may be in one of the two following forms:
13707 ("project-name" :property value :property value ...)
13708 @r{i.e., a well-formed property list with alternating keys and values}
13710 ("project-name" :components ("project-name" "project-name" ...))
13714 In both cases, projects are configured by specifying property values. A
13715 project defines the set of files that will be published, as well as the
13716 publishing configuration to use when publishing those files. When a project
13717 takes the second form listed above, the individual members of the
13718 @code{:components} property are taken to be sub-projects, which group
13719 together files requiring different publishing options. When you publish such
13720 a ``meta-project'', all the components will also be published, in the
13723 @node Sources and destinations
13724 @subsection Sources and destinations for files
13725 @cindex directories, for publishing
13727 Most properties are optional, but some should always be set. In
13728 particular, Org needs to know where to look for source files,
13729 and where to put published files.
13731 @multitable @columnfractions 0.3 0.7
13732 @item @code{:base-directory}
13733 @tab Directory containing publishing source files
13734 @item @code{:publishing-directory}
13735 @tab Directory where output files will be published. You can directly
13736 publish to a web server using a file name syntax appropriate for
13737 the Emacs @file{tramp} package. Or you can publish to a local directory and
13738 use external tools to upload your website (@pxref{Uploading files}).
13739 @item @code{:preparation-function}
13740 @tab Function or list of functions to be called before starting the
13741 publishing process, for example, to run @code{make} for updating files to be
13742 published. The project property list is scoped into this call as the
13743 variable @code{project-plist}.
13744 @item @code{:completion-function}
13745 @tab Function or list of functions called after finishing the publishing
13746 process, for example, to change permissions of the resulting files. The
13747 project property list is scoped into this call as the variable
13748 @code{project-plist}.
13752 @node Selecting files
13753 @subsection Selecting files
13754 @cindex files, selecting for publishing
13756 By default, all files with extension @file{.org} in the base directory
13757 are considered part of the project. This can be modified by setting the
13759 @multitable @columnfractions 0.25 0.75
13760 @item @code{:base-extension}
13761 @tab Extension (without the dot!) of source files. This actually is a
13762 regular expression. Set this to the symbol @code{any} if you want to get all
13763 files in @code{:base-directory}, even without extension.
13765 @item @code{:exclude}
13766 @tab Regular expression to match file names that should not be
13767 published, even though they have been selected on the basis of their
13770 @item @code{:include}
13771 @tab List of files to be included regardless of @code{:base-extension}
13772 and @code{:exclude}.
13774 @item @code{:recursive}
13775 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13778 @node Publishing action
13779 @subsection Publishing action
13780 @cindex action, for publishing
13782 Publishing means that a file is copied to the destination directory and
13783 possibly transformed in the process. The default transformation is to export
13784 Org files as HTML files, and this is done by the function
13785 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13786 export}). But you also can publish your content as PDF files using
13787 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13788 using the corresponding functions.
13790 If you want to publish the Org file as an @code{.org} file but with the
13791 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13792 function @code{org-org-publish-to-org}. This will produce @file{file.org}
13793 and put it in the publishing directory. If you want a htmlized version of
13794 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13795 produce @file{file.org.html} in the publishing directory@footnote{If the
13796 publishing directory is the same than the source directory, @file{file.org}
13797 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13799 Other files like images only need to be copied to the publishing destination.
13800 For this you can use @code{org-publish-attachment}. For non-org files, you
13801 always need to specify the publishing function:
13803 @multitable @columnfractions 0.3 0.7
13804 @item @code{:publishing-function}
13805 @tab Function executing the publication of a file. This may also be a
13806 list of functions, which will all be called in turn.
13807 @item @code{:htmlized-source}
13808 @tab non-@code{nil} means, publish htmlized source.
13811 The function must accept three arguments: a property list containing at least
13812 a @code{:publishing-directory} property, the name of the file to be published
13813 and the path to the publishing directory of the output file. It should take
13814 the specified file, make the necessary transformation (if any) and place the
13815 result into the destination folder.
13817 @node Publishing options
13818 @subsection Options for the exporters
13819 @cindex options, for publishing
13821 The property list can be used to set export options during the publishing
13822 process. In most cases, these properties correspond to user variables in
13823 Org. While some properties are available for all export back-ends, most of
13824 them are back-end specific. The following sections list properties along
13825 with the variable they belong to. See the documentation string of these
13826 options for details.
13828 @vindex org-publish-project-alist
13829 When a property is given a value in @code{org-publish-project-alist}, its
13830 setting overrides the value of the corresponding user variable (if any)
13831 during publishing. Options set within a file (@pxref{Export settings}),
13832 however, override everything.
13834 @subsubheading Generic properties
13836 @multitable {@code{:with-sub-superscript}} {@code{org-export-with-sub-superscripts}}
13837 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
13838 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
13839 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
13840 @item @code{:language} @tab @code{org-export-default-language}
13841 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
13842 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
13843 @item @code{:select-tags} @tab @code{org-export-select-tags}
13844 @item @code{:with-author} @tab @code{org-export-with-author}
13845 @item @code{:with-creator} @tab @code{org-export-with-creator}
13846 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
13847 @item @code{:with-email} @tab @code{org-export-with-email}
13848 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
13849 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
13850 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
13851 @item @code{:with-latex} @tab @code{org-export-with-latex}
13852 @item @code{:with-planning} @tab @code{org-export-with-planning}
13853 @item @code{:with-priority} @tab @code{org-export-with-priority}
13854 @item @code{:with-properties} @tab @code{org-export-with-properties}
13855 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
13856 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
13857 @item @code{:with-tables} @tab @code{org-export-with-tables}
13858 @item @code{:with-tags} @tab @code{org-export-with-tags}
13859 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
13860 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
13861 @item @code{:with-toc} @tab @code{org-export-with-toc}
13862 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
13865 @subsubheading ASCII specific properties
13867 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
13868 @item @code{:ascii-bullets} @tab @code{org-ascii-bullets}
13869 @item @code{:ascii-caption-above} @tab @code{org-ascii-caption-above}
13870 @item @code{:ascii-charset} @tab @code{org-ascii-charset}
13871 @item @code{:ascii-global-margin} @tab @code{org-ascii-global-margin}
13872 @item @code{:ascii-format-drawer-function} @tab @code{org-ascii-format-drawer-function}
13873 @item @code{:ascii-format-inlinetask-function} @tab @code{org-ascii-format-inlinetask-function}
13874 @item @code{:ascii-headline-spacing} @tab @code{org-ascii-headline-spacing}
13875 @item @code{:ascii-indented-line-width} @tab @code{org-ascii-indented-line-width}
13876 @item @code{:ascii-inlinetask-width} @tab @code{org-ascii-inlinetask-width}
13877 @item @code{:ascii-inner-margin} @tab @code{org-ascii-inner-margin}
13878 @item @code{:ascii-links-to-notes} @tab @code{org-ascii-links-to-notes}
13879 @item @code{:ascii-list-margin} @tab @code{org-ascii-list-margin}
13880 @item @code{:ascii-paragraph-spacing} @tab @code{org-ascii-paragraph-spacing}
13881 @item @code{:ascii-quote-margin} @tab @code{org-ascii-quote-margin}
13882 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
13883 @item @code{:ascii-table-use-ascii-art} @tab @code{org-ascii-table-use-ascii-art}
13884 @item @code{:ascii-table-widen-columns} @tab @code{org-ascii-table-widen-columns}
13885 @item @code{:ascii-text-width} @tab @code{org-ascii-text-width}
13886 @item @code{:ascii-underline} @tab @code{org-ascii-underline}
13887 @item @code{:ascii-verbatim-format} @tab @code{org-ascii-verbatim-format}
13890 @subsubheading Beamer specific properties
13892 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
13893 @item @code{:beamer-theme} @tab @code{org-beamer-theme}
13894 @item @code{:beamer-column-view-format} @tab @code{org-beamer-column-view-format}
13895 @item @code{:beamer-environments-extra} @tab @code{org-beamer-environments-extra}
13896 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
13897 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
13898 @item @code{:beamer-outline-frame-title} @tab @code{org-beamer-outline-frame-title}
13901 @subsubheading HTML specific properties
13903 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
13904 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
13905 @item @code{:html-checkbox-type} @tab @code{org-html-checkbox-type}
13906 @item @code{:html-container} @tab @code{org-html-container-element}
13907 @item @code{:html-divs} @tab @code{org-html-divs}
13908 @item @code{:html-doctype} @tab @code{org-html-doctype}
13909 @item @code{:html-extension} @tab @code{org-html-extension}
13910 @item @code{:html-footnote-format} @tab @code{org-html-footnote-format}
13911 @item @code{:html-footnote-separator} @tab @code{org-html-footnote-separator}
13912 @item @code{:html-footnotes-section} @tab @code{org-html-footnotes-section}
13913 @item @code{:html-format-drawer-function} @tab @code{org-html-format-drawer-function}
13914 @item @code{:html-format-headline-function} @tab @code{org-html-format-headline-function}
13915 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
13916 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
13917 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
13918 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
13919 @item @code{:html-head} @tab @code{org-html-head}
13920 @item @code{:html-home/up-format} @tab @code{org-html-home/up-format}
13921 @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy}
13922 @item @code{:html-indent} @tab @code{org-html-indent}
13923 @item @code{:html-infojs-options} @tab @code{org-html-infojs-options}
13924 @item @code{:html-infojs-template} @tab @code{org-html-infojs-template}
13925 @item @code{:html-inline-image-rules} @tab @code{org-html-inline-image-rules}
13926 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
13927 @item @code{:html-link-home} @tab @code{org-html-link-home}
13928 @item @code{:html-link-org-files-as-html} @tab @code{org-html-link-org-files-as-html}
13929 @item @code{:html-link-up} @tab @code{org-html-link-up}
13930 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
13931 @item @code{:html-mathjax-options} @tab @code{org-html-mathjax-options}
13932 @item @code{:html-mathjax-template} @tab @code{org-html-mathjax-template}
13933 @item @code{:html-metadata-timestamp-format} @tab @code{org-html-metadata-timestamp-format}
13934 @item @code{:html-postamble-format} @tab @code{org-html-postamble-format}
13935 @item @code{:html-postamble} @tab @code{org-html-postamble}
13936 @item @code{:html-preamble-format} @tab @code{org-html-preamble-format}
13937 @item @code{:html-preamble} @tab @code{org-html-preamble}
13938 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
13939 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
13940 @item @code{:html-table-caption-above} @tab @code{org-html-table-caption-above}
13941 @item @code{:html-table-data-tags} @tab @code{org-html-table-data-tags}
13942 @item @code{:html-table-header-tags} @tab @code{org-html-table-header-tags}
13943 @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags}
13944 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
13945 @item @code{:html-tag-class-prefix} @tab @code{org-html-tag-class-prefix}
13946 @item @code{:html-text-markup-alist} @tab @code{org-html-text-markup-alist}
13947 @item @code{:html-todo-kwd-class-prefix} @tab @code{org-html-todo-kwd-class-prefix}
13948 @item @code{:html-toplevel-hlevel} @tab @code{org-html-toplevel-hlevel}
13949 @item @code{:html-use-infojs} @tab @code{org-html-use-infojs}
13950 @item @code{:html-use-unicode-chars} @tab @code{org-html-use-unicode-chars}
13951 @item @code{:html-validation-link} @tab @code{org-html-validation-link}
13952 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
13955 @subsubheading @LaTeX{} specific properties
13957 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}}
13958 @item @code{:latex-active-timestamp-format} @tab @code{org-latex-active-timestamp-format}
13959 @item @code{:latex-caption-above} @tab @code{org-latex-caption-above}
13960 @item @code{:latex-classes} @tab @code{org-latex-classes}
13961 @item @code{:latex-class} @tab @code{org-latex-default-class}
13962 @item @code{:latex-custom-id-labels} @tab @code{org-latex-custom-id-as-label}
13963 @item @code{:latex-default-figure-position} @tab @code{org-latex-default-figure-position}
13964 @item @code{:latex-default-table-environment} @tab @code{org-latex-default-table-environment}
13965 @item @code{:latex-default-table-mode} @tab @code{org-latex-default-table-mode}
13966 @item @code{:latex-diary-timestamp-format} @tab @code{org-latex-diary-timestamp-format}
13967 @item @code{:latex-footnote-separator} @tab @code{org-latex-footnote-separator}
13968 @item @code{:latex-format-drawer-function} @tab @code{org-latex-format-drawer-function}
13969 @item @code{:latex-format-headline-function} @tab @code{org-latex-format-headline-function}
13970 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
13971 @item @code{:latex-hyperref-template} @tab @code{org-latex-hyperref-template}
13972 @item @code{:latex-image-default-height} @tab @code{org-latex-image-default-height}
13973 @item @code{:latex-image-default-option} @tab @code{org-latex-image-default-option}
13974 @item @code{:latex-image-default-width} @tab @code{org-latex-image-default-width}
13975 @item @code{:latex-inactive-timestamp-format} @tab @code{org-latex-inactive-timestamp-format}
13976 @item @code{:latex-inline-image-rules} @tab @code{org-latex-inline-image-rules}
13977 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
13978 @item @code{:latex-listings-langs} @tab @code{org-latex-listings-langs}
13979 @item @code{:latex-listings-options} @tab @code{org-latex-listings-options}
13980 @item @code{:latex-listings} @tab @code{org-latex-listings}
13981 @item @code{:latex-minted-langs} @tab @code{org-latex-minted-langs}
13982 @item @code{:latex-minted-options} @tab @code{org-latex-minted-options}
13983 @item @code{:latex-table-scientific-notation} @tab @code{org-latex-table-scientific-notation}
13984 @item @code{:latex-tables-booktabs} @tab @code{org-latex-tables-booktabs}
13985 @item @code{:latex-tables-centered} @tab @code{org-latex-tables-centered}
13986 @item @code{:latex-text-markup-alist} @tab @code{org-latex-text-markup-alist}
13987 @item @code{:latex-title-command} @tab @code{org-latex-title-command}
13988 @item @code{:latex-toc-command} @tab @code{org-latex-toc-command}
13991 @subsubheading Markdown specific properties
13993 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
13994 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
13997 @subsubheading ODT specific properties
13999 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
14000 @item @code{:odt-content-template-file} @tab @code{org-odt-content-template-file}
14001 @item @code{:odt-display-outline-level} @tab @code{org-odt-display-outline-level}
14002 @item @code{:odt-fontify-srcblocks} @tab @code{org-odt-fontify-srcblocks}
14003 @item @code{:odt-format-drawer-function} @tab @code{org-odt-format-drawer-function}
14004 @item @code{:odt-format-headline-function} @tab @code{org-odt-format-headline-function}
14005 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
14006 @item @code{:odt-inline-formula-rules} @tab @code{org-odt-inline-formula-rules}
14007 @item @code{:odt-inline-image-rules} @tab @code{org-odt-inline-image-rules}
14008 @item @code{:odt-pixels-per-inch} @tab @code{org-odt-pixels-per-inch}
14009 @item @code{:odt-styles-file} @tab @code{org-odt-styles-file}
14010 @item @code{:odt-table-styles} @tab @code{org-odt-table-styles}
14011 @item @code{:odt-use-date-fields} @tab @code{org-odt-use-date-fields}
14014 @subsubheading Texinfo specific properties
14016 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14017 @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format}
14018 @item @code{:texinfo-classes} @tab @code{org-texinfo-classes}
14019 @item @code{:texinfo-class} @tab @code{org-texinfo-default-class}
14020 @item @code{:texinfo-def-table-markup} @tab @code{org-texinfo-def-table-markup}
14021 @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format}
14022 @item @code{:texinfo-filename} @tab @code{org-texinfo-filename}
14023 @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function}
14024 @item @code{:texinfo-format-headline-function} @tab @code{org-texinfo-format-headline-function}
14025 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14026 @item @code{:texinfo-inactive-timestamp-format} @tab @code{org-texinfo-inactive-timestamp-format}
14027 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14028 @item @code{:texinfo-node-description-column} @tab @code{org-texinfo-node-description-column}
14029 @item @code{:texinfo-table-scientific-notation} @tab @code{org-texinfo-table-scientific-notation}
14030 @item @code{:texinfo-tables-verbatim} @tab @code{org-texinfo-tables-verbatim}
14031 @item @code{:texinfo-text-markup-alist} @tab @code{org-texinfo-text-markup-alist}
14034 @node Publishing links
14035 @subsection Links between published files
14036 @cindex links, publishing
14038 To create a link from one Org file to another, you would use something like
14039 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
14040 (@pxref{Hyperlinks}). When published, this link becomes a link to
14041 @file{foo.html}. You can thus interlink the pages of your "org web" project
14042 and the links will work as expected when you publish them to HTML@. If you
14043 also publish the Org source file and want to link to it, use an @code{http:}
14044 link instead of a @code{file:} link, because @code{file:} links are converted
14045 to link to the corresponding @file{html} file.
14047 You may also link to related files, such as images. Provided you are careful
14048 with relative file names, and provided you have also configured Org to upload
14049 the related files, these links will work too. See @ref{Complex example}, for
14050 an example of this usage.
14053 @subsection Generating a sitemap
14054 @cindex sitemap, of published pages
14056 The following properties may be used to control publishing of
14057 a map of files for a given project.
14059 @multitable @columnfractions 0.35 0.65
14060 @item @code{:auto-sitemap}
14061 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14062 or @code{org-publish-all}.
14064 @item @code{:sitemap-filename}
14065 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
14066 becomes @file{sitemap.html}).
14068 @item @code{:sitemap-title}
14069 @tab Title of sitemap page. Defaults to name of file.
14071 @item @code{:sitemap-function}
14072 @tab Plug-in function to use for generation of the sitemap.
14073 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14074 of links to all files in the project.
14076 @item @code{:sitemap-sort-folders}
14077 @tab Where folders should appear in the sitemap. Set this to @code{first}
14078 (default) or @code{last} to display folders first or last,
14079 respectively. Any other value will mix files and folders.
14081 @item @code{:sitemap-sort-files}
14082 @tab How the files are sorted in the site map. Set this to
14083 @code{alphabetically} (default), @code{chronologically} or
14084 @code{anti-chronologically}. @code{chronologically} sorts the files with
14085 older date first while @code{anti-chronologically} sorts the files with newer
14086 date first. @code{alphabetically} sorts the files alphabetically. The date of
14087 a file is retrieved with @code{org-publish-find-date}.
14089 @item @code{:sitemap-ignore-case}
14090 @tab Should sorting be case-sensitive? Default @code{nil}.
14092 @item @code{:sitemap-file-entry-format}
14093 @tab With this option one can tell how a sitemap's entry is formatted in the
14094 sitemap. This is a format string with some escape sequences: @code{%t} stands
14095 for the title of the file, @code{%a} stands for the author of the file and
14096 @code{%d} stands for the date of the file. The date is retrieved with the
14097 @code{org-publish-find-date} function and formatted with
14098 @code{org-publish-sitemap-date-format}. Default @code{%t}.
14100 @item @code{:sitemap-date-format}
14101 @tab Format string for the @code{format-time-string} function that tells how
14102 a sitemap entry's date is to be formatted. This property bypasses
14103 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14105 @item @code{:sitemap-sans-extension}
14106 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14107 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14108 Defaults to @code{nil}.
14112 @node Generating an index
14113 @subsection Generating an index
14114 @cindex index, in a publishing project
14116 Org mode can generate an index across the files of a publishing project.
14118 @multitable @columnfractions 0.25 0.75
14119 @item @code{:makeindex}
14120 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14121 publish it as @file{theindex.html}.
14124 The file will be created when first publishing a project with the
14125 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
14126 "theindex.inc"}. You can then build around this include statement by adding
14127 a title, style information, etc.
14129 @node Uploading files
14130 @section Uploading files
14134 For those people already utilizing third party sync tools such as
14135 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14136 @i{remote} publishing facilities of Org mode which rely heavily on
14137 Tramp. Tramp, while very useful and powerful, tends not to be
14138 so efficient for multiple file transfer and has been known to cause problems
14141 Specialized synchronization utilities offer several advantages. In addition
14142 to timestamp comparison, they also do content and permissions/attribute
14143 checks. For this reason you might prefer to publish your web to a local
14144 directory (possibly even @i{in place} with your Org files) and then use
14145 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14147 Since Unison (for example) can be configured as to which files to transfer to
14148 a certain remote destination, it can greatly simplify the project publishing
14149 definition. Simply keep all files in the correct location, process your Org
14150 files with @code{org-publish} and let the synchronization tool do the rest.
14151 You do not need, in this scenario, to include attachments such as @file{jpg},
14152 @file{css} or @file{gif} files in the project definition since the 3rd party
14155 Publishing to a local directory is also much faster than to a remote one, so
14156 that you can afford more easily to republish entire projects. If you set
14157 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14158 benefit of re-including any changed external files such as source example
14159 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
14160 Org is not smart enough to detect if included files have been modified.
14162 @node Sample configuration
14163 @section Sample configuration
14165 Below we provide two example configurations. The first one is a simple
14166 project publishing only a set of Org files. The second example is
14167 more complex, with a multi-component project.
14170 * Simple example:: One-component publishing
14171 * Complex example:: A multi-component publishing example
14174 @node Simple example
14175 @subsection Example: simple publishing configuration
14177 This example publishes a set of Org files to the @file{public_html}
14178 directory on the local machine.
14181 (setq org-publish-project-alist
14183 :base-directory "~/org/"
14184 :publishing-directory "~/public_html"
14185 :section-numbers nil
14187 :html-head "<link rel=\"stylesheet\"
14188 href=\"../other/mystyle.css\"
14189 type=\"text/css\"/>")))
14192 @node Complex example
14193 @subsection Example: complex publishing configuration
14195 This more complicated example publishes an entire website, including
14196 Org files converted to HTML, image files, Emacs Lisp source code, and
14197 style sheets. The publishing directory is remote and private files are
14200 To ensure that links are preserved, care should be taken to replicate
14201 your directory structure on the web server, and to use relative file
14202 paths. For example, if your Org files are kept in @file{~/org} and your
14203 publishable images in @file{~/images}, you would link to an image with
14206 file:../images/myimage.png
14209 On the web server, the relative path to the image should be the
14210 same. You can accomplish this by setting up an "images" folder in the
14211 right place on the web server, and publishing images to it.
14214 (setq org-publish-project-alist
14216 :base-directory "~/org/"
14217 :base-extension "org"
14218 :publishing-directory "/ssh:user@@host:~/html/notebook/"
14219 :publishing-function org-html-publish-to-html
14220 :exclude "PrivatePage.org" ;; regexp
14222 :section-numbers nil
14224 :html-head "<link rel=\"stylesheet\"
14225 href=\"../other/mystyle.css\" type=\"text/css\"/>"
14229 :base-directory "~/images/"
14230 :base-extension "jpg\\|gif\\|png"
14231 :publishing-directory "/ssh:user@@host:~/html/images/"
14232 :publishing-function org-publish-attachment)
14235 :base-directory "~/other/"
14236 :base-extension "css\\|el"
14237 :publishing-directory "/ssh:user@@host:~/html/other/"
14238 :publishing-function org-publish-attachment)
14239 ("website" :components ("orgfiles" "images" "other"))))
14242 @node Triggering publication
14243 @section Triggering publication
14245 Once properly configured, Org can publish with the following commands:
14248 @orgcmd{C-c C-e P x,org-publish}
14249 Prompt for a specific project and publish all files that belong to it.
14250 @orgcmd{C-c C-e P p,org-publish-current-project}
14251 Publish the project containing the current file.
14252 @orgcmd{C-c C-e P f,org-publish-current-file}
14253 Publish only the current file.
14254 @orgcmd{C-c C-e P a,org-publish-all}
14255 Publish every project.
14258 @vindex org-publish-use-timestamps-flag
14259 Org uses timestamps to track when a file has changed. The above functions
14260 normally only publish changed files. You can override this and force
14261 publishing of all files by giving a prefix argument to any of the commands
14262 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14263 This may be necessary in particular if files include other files via
14264 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14267 @node Working with source code
14268 @chapter Working with source code
14269 @cindex Schulte, Eric
14270 @cindex Davison, Dan
14271 @cindex source code, working with
14273 Source code can be included in Org mode documents using a @samp{src} block,
14277 #+BEGIN_SRC emacs-lisp
14278 (defun org-xor (a b)
14284 Org mode provides a number of features for working with live source code,
14285 including editing of code blocks in their native major-mode, evaluation of
14286 code blocks, converting code blocks into source files (known as @dfn{tangling}
14287 in literate programming), and exporting code blocks and their
14288 results in several formats. This functionality was contributed by Eric
14289 Schulte and Dan Davison, and was originally named Org-babel.
14291 The following sections describe Org mode's code block handling facilities.
14294 * Structure of code blocks:: Code block syntax described
14295 * Editing source code:: Language major-mode editing
14296 * Exporting code blocks:: Export contents and/or results
14297 * Extracting source code:: Create pure source code files
14298 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
14299 * Library of Babel:: Use and contribute to a library of useful code blocks
14300 * Languages:: List of supported code block languages
14301 * Header arguments:: Configure code block functionality
14302 * Results of evaluation:: How evaluation results are handled
14303 * Noweb reference syntax:: Literate programming in Org mode
14304 * Key bindings and useful functions:: Work quickly with code blocks
14305 * Batch execution:: Call functions from the command line
14309 @node Structure of code blocks
14310 @section Structure of code blocks
14311 @cindex code block, structure
14312 @cindex source code, block structure
14314 @cindex #+BEGIN_SRC
14316 Live code blocks can be specified with a @samp{src} block or
14317 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14318 @ref{Easy templates} system} The structure of a @samp{src} block is
14322 #+BEGIN_SRC <language> <switches> <header arguments>
14327 The @code{#+NAME:} line is optional, and can be used to name the code
14328 block. Live code blocks require that a language be specified on the
14329 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
14330 @cindex source code, inline
14332 Live code blocks can also be specified inline using
14335 src_<language>@{<body>@}
14341 src_<language>[<header arguments>]@{<body>@}
14345 @item <#+NAME: name>
14346 This line associates a name with the code block. This is similar to the
14347 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14348 files. Referencing the name of a code block makes it possible to evaluate
14349 the block from other places in the file, from other files, or from Org mode
14350 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
14351 and the behavior of Org mode when two or more blocks share the same name is
14355 The language of the code in the block (see @ref{Languages}).
14356 @cindex source code, language
14358 Optional switches control code block export (see the discussion of switches in
14359 @ref{Literal examples})
14360 @cindex source code, switches
14361 @item <header arguments>
14362 Optional header arguments control many aspects of evaluation, export and
14363 tangling of code blocks (see @ref{Header arguments}).
14364 Header arguments can also be set on a per-buffer or per-subtree
14365 basis using properties.
14366 @item source code, header arguments
14368 Source code in the specified language.
14372 @node Editing source code
14373 @section Editing source code
14374 @cindex code block, editing
14375 @cindex source code, editing
14377 @vindex org-edit-src-auto-save-idle-delay
14378 @vindex org-edit-src-turn-on-auto-save
14380 Use @kbd{C-c '} to edit the current code block. This brings up a language
14381 major-mode edit buffer containing the body of the code block. Manually
14382 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14383 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14384 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14385 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14386 Use @kbd{C-c '} again to exit.
14388 The @code{org-src-mode} minor mode will be active in the edit buffer. The
14389 following variables can be used to configure the behavior of the edit
14390 buffer. See also the customization group @code{org-edit-structure} for
14391 further configuration options.
14394 @item org-src-lang-modes
14395 If an Emacs major-mode named @code{<lang>-mode} exists, where
14396 @code{<lang>} is the language named in the header line of the code block,
14397 then the edit buffer will be placed in that major-mode. This variable
14398 can be used to map arbitrary language names to existing major modes.
14399 @item org-src-window-setup
14400 Controls the way Emacs windows are rearranged when the edit buffer is created.
14401 @item org-src-preserve-indentation
14402 @cindex indentation, in source blocks
14403 By default, the value is @code{nil}, which means that when code blocks are
14404 evaluated during export or tangled, they are re-inserted into the code block,
14405 which may replace sequences of spaces with tab characters. When non-nil,
14406 whitespace in code blocks will be preserved during export or tangling,
14407 exactly as it appears. This variable is especially useful for tangling
14408 languages such as Python, in which whitespace indentation in the output is
14410 @item org-src-ask-before-returning-to-edit-buffer
14411 By default, Org will ask before returning to an open edit buffer. Set this
14412 variable to @code{nil} to switch without asking.
14415 To turn on native code fontification in the @emph{Org} buffer, configure the
14416 variable @code{org-src-fontify-natively}.
14419 @node Exporting code blocks
14420 @section Exporting code blocks
14421 @cindex code block, exporting
14422 @cindex source code, exporting
14424 It is possible to export the @emph{code} of code blocks, the @emph{results}
14425 of code block evaluation, @emph{both} the code and the results of code block
14426 evaluation, or @emph{none}. For most languages, the default exports code.
14427 However, for some languages (e.g., @code{ditaa}) the default exports the
14428 results of code block evaluation. For information on exporting code block
14429 bodies, see @ref{Literal examples}.
14431 The @code{:exports} header argument can be used to specify export
14432 behavior (note that these arguments are only relevant for code blocks, not
14435 @subsubheading Header arguments:
14438 @cindex @code{:exports}, src header argument
14439 @item :exports code
14440 The default in most languages. The body of the code block is exported, as
14441 described in @ref{Literal examples}.
14442 @item :exports results
14443 The code block will be evaluated each time to buffer is exported, and the
14444 results will be placed in the Org mode buffer for export, either updating
14445 previous results of the code block located anywhere in the buffer or, if no
14446 previous results exist, placing the results immediately after the code block.
14447 The body of the code block will not be exported.
14448 @item :exports both
14449 Both the code block and its results will be exported.
14450 @item :exports none
14451 Neither the code block nor its results will be exported.
14454 It is possible to inhibit the evaluation of code blocks during export.
14455 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14456 ensure that no code blocks are evaluated as part of the export process. This
14457 can be useful in situations where potentially untrusted Org mode files are
14458 exported in an automated fashion, for example when Org mode is used as the
14459 markup language for a wiki. It is also possible to set this variable to
14460 @code{inline-only}. In that case, only inline code blocks will be
14461 evaluated, in order to insert their results. Non-inline code blocks are
14462 assumed to have their results already inserted in the buffer by manual
14463 evaluation. This setting is useful to avoid expensive recalculations during
14464 export, not to provide security.
14466 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
14467 on export. However, code blocks in subtrees excluded from export
14468 (@pxref{Export settings}) may be evaluated on export.
14470 @node Extracting source code
14471 @section Extracting source code
14473 @cindex source code, extracting
14474 @cindex code block, extracting source code
14476 Creating pure source code files by extracting code from source blocks is
14477 referred to as ``tangling''---a term adopted from the literate programming
14478 community. During ``tangling'' of code blocks their bodies are expanded
14479 using @code{org-babel-expand-src-block} which can expand both variable and
14480 ``noweb'' style references (see @ref{Noweb reference syntax}).
14482 @subsubheading Header arguments
14485 @cindex @code{:tangle}, src header argument
14487 The default. The code block is not included in the tangled output.
14489 Include the code block in the tangled output. The output file name is the
14490 name of the org file with the extension @samp{.org} replaced by the extension
14491 for the block language.
14492 @item :tangle filename
14493 Include the code block in the tangled output to file @samp{filename}.
14497 @subsubheading Functions
14500 @item org-babel-tangle
14501 Tangle the current file. Bound to @kbd{C-c C-v t}.
14503 With prefix argument only tangle the current code block.
14504 @item org-babel-tangle-file
14505 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
14508 @subsubheading Hooks
14511 @item org-babel-post-tangle-hook
14512 This hook is run from within code files tangled by @code{org-babel-tangle}.
14513 Example applications could include post-processing, compilation or evaluation
14514 of tangled code files.
14517 @subsubheading Jumping between code and Org
14519 When tangling code from an Org-mode buffer to a source code file, you'll
14520 frequently find yourself viewing the file of tangled source code (e.g., many
14521 debuggers point to lines of the source code file). It is useful to be able
14522 to navigate from the tangled source to the Org-mode buffer from which the
14525 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
14526 code to Org-mode functionality. Two header arguments are required for
14527 jumping to work, first the @code{padline} (@ref{padline}) option must be set
14528 to true (the default setting), second the @code{comments} (@ref{comments})
14529 header argument must be set to @code{links}, which will insert comments into
14530 the source code buffer which point back to the original Org-mode file.
14532 @node Evaluating code blocks
14533 @section Evaluating code blocks
14534 @cindex code block, evaluating
14535 @cindex source code, evaluating
14538 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
14539 potential for that code to do harm. Org mode provides safeguards to ensure
14540 that code is only evaluated after explicit confirmation from the user. For
14541 information on these safeguards (and on how to disable them) see @ref{Code
14542 evaluation security}.} and the results of evaluation optionally placed in the
14543 Org mode buffer. The results of evaluation are placed following a line that
14544 begins by default with @code{#+RESULTS} and optionally a cache identifier
14545 and/or the name of the evaluated code block. The default value of
14546 @code{#+RESULTS} can be changed with the customizable variable
14547 @code{org-babel-results-keyword}.
14549 By default, the evaluation facility is only enabled for Lisp code blocks
14550 specified as @code{emacs-lisp}. However, source code blocks in many languages
14551 can be evaluated within Org mode (see @ref{Languages} for a list of supported
14552 languages and @ref{Structure of code blocks} for information on the syntax
14553 used to define a code block).
14556 There are a number of ways to evaluate code blocks. The simplest is to press
14557 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
14558 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
14559 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
14560 @code{org-babel-execute-src-block} function to evaluate the block and insert
14561 its results into the Org mode buffer.
14564 It is also possible to evaluate named code blocks from anywhere in an Org
14565 mode buffer or an Org mode table. These named code blocks can be located in
14566 the current Org mode buffer or in the ``Library of Babel'' (@pxref{Library of
14567 Babel}). Named code blocks can be evaluated with a separate @code{#+CALL:}
14568 line or inline within a block of text. In both cases the result is wrapped
14569 according to the value of @code{org-babel-inline-result-wrap}, which by
14570 default is @code{"=%s="} for markup that produces verbatim text.
14572 The syntax of the @code{#+CALL:} line is
14575 #+CALL: <name>(<arguments>)
14576 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
14579 The syntax for inline evaluation of named code blocks is
14582 ... call_<name>(<arguments>) ...
14583 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
14588 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
14590 Arguments specified in this section will be passed to the code block. These
14591 arguments use standard function call syntax, rather than
14592 header argument syntax. For example, a @code{#+CALL:} line that passes the
14593 number four to a code block named @code{double}, which declares the header
14594 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
14595 @item <inside header arguments>
14596 Inside header arguments are passed through and applied to the named code
14597 block. These arguments use header argument syntax rather than standard
14598 function call syntax. Inside header arguments affect how the code block is
14599 evaluated. For example, @code{[:results output]} will collect the results of
14600 everything printed to @code{STDOUT} during execution of the code block.
14601 @item <end header arguments>
14602 End header arguments are applied to the calling instance and do not affect
14603 evaluation of the named code block. They affect how the results are
14604 incorporated into the Org mode buffer and how the call line is exported. For
14605 example, @code{:results html} will insert the results of the call line
14606 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
14608 For more examples of passing header arguments to @code{#+CALL:} lines see
14609 @ref{Header arguments in function calls}.
14612 @node Library of Babel
14613 @section Library of Babel
14614 @cindex babel, library of
14615 @cindex source code, library
14616 @cindex code block, library
14618 The ``Library of Babel'' consists of code blocks that can be called from any
14619 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
14620 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
14621 code blocks} for information on the syntax of remote code block evaluation).
14624 The central repository of code blocks in the ``Library of Babel'' is housed
14625 in an Org mode file located in the @samp{contrib} directory of Org mode.
14627 Users can add code blocks they believe to be generally useful to their
14628 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
14629 then loaded into the library with @code{org-babel-lob-ingest}.
14633 Code blocks located in any Org mode file can be loaded into the ``Library of
14634 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
14639 @cindex babel, languages
14640 @cindex source code, languages
14641 @cindex code block, languages
14643 Code blocks in the following languages are supported.
14645 @multitable @columnfractions 0.28 0.3 0.22 0.2
14646 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
14647 @item Asymptote @tab asymptote @tab Awk @tab awk
14648 @item Emacs Calc @tab calc @tab C @tab C
14649 @item C++ @tab C++ @tab Clojure @tab clojure
14650 @item CSS @tab css @tab ditaa @tab ditaa
14651 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
14652 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
14653 @item Java @tab java @tab @tab
14654 @item Javascript @tab js @tab LaTeX @tab latex
14655 @item Ledger @tab ledger @tab Lisp @tab lisp
14656 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14657 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14658 @item Octave @tab octave @tab Org mode @tab org
14659 @item Oz @tab oz @tab Perl @tab perl
14660 @item Plantuml @tab plantuml @tab Python @tab python
14661 @item R @tab R @tab Ruby @tab ruby
14662 @item Sass @tab sass @tab Scheme @tab scheme
14663 @item GNU Screen @tab screen @tab shell @tab sh
14664 @item SQL @tab sql @tab SQLite @tab sqlite
14667 Language-specific documentation is available for some languages. If
14668 available, it can be found at
14669 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14671 The option @code{org-babel-load-languages} controls which languages are
14672 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
14673 variable can be set using the customization interface or by adding code like
14674 the following to your emacs configuration.
14677 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14678 @code{R} code blocks.
14682 (org-babel-do-load-languages
14683 'org-babel-load-languages
14684 '((emacs-lisp . nil)
14688 It is also possible to enable support for a language by loading the related
14689 elisp file with @code{require}.
14692 The following adds support for evaluating @code{clojure} code blocks.
14696 (require 'ob-clojure)
14699 @node Header arguments
14700 @section Header arguments
14701 @cindex code block, header arguments
14702 @cindex source code, block header arguments
14704 Code block functionality can be configured with header arguments. This
14705 section provides an overview of the use of header arguments, and then
14706 describes each header argument in detail.
14709 * Using header arguments:: Different ways to set header arguments
14710 * Specific header arguments:: List of header arguments
14713 @node Using header arguments
14714 @subsection Using header arguments
14716 The values of header arguments can be set in several way. When the header
14717 arguments in each layer have been determined, they are combined in order from
14718 the first, least specific (having the lowest priority) up to the last, most
14719 specific (having the highest priority). A header argument with a higher
14720 priority replaces the same header argument specified at lower priority.
14722 * System-wide header arguments:: Set global default values
14723 * Language-specific header arguments:: Set default values by language
14724 * Header arguments in Org mode properties:: Set default values for a buffer or heading
14725 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
14726 * Code block specific header arguments:: The most common way to set values
14727 * Header arguments in function calls:: The most specific level
14731 @node System-wide header arguments
14732 @subsubheading System-wide header arguments
14733 @vindex org-babel-default-header-args
14734 System-wide values of header arguments can be specified by adapting the
14735 @code{org-babel-default-header-args} variable:
14737 @cindex @code{:session}, src header argument
14738 @cindex @code{:results}, src header argument
14739 @cindex @code{:exports}, src header argument
14740 @cindex @code{:cache}, src header argument
14741 @cindex @code{:noweb}, src header argument
14744 :results => "replace"
14750 For example, the following example could be used to set the default value of
14751 @code{:noweb} header arguments to @code{yes}. This would have the effect of
14752 expanding @code{:noweb} references by default when evaluating source code
14756 (setq org-babel-default-header-args
14757 (cons '(:noweb . "yes")
14758 (assq-delete-all :noweb org-babel-default-header-args)))
14761 @node Language-specific header arguments
14762 @subsubheading Language-specific header arguments
14763 Each language can define its own set of default header arguments in variable
14764 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14765 of the language. See the language-specific documentation available online at
14766 @uref{http://orgmode.org/worg/org-contrib/babel}.
14768 @node Header arguments in Org mode properties
14769 @subsubheading Header arguments in Org mode properties
14771 Buffer-wide header arguments may be specified as properties through the use
14772 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14773 @ref{Property syntax}).
14775 For example the following would set @code{session} to @code{*R*} (only for R
14776 code blocks), and @code{results} to @code{silent} for every code block in the
14777 buffer, ensuring that all execution took place in the same session, and no
14778 results would be inserted into the buffer.
14781 #+PROPERTY: header-args:R :session *R*
14782 #+PROPERTY: header-args :results silent
14785 Header arguments read from Org mode properties can also be set on a
14786 per-subtree basis using property drawers (see @ref{Property syntax}).
14787 @vindex org-use-property-inheritance
14788 When properties are used to set default header arguments, they are always
14789 looked up with inheritance, regardless of the value of
14790 @code{org-use-property-inheritance}. Properties are evaluated as seen by the
14791 outermost call or source block.@footnote{The deprecated syntax for default
14792 header argument properties, using the name of the header argument as a
14793 property name directly, evaluates the property as seen by the corresponding
14794 source block definition. This behavior has been kept for backwards
14797 In the following example the value of
14798 the @code{:cache} header argument will default to @code{yes} in all code
14799 blocks in the subtree rooted at the following heading:
14804 :header-args: :cache yes
14809 @vindex org-babel-default-header-args
14810 Properties defined in this way override the properties set in
14811 @code{org-babel-default-header-args} and are applied for all activated
14812 languages. It is convenient to use the @code{org-set-property} function
14813 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14815 @node Language-specific header arguments in Org mode properties
14816 @subsubheading Language-specific header arguments in Org mode properties
14818 Language-specific header arguments are also read from properties
14819 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14820 targeted. As an example
14825 :header-args:clojure: :session *clojure-1*
14826 :header-args:R: :session *R*
14830 :header-args:clojure: :session *clojure-2*
14834 would independently set a default session header argument for R and clojure
14835 for calls and source blocks under subtree ``Heading'' and change to a
14836 different clojure setting for evaluations under subtree ``Subheading'', while
14837 the R session is inherited from ``Heading'' and therefore unchanged.
14839 @node Code block specific header arguments
14840 @subsubheading Code block specific header arguments
14842 The most common way to assign values to header arguments is at the
14843 code block level. This can be done by listing a sequence of header
14844 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14845 Properties set in this way override both the values of
14846 @code{org-babel-default-header-args} and header arguments specified as
14847 properties. In the following example, the @code{:results} header argument
14848 is set to @code{silent}, meaning the results of execution will not be
14849 inserted in the buffer, and the @code{:exports} header argument is set to
14850 @code{code}, meaning only the body of the code block will be
14851 preserved on export to HTML or @LaTeX{}.
14855 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14857 fac n = n * fac (n-1)
14860 Similarly, it is possible to set header arguments for inline code blocks
14863 src_haskell[:exports both]@{fac 5@}
14866 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14867 @code{#+HEADERS:} lines preceding a code block or nested between the
14868 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14872 Multi-line header arguments on an un-named code block:
14875 #+HEADERS: :var data1=1
14876 #+BEGIN_SRC emacs-lisp :var data2=2
14877 (message "data1:%S, data2:%S" data1 data2)
14884 Multi-line header arguments on a named code block:
14887 #+NAME: named-block
14888 #+HEADER: :var data=2
14889 #+BEGIN_SRC emacs-lisp
14890 (message "data:%S" data)
14893 #+RESULTS: named-block
14897 @node Header arguments in function calls
14898 @subsubheading Header arguments in function calls
14900 At the most specific level, header arguments for ``Library of Babel'' or
14901 @code{#+CALL:} lines can be set as shown in the two examples below. For more
14902 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14905 The following will apply the @code{:exports results} header argument to the
14906 evaluation of the @code{#+CALL:} line.
14909 #+CALL: factorial(n=5) :exports results
14912 The following will apply the @code{:session special} header argument to the
14913 evaluation of the @code{factorial} code block.
14916 #+CALL: factorial[:session special](n=5)
14919 @node Specific header arguments
14920 @subsection Specific header arguments
14921 Header arguments consist of an initial colon followed by the name of the
14922 argument in lowercase letters. The following header arguments are defined:
14925 * var:: Pass arguments to code blocks
14926 * Results:: Specify the type of results and how they will
14927 be collected and handled
14928 * file:: Specify a path for file output
14929 * file-desc:: Specify a description for file results
14930 * file-ext:: Specify an extension for file output
14931 * output-dir:: Specify a directory to write file output to
14932 * dir:: Specify the default (possibly remote)
14933 directory for code block execution
14934 * exports:: Export code and/or results
14935 * tangle:: Toggle tangling and specify file name
14936 * mkdirp:: Toggle creation of parent directories of target
14937 files during tangling
14938 * comments:: Toggle insertion of comments in tangled
14940 * padline:: Control insertion of padding lines in tangled
14942 * no-expand:: Turn off variable assignment and noweb
14943 expansion during tangling
14944 * session:: Preserve the state of code evaluation
14945 * noweb:: Toggle expansion of noweb references
14946 * noweb-ref:: Specify block's noweb reference resolution target
14947 * noweb-sep:: String used to separate noweb references
14948 * cache:: Avoid re-evaluating unchanged code blocks
14949 * sep:: Delimiter for writing tabular results outside Org
14950 * hlines:: Handle horizontal lines in tables
14951 * colnames:: Handle column names in tables
14952 * rownames:: Handle row names in tables
14953 * shebang:: Make tangled files executable
14954 * tangle-mode:: Set permission of tangled files
14955 * eval:: Limit evaluation of specific code blocks
14956 * wrap:: Mark source block evaluation results
14957 * post:: Post processing of code block results
14958 * prologue:: Text to prepend to code block body
14959 * epilogue:: Text to append to code block body
14962 Additional header arguments are defined on a language-specific basis, see
14966 @subsubsection @code{:var}
14967 @cindex @code{:var}, src header argument
14968 The @code{:var} header argument is used to pass arguments to code blocks.
14969 The specifics of how arguments are included in a code block vary by language;
14970 these are addressed in the language-specific documentation. However, the
14971 syntax used to specify arguments is the same across all languages. In every
14972 case, variables require a default value when they are declared.
14974 The values passed to arguments can either be literal values, references, or
14975 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
14976 References include anything in the Org mode file that takes a @code{#+NAME:}
14977 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
14978 other code blocks and the results of other code blocks.
14980 Note: When a reference is made to another code block, the referenced block
14981 will be evaluated unless it has current cached results (see @ref{cache}).
14983 Argument values can be indexed in a manner similar to arrays (see @ref{var,
14984 Indexable variable values}).
14986 The following syntax is used to pass arguments to code blocks using the
14987 @code{:var} header argument.
14993 The argument, @code{assign}, can either be a literal value, such as a string
14994 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
14995 literal example, another code block (with or without arguments), or the
14996 results of evaluating another code block.
14998 Here are examples of passing values by reference:
15003 an Org mode table named with either a @code{#+NAME:} line
15006 #+NAME: example-table
15012 #+NAME: table-length
15013 #+BEGIN_SRC emacs-lisp :var table=example-table
15017 #+RESULTS: table-length
15022 a simple list named with a @code{#+NAME:} line (note that nesting is not
15023 carried through to the source code block)
15026 #+NAME: example-list
15032 #+BEGIN_SRC emacs-lisp :var x=example-list
15040 @item code block without arguments
15041 a code block name (from the example above), as assigned by @code{#+NAME:},
15042 optionally followed by parentheses
15045 #+BEGIN_SRC emacs-lisp :var length=table-length()
15053 @item code block with arguments
15054 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15055 optional arguments passed within the parentheses following the
15056 code block name using standard function call syntax
15060 #+BEGIN_SRC emacs-lisp :var input=8
15068 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15076 @item literal example
15077 a literal example block named with a @code{#+NAME:} line
15080 #+NAME: literal-example
15086 #+NAME: read-literal-example
15087 #+BEGIN_SRC emacs-lisp :var x=literal-example
15088 (concatenate 'string x " for you.")
15091 #+RESULTS: read-literal-example
15092 : A literal example
15093 : on two lines for you.
15099 @subsubheading Indexable variable values
15100 It is possible to reference portions of variable values by ``indexing'' into
15101 the variables. Indexes are 0 based with negative values counting back from
15102 the end. If an index is separated by @code{,}s then each subsequent section
15103 will index into the next deepest nesting or dimension of the value. Note
15104 that this indexing occurs @emph{before} other table related header arguments
15105 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
15106 following example assigns the last cell of the first row the table
15107 @code{example-table} to the variable @code{data}:
15110 #+NAME: example-table
15116 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15124 Ranges of variable values can be referenced using two integers separated by a
15125 @code{:}, in which case the entire inclusive range is referenced. For
15126 example the following assigns the middle three rows of @code{example-table}
15130 #+NAME: example-table
15137 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15147 Additionally, an empty index, or the single character @code{*}, are both
15148 interpreted to mean the entire range and as such are equivalent to
15149 @code{0:-1}, as shown in the following example in which the entire first
15150 column is referenced.
15153 #+NAME: example-table
15159 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15167 It is possible to index into the results of code blocks as well as tables.
15168 Any number of dimensions can be indexed. Dimensions are separated from one
15169 another by commas, as shown in the following example.
15173 #+BEGIN_SRC emacs-lisp
15174 '(((1 2 3) (4 5 6) (7 8 9))
15175 ((10 11 12) (13 14 15) (16 17 18))
15176 ((19 20 21) (22 23 24) (25 26 27)))
15179 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15187 @subsubheading Emacs Lisp evaluation of variables
15189 Emacs lisp code can be used to initialize variable values. When a variable
15190 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15191 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15192 the variable value. The following example demonstrates use of this
15193 evaluation to reliably pass the file-name of the Org mode buffer to a code
15194 block---note that evaluation of header arguments is guaranteed to take place
15195 in the original Org mode file, while there is no such guarantee for
15196 evaluation of the code block body.
15199 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15204 Note that values read from tables and lists will not be evaluated as
15205 Emacs Lisp, as shown in the following example.
15211 #+HEADERS: :var data=table[0,0]
15221 @subsubsection @code{:results}
15222 @cindex @code{:results}, src header argument
15224 There are four classes of @code{:results} header argument. Only one option
15225 per class may be supplied per code block.
15229 @b{collection} header arguments specify how the results should be collected
15230 from the code block
15232 @b{type} header arguments specify what type of result the code block will
15233 return---which has implications for how they will be processed before
15234 insertion into the Org mode buffer
15236 @b{format} header arguments specify what type of result the code block will
15237 return---which has implications for how they will be inserted into the
15240 @b{handling} header arguments specify how the results of evaluating the code
15241 block should be handled.
15244 @subsubheading Collection
15245 The following options are mutually exclusive, and specify how the results
15246 should be collected from the code block.
15250 This is the default. The result is the value of the last statement in the
15251 code block. This header argument places the evaluation in functional
15252 mode. Note that in some languages, e.g., Python, use of this result type
15253 requires that a @code{return} statement be included in the body of the source
15254 code block. E.g., @code{:results value}.
15255 @item @code{output}
15256 The result is the collection of everything printed to STDOUT during the
15257 execution of the code block. This header argument places the
15258 evaluation in scripting mode. E.g., @code{:results output}.
15261 @subsubheading Type
15263 The following options are mutually exclusive and specify what type of results
15264 the code block will return. By default, results are inserted as either a
15265 table or scalar depending on their value.
15268 @item @code{table}, @code{vector}
15269 The results should be interpreted as an Org mode table. If a single value is
15270 returned, it will be converted into a table with one row and one column.
15271 E.g., @code{:results value table}.
15273 The results should be interpreted as an Org mode list. If a single scalar
15274 value is returned it will be converted into a list with only one element.
15275 @item @code{scalar}, @code{verbatim}
15276 The results should be interpreted literally---they will not be
15277 converted into a table. The results will be inserted into the Org mode
15278 buffer as quoted text. E.g., @code{:results value verbatim}.
15280 The results will be interpreted as the path to a file, and will be inserted
15281 into the Org mode buffer as a file link. E.g., @code{:results value file}.
15284 @subsubheading Format
15286 The following options are mutually exclusive and specify what type of results
15287 the code block will return. By default, results are inserted according to the
15288 type as specified above.
15292 The results are interpreted as raw Org mode code and are inserted directly
15293 into the buffer. If the results look like a table they will be aligned as
15294 such by Org mode. E.g., @code{:results value raw}.
15296 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15297 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15298 in the block and/or if you export the file. E.g., @code{:results value org}.
15300 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
15301 block. E.g., @code{:results value html}.
15303 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
15304 E.g., @code{:results value latex}.
15306 Result are assumed to be parsable code and are enclosed in a code block.
15307 E.g., @code{:results value code}.
15309 The result is converted to pretty-printed code and is enclosed in a code
15310 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
15311 @code{:results value pp}.
15312 @item @code{drawer}
15313 The result is wrapped in a RESULTS drawer. This can be useful for
15314 inserting @code{raw} or @code{org} syntax results in such a way that their
15315 extent is known and they can be automatically removed or replaced.
15318 @subsubheading Handling
15319 The following results options indicate what happens with the
15320 results once they are collected.
15323 @item @code{silent}
15324 The results will be echoed in the minibuffer but will not be inserted into
15325 the Org mode buffer. E.g., @code{:results output silent}.
15326 @item @code{replace}
15327 The default value. Any existing results will be removed, and the new results
15328 will be inserted into the Org mode buffer in their place. E.g.,
15329 @code{:results output replace}.
15330 @item @code{append}
15331 If there are pre-existing results of the code block then the new results will
15332 be appended to the existing results. Otherwise the new results will be
15333 inserted as with @code{replace}.
15334 @item @code{prepend}
15335 If there are pre-existing results of the code block then the new results will
15336 be prepended to the existing results. Otherwise the new results will be
15337 inserted as with @code{replace}.
15341 @subsubsection @code{:file}
15342 @cindex @code{:file}, src header argument
15344 The header argument @code{:file} is used to specify an external file in which
15345 to save code block results. After code block evaluation an Org mode style
15346 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15347 into the Org mode buffer. Some languages including R, gnuplot, dot, and
15348 ditaa provide special handling of the @code{:file} header argument
15349 automatically wrapping the code block body in the boilerplate code required
15350 to save output to the specified file. This is often useful for saving
15351 graphical output of a code block to the specified file.
15353 The argument to @code{:file} should be either a string specifying the path to
15354 a file, or a list of two strings in which case the first element of the list
15355 should be the path to a file and the second a description for the link.
15358 @subsubsection @code{:file-desc}
15360 The value of the @code{:file-desc} header argument is used to provide a
15361 description for file code block results which are inserted as Org mode links
15362 (see @ref{Link format}). If the @code{:file-desc} header argument is given
15363 with no value the link path will be placed in both the ``link'' and the
15364 ``description'' portion of the Org mode link.
15367 @subsubsection @code{:file-ext}
15368 @cindex @code{:file-ext}, src header argument
15370 The value of the @code{:file-ext} header argument is used to provide an
15371 extension to write the file output to. It is combined with the
15372 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15373 header argument to generate a complete file name.
15375 This header arg will be overridden by @code{:file}, and thus has no effect
15376 when the latter is specified.
15379 @subsubsection @code{:output-dir}
15380 @cindex @code{:output-dir}, src header argument
15382 The value of the @code{:output-dir} header argument is used to provide a
15383 directory to write the file output to. It may specify an absolute directory
15384 (beginning with @code{/}) or a relative directory (without @code{/}). It can
15385 be combined with the @code{#+NAME:} of the source block and the value of the
15386 @ref{file-ext} header argument to generate a complete file name, or used
15387 along with a @ref{file} header arg.
15390 @subsubsection @code{:dir} and remote execution
15391 @cindex @code{:dir}, src header argument
15393 While the @code{:file} header argument can be used to specify the path to the
15394 output file, @code{:dir} specifies the default directory during code block
15395 execution. If it is absent, then the directory associated with the current
15396 buffer is used. In other words, supplying @code{:dir path} temporarily has
15397 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15398 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
15399 the value of the Emacs variable @code{default-directory}.
15401 When using @code{:dir}, you should supply a relative path for file output
15402 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15403 case that path will be interpreted relative to the default directory.
15405 In other words, if you want your plot to go into a folder called @file{Work}
15406 in your home directory, you could use
15409 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15410 matplot(matrix(rnorm(100), 10), type="l")
15414 @subsubheading Remote execution
15415 A directory on a remote machine can be specified using tramp file syntax, in
15416 which case the code will be evaluated on the remote machine. An example is
15419 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15420 plot(1:10, main=system("hostname", intern=TRUE))
15424 Text results will be returned to the local Org mode buffer as usual, and file
15425 output will be created on the remote machine with relative paths interpreted
15426 relative to the remote directory. An Org mode link to the remote file will be
15429 So, in the above example a plot will be created on the remote machine,
15430 and a link of the following form will be inserted in the org buffer:
15433 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15436 Most of this functionality follows immediately from the fact that @code{:dir}
15437 sets the value of the Emacs variable @code{default-directory}, thanks to
15438 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
15439 install tramp separately in order for these features to work correctly.
15441 @subsubheading Further points
15445 If @code{:dir} is used in conjunction with @code{:session}, although it will
15446 determine the starting directory for a new session as expected, no attempt is
15447 currently made to alter the directory associated with an existing session.
15449 @code{:dir} should typically not be used to create files during export with
15450 @code{:exports results} or @code{:exports both}. The reason is that, in order
15451 to retain portability of exported material between machines, during export
15452 links inserted into the buffer will @emph{not} be expanded against @code{default
15453 directory}. Therefore, if @code{default-directory} is altered using
15454 @code{:dir}, it is probable that the file will be created in a location to
15455 which the link does not point.
15459 @subsubsection @code{:exports}
15460 @cindex @code{:exports}, src header argument
15462 The @code{:exports} header argument specifies what should be included in HTML
15463 or @LaTeX{} exports of the Org mode file. Note that the @code{:exports}
15464 option is only relevant for code blocks, not inline code.
15468 The default. The body of code is included into the exported file. E.g.,
15469 @code{:exports code}.
15470 @item @code{results}
15471 The result of evaluating the code is included in the exported file. E.g.,
15472 @code{:exports results}.
15474 Both the code and results are included in the exported file. E.g.,
15475 @code{:exports both}.
15477 Nothing is included in the exported file. E.g., @code{:exports none}.
15481 @subsubsection @code{:tangle}
15482 @cindex @code{:tangle}, src header argument
15484 The @code{:tangle} header argument specifies whether or not the code
15485 block should be included in tangled extraction of source code files.
15488 @item @code{tangle}
15489 The code block is exported to a source code file named after the full path
15490 (including the directory) and file name (w/o extension) of the Org mode file.
15491 E.g., @code{:tangle yes}.
15493 The default. The code block is not exported to a source code file.
15494 E.g., @code{:tangle no}.
15496 Any other string passed to the @code{:tangle} header argument is interpreted
15497 as a path (directory and file name relative to the directory of the Org mode
15498 file) to which the block will be exported. E.g., @code{:tangle path}.
15502 @subsubsection @code{:mkdirp}
15503 @cindex @code{:mkdirp}, src header argument
15505 The @code{:mkdirp} header argument can be used to create parent directories
15506 of tangled files when missing. This can be set to @code{yes} to enable
15507 directory creation or to @code{no} to inhibit directory creation.
15510 @subsubsection @code{:comments}
15511 @cindex @code{:comments}, src header argument
15512 By default code blocks are tangled to source-code files without any insertion
15513 of comments beyond those which may already exist in the body of the code
15514 block. The @code{:comments} header argument can be set as follows to control
15515 the insertion of extra comments into the tangled code file.
15519 The default. No extra comments are inserted during tangling.
15521 The code block is wrapped in comments which contain pointers back to the
15522 original Org file from which the code was tangled.
15524 A synonym for ``link'' to maintain backwards compatibility.
15526 Include text from the Org mode file as a comment.
15527 The text is picked from the leading context of the tangled code and is
15528 limited by the nearest headline or source block as the case may be.
15530 Turns on both the ``link'' and ``org'' comment options.
15532 Turns on the ``link'' comment option, and additionally wraps expanded noweb
15533 references in the code block body in link comments.
15537 @subsubsection @code{:padline}
15538 @cindex @code{:padline}, src header argument
15539 Control in insertion of padding lines around code block bodies in tangled
15540 code files. The default value is @code{yes} which results in insertion of
15541 newlines before and after each tangled code block. The following arguments
15546 Insert newlines before and after each code block body in tangled code files.
15548 Do not insert any newline padding in tangled output.
15552 @subsubsection @code{:no-expand}
15553 @cindex @code{:no-expand}, src header argument
15555 By default, code blocks are expanded with @code{org-babel-expand-src-block}
15556 during tangling. This has the effect of assigning values to variables
15557 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
15558 references (see @ref{Noweb reference syntax}) with their targets. The
15559 @code{:no-expand} header argument can be used to turn off this behavior.
15560 Note: The @code{:no-expand} header argument has no impact on export,
15561 i.e. code blocks will irrespective of this header argument expanded for
15565 @subsubsection @code{:session}
15566 @cindex @code{:session}, src header argument
15568 The @code{:session} header argument starts a session for an interpreted
15569 language where state is preserved.
15571 By default, a session is not started.
15573 A string passed to the @code{:session} header argument will give the session
15574 a name. This makes it possible to run concurrent sessions for each
15575 interpreted language.
15578 @subsubsection @code{:noweb}
15579 @cindex @code{:noweb}, src header argument
15581 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
15582 references (see @ref{Noweb reference syntax}) when the code block is
15583 evaluated, tangled, or exported. The @code{:noweb} header argument can have
15584 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
15585 @code{no-export} @code{strip-export}.
15589 The default. ``Noweb'' syntax references in the body of the code block will
15590 not be expanded before the code block is evaluated, tangled or exported.
15592 ``Noweb'' syntax references in the body of the code block will be
15593 expanded before the code block is evaluated, tangled or exported.
15594 @item @code{tangle}
15595 ``Noweb'' syntax references in the body of the code block will be expanded
15596 before the code block is tangled. However, ``noweb'' syntax references will
15597 not be expanded when the code block is evaluated or exported.
15598 @item @code{no-export}
15599 ``Noweb'' syntax references in the body of the code block will be expanded
15600 before the block is evaluated or tangled. However, ``noweb'' syntax
15601 references will not be expanded when the code block is exported.
15602 @item @code{strip-export}
15603 ``Noweb'' syntax references in the body of the code block will be expanded
15604 before the block is evaluated or tangled. However, ``noweb'' syntax
15605 references will be removed when the code block is exported.
15607 ``Noweb'' syntax references in the body of the code block will only be
15608 expanded before the block is evaluated.
15611 @subsubheading Noweb prefix lines
15612 Noweb insertions are now placed behind the line prefix of the
15613 @code{<<reference>>}.
15614 This behavior is illustrated in the following example. Because the
15615 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
15616 each line of the expanded noweb reference will be commented.
15628 -- multi-line body of example
15631 Note that noweb replacement text that does not contain any newlines will not
15632 be affected by this change, so it is still possible to use inline noweb
15636 @subsubsection @code{:noweb-ref}
15637 @cindex @code{:noweb-ref}, src header argument
15638 When expanding ``noweb'' style references, the bodies of all code block with
15639 @emph{either} a block name matching the reference name @emph{or} a
15640 @code{:noweb-ref} header argument matching the reference name will be
15641 concatenated together to form the replacement text.
15643 By setting this header argument at the subtree or file level, simple code
15644 block concatenation may be achieved. For example, when tangling the
15645 following Org mode file, the bodies of code blocks will be concatenated into
15646 the resulting pure code file@footnote{(The example needs property inheritance
15647 to be turned on for the @code{noweb-ref} property, see @ref{Property
15651 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
15654 * the mount point of the fullest disk
15656 :noweb-ref: fullest-disk
15659 ** query all mounted disks
15664 ** strip the header row
15669 ** sort by the percent full
15671 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
15674 ** extract the mount point
15676 |awk '@{print $2@}'
15680 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15681 used to separate accumulate noweb references like those above. By default a
15685 @subsubsection @code{:noweb-sep}
15686 @cindex @code{:noweb-sep}, src header argument
15688 The @code{:noweb-sep} header argument holds the string used to separate
15689 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
15693 @subsubsection @code{:cache}
15694 @cindex @code{:cache}, src header argument
15696 The @code{:cache} header argument controls the use of in-buffer caching of
15697 the results of evaluating code blocks. It can be used to avoid re-evaluating
15698 unchanged code blocks. Note that the @code{:cache} header argument will not
15699 attempt to cache results when the @code{:session} header argument is used,
15700 because the results of the code block execution may be stored in the session
15701 outside of the Org mode buffer. The @code{:cache} header argument can have
15702 one of two values: @code{yes} or @code{no}.
15706 The default. No caching takes place, and the code block will be evaluated
15707 every time it is called.
15709 Every time the code block is run a SHA1 hash of the code and arguments
15710 passed to the block will be generated. This hash is packed into the
15711 @code{#+RESULTS:} line and will be checked on subsequent
15712 executions of the code block. If the code block has not
15713 changed since the last time it was evaluated, it will not be re-evaluated.
15716 Code block caches notice if the value of a variable argument
15717 to the code block has changed. If this is the case, the cache is
15718 invalidated and the code block is re-run. In the following example,
15719 @code{caller} will not be re-run unless the results of @code{random} have
15720 changed since it was last run.
15724 #+BEGIN_SRC R :cache yes
15728 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15732 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15736 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15741 @subsubsection @code{:sep}
15742 @cindex @code{:sep}, src header argument
15744 The @code{:sep} header argument can be used to control the delimiter used
15745 when writing tabular results out to files external to Org mode. This is used
15746 either when opening tabular results of a code block by calling the
15747 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15748 or when writing code block results to an external file (see @ref{file})
15751 By default, when @code{:sep} is not specified output tables are tab
15755 @subsubsection @code{:hlines}
15756 @cindex @code{:hlines}, src header argument
15758 Tables are frequently represented with one or more horizontal lines, or
15759 hlines. The @code{:hlines} argument to a code block accepts the
15760 values @code{yes} or @code{no}, with a default value of @code{no}.
15764 Strips horizontal lines from the input table. In most languages this is the
15765 desired effect because an @code{hline} symbol is interpreted as an unbound
15766 variable and raises an error. Setting @code{:hlines no} or relying on the
15767 default value yields the following results.
15778 #+BEGIN_SRC python :var tab=many-cols
15782 #+RESULTS: echo-table
15789 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
15800 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15804 #+RESULTS: echo-table
15814 @subsubsection @code{:colnames}
15815 @cindex @code{:colnames}, src header argument
15817 The @code{:colnames} header argument accepts the values @code{yes},
15818 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
15819 Note that the behavior of the @code{:colnames} header argument may differ
15824 If an input table looks like it has column names
15825 (because its second row is an hline), then the column
15826 names will be removed from the table before
15827 processing, then reapplied to the results.
15836 #+NAME: echo-table-again
15837 #+BEGIN_SRC python :var tab=less-cols
15838 return [[val + '*' for val in row] for row in tab]
15841 #+RESULTS: echo-table-again
15848 Please note that column names are not removed before the table is indexed
15849 using variable indexing @xref{var, Indexable variable values}.
15852 No column name pre-processing takes place
15855 Column names are removed and reapplied as with @code{nil} even if the table
15856 does not ``look like'' it has column names (i.e., the second row is not an
15861 @subsubsection @code{:rownames}
15862 @cindex @code{:rownames}, src header argument
15864 The @code{:rownames} header argument can take on the values @code{yes} or
15865 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
15866 blocks ignore the @code{:rownames} header argument entirely given the ease
15867 with which tables with row names may be handled directly in Emacs Lisp.
15871 No row name pre-processing will take place.
15874 The first column of the table is removed from the table before processing,
15875 and is then reapplied to the results.
15878 #+NAME: with-rownames
15879 | one | 1 | 2 | 3 | 4 | 5 |
15880 | two | 6 | 7 | 8 | 9 | 10 |
15882 #+NAME: echo-table-once-again
15883 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15884 return [[val + 10 for val in row] for row in tab]
15887 #+RESULTS: echo-table-once-again
15888 | one | 11 | 12 | 13 | 14 | 15 |
15889 | two | 16 | 17 | 18 | 19 | 20 |
15892 Please note that row names are not removed before the table is indexed using
15893 variable indexing @xref{var, Indexable variable values}.
15898 @subsubsection @code{:shebang}
15899 @cindex @code{:shebang}, src header argument
15901 Setting the @code{:shebang} header argument to a string value
15902 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15903 first line of any tangled file holding the code block, and the file
15904 permissions of the tangled file are set to make it executable.
15908 @subsubsection @code{:tangle-mode}
15909 @cindex @code{:tangle-mode}, src header argument
15911 The @code{tangle-mode} header argument controls the permission set on tangled
15912 files. The value of this header argument will be passed to
15913 @code{set-file-modes}. For example, to set a tangled file as read only use
15914 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15915 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
15916 (@ref{shebang}) header arguments will automatically be made executable unless
15917 the @code{tangle-mode} header argument is also used. The behavior is
15918 undefined if multiple code blocks with different values for the
15919 @code{tangle-mode} header argument are tangled to the same file.
15922 @subsubsection @code{:eval}
15923 @cindex @code{:eval}, src header argument
15924 The @code{:eval} header argument can be used to limit the evaluation of
15925 specific code blocks. The @code{:eval} header argument can be useful for
15926 protecting against the evaluation of dangerous code blocks or to ensure that
15927 evaluation will require a query regardless of the value of the
15928 @code{org-confirm-babel-evaluate} variable. The possible values of
15929 @code{:eval} and their effects are shown below.
15933 The code block will not be evaluated under any circumstances.
15935 Evaluation of the code block will require a query.
15936 @item never-export or no-export
15937 The code block will not be evaluated during export but may still be called
15940 Evaluation of the code block during export will require a query.
15943 If this header argument is not set then evaluation is determined by the value
15944 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15948 @subsubsection @code{:wrap}
15949 @cindex @code{:wrap}, src header argument
15950 The @code{:wrap} header argument is used to mark the results of source block
15951 evaluation. The header argument can be passed a string that will be appended
15952 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15953 results. If not string is specified then the results will be wrapped in a
15954 @code{#+BEGIN/END_RESULTS} block.
15957 @subsubsection @code{:post}
15958 @cindex @code{:post}, src header argument
15959 The @code{:post} header argument is used to post-process the results of a
15960 code block execution. When a post argument is given, the results of the code
15961 block will temporarily be bound to the @code{*this*} variable. This variable
15962 may then be included in header argument forms such as those used in @ref{var}
15963 header argument specifications allowing passing of results to other code
15964 blocks, or direct execution via Emacs Lisp.
15966 The following example illustrates the usage of the @code{:post} header
15971 #+begin_src sh :var data="" :var width="\\textwidth" :results output
15972 echo "#+ATTR_LATEX :width $width"
15976 #+header: :file /tmp/it.png
15977 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
15987 #+ATTR_LATEX :width 5cm
15988 [[file:/tmp/it.png]]
15993 @subsubsection @code{:prologue}
15994 @cindex @code{:prologue}, src header argument
15995 The value of the @code{prologue} header argument will be prepended to the
15996 code block body before execution. For example, @code{:prologue "reset"} may
15997 be used to reset a gnuplot session before execution of a particular code
15998 block, or the following configuration may be used to do this for all gnuplot
15999 code blocks. Also see @ref{epilogue}.
16002 (add-to-list 'org-babel-default-header-args:gnuplot
16003 '((:prologue . "reset")))
16007 @subsubsection @code{:epilogue}
16008 @cindex @code{:epilogue}, src header argument
16009 The value of the @code{epilogue} header argument will be appended to the code
16010 block body before execution. Also see @ref{prologue}.
16012 @node Results of evaluation
16013 @section Results of evaluation
16014 @cindex code block, results of evaluation
16015 @cindex source code, results of evaluation
16017 The way in which results are handled depends on whether a session is invoked,
16018 as well as on whether @code{:results value} or @code{:results output} is
16019 used. The following table shows the table possibilities. For a full listing
16020 of the possible results header arguments see @ref{Results}.
16022 @multitable @columnfractions 0.26 0.33 0.41
16023 @item @tab @b{Non-session} @tab @b{Session}
16024 @item @code{:results value} @tab value of last expression @tab value of last expression
16025 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16028 Note: With @code{:results value}, the result in both @code{:session} and
16029 non-session is returned to Org mode as a table (a one- or two-dimensional
16030 vector of strings or numbers) when appropriate.
16032 @subsection Non-session
16033 @subsubsection @code{:results value}
16034 @cindex @code{:results}, src header argument
16035 This is the default. Internally, the value is obtained by wrapping the code
16036 in a function definition in the external language, and evaluating that
16037 function. Therefore, code should be written as if it were the body of such a
16038 function. In particular, note that Python does not automatically return a
16039 value from a function unless a @code{return} statement is present, and so a
16040 @samp{return} statement will usually be required in Python.
16042 This is the only one of the four evaluation contexts in which the code is
16043 automatically wrapped in a function definition.
16045 @subsubsection @code{:results output}
16046 @cindex @code{:results}, src header argument
16047 The code is passed to the interpreter as an external process, and the
16048 contents of the standard output stream are returned as text. (In certain
16049 languages this also contains the error output stream; this is an area for
16052 @subsection Session
16053 @subsubsection @code{:results value}
16054 @cindex @code{:results}, src header argument
16055 The code is passed to an interpreter running as an interactive Emacs inferior
16056 process. Only languages which provide tools for interactive evaluation of
16057 code have session support, so some language (e.g., C and ditaa) do not
16058 support the @code{:session} header argument, and in other languages (e.g.,
16059 Python and Haskell) which have limitations on the code which may be entered
16060 into interactive sessions, those limitations apply to the code in code blocks
16061 using the @code{:session} header argument as well.
16063 Unless the @code{:results output} option is supplied (see below) the result
16064 returned is the result of the last evaluation performed by the
16065 interpreter. (This is obtained in a language-specific manner: the value of
16066 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16069 @subsubsection @code{:results output}
16070 @cindex @code{:results}, src header argument
16071 The code is passed to the interpreter running as an interactive Emacs
16072 inferior process. The result returned is the concatenation of the sequence of
16073 (text) output from the interactive interpreter. Notice that this is not
16074 necessarily the same as what would be sent to @code{STDOUT} if the same code
16075 were passed to a non-interactive interpreter running as an external
16076 process. For example, compare the following two blocks:
16079 #+BEGIN_SRC python :results output
16090 In non-session mode, the `2' is not printed and does not appear.
16093 #+BEGIN_SRC python :results output :session
16105 But in @code{:session} mode, the interactive interpreter receives input `2'
16106 and prints out its value, `2'. (Indeed, the other print statements are
16109 @node Noweb reference syntax
16110 @section Noweb reference syntax
16111 @cindex code block, noweb reference
16112 @cindex syntax, noweb
16113 @cindex source code, noweb reference
16115 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16116 Programming system allows named blocks of code to be referenced by using the
16117 familiar Noweb syntax:
16120 <<code-block-name>>
16123 When a code block is tangled or evaluated, whether or not ``noweb''
16124 references are expanded depends upon the value of the @code{:noweb} header
16125 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
16126 evaluation. If @code{:noweb no}, the default, then the reference is not
16127 expanded before evaluation. See the @ref{noweb-ref} header argument for
16128 a more flexible way to resolve noweb references.
16130 It is possible to include the @emph{results} of a code block rather than the
16131 body. This is done by appending parenthesis to the code block name which may
16132 optionally contain arguments to the code block as shown below.
16135 <<code-block-name(optional arguments)>>
16138 Note: the default value, @code{:noweb no}, was chosen to ensure that
16139 correct code is not broken in a language, such as Ruby, where
16140 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
16141 syntactically valid in languages that you use, then please consider setting
16144 Note: if noweb tangling is slow in large Org mode files consider setting the
16145 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16146 This will result in faster noweb reference resolution at the expense of not
16147 correctly resolving inherited values of the @code{:noweb-ref} header
16150 @node Key bindings and useful functions
16151 @section Key bindings and useful functions
16152 @cindex code block, key bindings
16154 Many common Org mode key sequences are re-bound depending on
16157 Within a code block, the following key bindings
16160 @multitable @columnfractions 0.25 0.75
16162 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16164 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16166 @item @kbd{M-@key{up}} @tab @code{org-babel-load-in-session}
16168 @item @kbd{M-@key{down}} @tab @code{org-babel-switch-to-session}
16171 In an Org mode buffer, the following key bindings are active:
16173 @multitable @columnfractions 0.45 0.55
16175 @kindex C-c C-v C-p
16176 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16178 @kindex C-c C-v C-n
16179 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16181 @kindex C-c C-v C-e
16182 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16184 @kindex C-c C-v C-o
16185 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16187 @kindex C-c C-v C-v
16188 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16190 @kindex C-c C-v C-u
16191 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16193 @kindex C-c C-v C-g
16194 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16196 @kindex C-c C-v C-r
16197 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16199 @kindex C-c C-v C-b
16200 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16202 @kindex C-c C-v C-s
16203 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16205 @kindex C-c C-v C-d
16206 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16208 @kindex C-c C-v C-t
16209 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16211 @kindex C-c C-v C-f
16212 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16214 @kindex C-c C-v C-c
16215 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16217 @kindex C-c C-v C-j
16218 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16220 @kindex C-c C-v C-l
16221 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16223 @kindex C-c C-v C-i
16224 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16226 @kindex C-c C-v C-I
16227 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16229 @kindex C-c C-v C-z
16230 @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}
16232 @kindex C-c C-v C-a
16233 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16235 @kindex C-c C-v C-h
16236 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16238 @kindex C-c C-v C-x
16239 @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}
16242 @c When possible these keybindings were extended to work when the control key is
16243 @c kept pressed, resulting in the following additional keybindings.
16245 @c @multitable @columnfractions 0.25 0.75
16246 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16247 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16248 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16249 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16250 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16251 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16252 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16253 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16256 @node Batch execution
16257 @section Batch execution
16258 @cindex code block, batch execution
16259 @cindex source code, batch execution
16261 It is possible to call functions from the command line. This shell
16262 script calls @code{org-babel-tangle} on every one of its arguments.
16264 Be sure to adjust the paths to fit your system.
16268 # -*- mode: shell-script -*-
16270 # tangle files with org-mode
16275 # wrap each argument in the code required to call tangle on it
16277 FILES="$FILES \"$i\""
16282 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
16283 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
16284 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
16285 (mapc (lambda (file)
16286 (find-file (expand-file-name file \"$DIR\"))
16288 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
16291 @node Miscellaneous
16292 @chapter Miscellaneous
16295 * Completion:: M-TAB knows what you need
16296 * Easy templates:: Quick insertion of structural elements
16297 * Speed keys:: Electric commands at the beginning of a headline
16298 * Code evaluation security:: Org mode files evaluate inline code
16299 * Customization:: Adapting Org to your taste
16300 * In-buffer settings:: Overview of the #+KEYWORDS
16301 * The very busy C-c C-c key:: When in doubt, press C-c C-c
16302 * Clean view:: Getting rid of leading stars in the outline
16303 * TTY keys:: Using Org on a tty
16304 * Interaction:: Other Emacs packages
16305 * org-crypt:: Encrypting Org files
16310 @section Completion
16311 @cindex completion, of @TeX{} symbols
16312 @cindex completion, of TODO keywords
16313 @cindex completion, of dictionary words
16314 @cindex completion, of option keywords
16315 @cindex completion, of tags
16316 @cindex completion, of property keys
16317 @cindex completion, of link abbreviations
16318 @cindex @TeX{} symbol completion
16319 @cindex TODO keywords completion
16320 @cindex dictionary word completion
16321 @cindex option keyword completion
16322 @cindex tag completion
16323 @cindex link abbreviations, completion of
16325 Emacs would not be Emacs without completion, and Org mode uses it whenever it
16326 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
16327 some of the completion prompts, you can specify your preference by setting at
16328 most one of the variables @code{org-completion-use-iswitchb}
16329 @code{org-completion-use-ido}.
16331 Org supports in-buffer completion. This type of completion does
16332 not make use of the minibuffer. You simply type a few letters into
16333 the buffer and use the key to complete text right there.
16336 @kindex M-@key{TAB}
16338 Complete word at point
16341 At the beginning of a headline, complete TODO keywords.
16343 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16345 After @samp{*}, complete headlines in the current buffer so that they
16346 can be used in search links like @samp{[[*find this headline]]}.
16348 After @samp{:} in a headline, complete tags. The list of tags is taken
16349 from the variable @code{org-tag-alist} (possibly set through the
16350 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16351 dynamically from all tags used in the current buffer.
16353 After @samp{:} and not in a headline, complete property keys. The list
16354 of keys is constructed dynamically from all keys used in the current
16357 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16359 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16360 @samp{OPTIONS} which set file-specific options for Org mode. When the
16361 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16362 will insert example settings for this keyword.
16364 In the line after @samp{#+STARTUP: }, complete startup keywords,
16365 i.e., valid keys for this line.
16367 Elsewhere, complete dictionary words using Ispell.
16371 @node Easy templates
16372 @section Easy templates
16373 @cindex template insertion
16374 @cindex insertion, of templates
16376 Org mode supports insertion of empty structural elements (like
16377 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16378 strokes. This is achieved through a native template expansion mechanism.
16379 Note that Emacs has several other template mechanisms which could be used in
16380 a similar way, for example @file{yasnippet}.
16382 To insert a structural element, type a @samp{<}, followed by a template
16383 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
16384 keystrokes are typed on a line by itself.
16386 The following template selectors are currently supported.
16388 @multitable @columnfractions 0.1 0.9
16389 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
16390 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16391 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
16392 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
16393 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
16394 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
16395 @item @kbd{L} @tab @code{#+LaTeX:}
16396 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
16397 @item @kbd{H} @tab @code{#+HTML:}
16398 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
16399 @item @kbd{A} @tab @code{#+ASCII:}
16400 @item @kbd{i} @tab @code{#+INDEX:} line
16401 @item @kbd{I} @tab @code{#+INCLUDE:} line
16404 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16405 into a complete EXAMPLE template.
16407 You can install additional templates by customizing the variable
16408 @code{org-structure-template-alist}. See the docstring of the variable for
16409 additional details.
16412 @section Speed keys
16414 @vindex org-use-speed-commands
16415 @vindex org-speed-commands-user
16417 Single keys can be made to execute commands when the cursor is at the
16418 beginning of a headline, i.e., before the first star. Configure the variable
16419 @code{org-use-speed-commands} to activate this feature. There is a
16420 pre-defined list of commands, and you can add more such commands using the
16421 variable @code{org-speed-commands-user}. Speed keys not only speed up
16422 navigation and other commands, but they also provide an alternative way to
16423 execute commands bound to keys that are not or not easily available on a TTY,
16424 or on a small mobile device with a limited keyboard.
16426 To see which commands are available, activate the feature and press @kbd{?}
16427 with the cursor at the beginning of a headline.
16429 @node Code evaluation security
16430 @section Code evaluation and security issues
16432 Org provides tools to work with code snippets, including evaluating them.
16434 Running code on your machine always comes with a security risk. Badly
16435 written or malicious code can be executed on purpose or by accident. Org has
16436 default settings which will only evaluate such code if you give explicit
16437 permission to do so, and as a casual user of these features you should leave
16438 these precautions intact.
16440 For people who regularly work with such code, the confirmation prompts can
16441 become annoying, and you might want to turn them off. This can be done, but
16442 you must be aware of the risks that are involved.
16444 Code evaluation can happen under the following circumstances:
16447 @item Source code blocks
16448 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16449 C-c} in the block. The most important thing to realize here is that Org mode
16450 files which contain code snippets are, in a certain sense, like executable
16451 files. So you should accept them and load them into Emacs only from trusted
16452 sources---just like you would do with a program you install on your computer.
16454 Make sure you know what you are doing before customizing the variables
16455 which take off the default security brakes.
16457 @defopt org-confirm-babel-evaluate
16458 When t (the default), the user is asked before every code block evaluation.
16459 When @code{nil}, the user is not asked. When set to a function, it is called with
16460 two arguments (language and body of the code block) and should return t to
16461 ask and @code{nil} not to ask.
16464 For example, here is how to execute "ditaa" code (which is considered safe)
16468 (defun my-org-confirm-babel-evaluate (lang body)
16469 (not (string= lang "ditaa"))) ; don't ask for ditaa
16470 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
16473 @item Following @code{shell} and @code{elisp} links
16474 Org has two link types that can directly evaluate code (@pxref{External
16475 links}). These links can be problematic because the code to be evaluated is
16478 @defopt org-confirm-shell-link-function
16479 Function to queries user about shell link execution.
16481 @defopt org-confirm-elisp-link-function
16482 Functions to query user for Emacs Lisp link execution.
16485 @item Formulas in tables
16486 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
16487 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
16490 @node Customization
16491 @section Customization
16492 @cindex customization
16493 @cindex options, for customization
16494 @cindex variables, for customization
16496 There are more than 500 variables that can be used to customize
16497 Org. For the sake of compactness of the manual, I am not
16498 describing the variables here. A structured overview of customization
16499 variables is available with @kbd{M-x org-customize RET}. Or select
16500 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
16501 settings can also be activated on a per-file basis, by putting special
16502 lines into the buffer (@pxref{In-buffer settings}).
16504 @node In-buffer settings
16505 @section Summary of in-buffer settings
16506 @cindex in-buffer settings
16507 @cindex special keywords
16509 Org mode uses special lines in the buffer to define settings on a
16510 per-file basis. These lines start with a @samp{#+} followed by a
16511 keyword, a colon, and then individual words defining a setting. Several
16512 setting words can be in the same line, but you can also have multiple
16513 lines for the keyword. While these settings are described throughout
16514 the manual, here is a summary. After changing any of these lines in the
16515 buffer, press @kbd{C-c C-c} with the cursor still in the line to
16516 activate the changes immediately. Otherwise they become effective only
16517 when the file is visited again in a new Emacs session.
16519 @vindex org-archive-location
16521 @item #+ARCHIVE: %s_done::
16522 This line sets the archive location for the agenda file. It applies for
16523 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
16524 of the file. The first such line also applies to any entries before it.
16525 The corresponding variable is @code{org-archive-location}.
16527 This line sets the category for the agenda file. The category applies
16528 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
16529 end of the file. The first such line also applies to any entries before it.
16530 @item #+COLUMNS: %25ITEM ...
16531 @cindex property, COLUMNS
16532 Set the default format for columns view. This format applies when
16533 columns view is invoked in locations where no @code{COLUMNS} property
16535 @item #+CONSTANTS: name1=value1 ...
16536 @vindex org-table-formula-constants
16537 @vindex org-table-formula
16538 Set file-local values for constants to be used in table formulas. This
16539 line sets the local variable @code{org-table-formula-constants-local}.
16540 The global version of this variable is
16541 @code{org-table-formula-constants}.
16542 @item #+FILETAGS: :tag1:tag2:tag3:
16543 Set tags that can be inherited by any entry in the file, including the
16545 @item #+LINK: linkword replace
16546 @vindex org-link-abbrev-alist
16547 These lines (several are allowed) specify link abbreviations.
16548 @xref{Link abbreviations}. The corresponding variable is
16549 @code{org-link-abbrev-alist}.
16550 @item #+PRIORITIES: highest lowest default
16551 @vindex org-highest-priority
16552 @vindex org-lowest-priority
16553 @vindex org-default-priority
16554 This line sets the limits and the default for the priorities. All three
16555 must be either letters A--Z or numbers 0--9. The highest priority must
16556 have a lower ASCII number than the lowest priority.
16557 @item #+PROPERTY: Property_Name Value
16558 This line sets a default inheritance value for entries in the current
16559 buffer, most useful for specifying the allowed values of a property.
16560 @cindex #+SETUPFILE
16561 @item #+SETUPFILE: file
16562 This line defines a file that holds more in-buffer setup. Normally this is
16563 entirely ignored. Only when the buffer is parsed for option-setting lines
16564 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
16565 settings line, or when exporting), then the contents of this file are parsed
16566 as if they had been included in the buffer. In particular, the file can be
16567 any other Org mode file with internal setup. You can visit the file the
16568 cursor is in the line with @kbd{C-c '}.
16571 This line sets options to be used at startup of Org mode, when an
16572 Org file is being visited.
16574 The first set of options deals with the initial visibility of the outline
16575 tree. The corresponding variable for global default settings is
16576 @code{org-startup-folded}, with a default value @code{t}, which means
16578 @vindex org-startup-folded
16579 @cindex @code{overview}, STARTUP keyword
16580 @cindex @code{content}, STARTUP keyword
16581 @cindex @code{showall}, STARTUP keyword
16582 @cindex @code{showeverything}, STARTUP keyword
16584 overview @r{top-level headlines only}
16585 content @r{all headlines}
16586 showall @r{no folding of any entries}
16587 showeverything @r{show even drawer contents}
16590 @vindex org-startup-indented
16591 @cindex @code{indent}, STARTUP keyword
16592 @cindex @code{noindent}, STARTUP keyword
16593 Dynamic virtual indentation is controlled by the variable
16594 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
16596 indent @r{start with @code{org-indent-mode} turned on}
16597 noindent @r{start with @code{org-indent-mode} turned off}
16600 @vindex org-startup-align-all-tables
16601 Then there are options for aligning tables upon visiting a file. This
16602 is useful in files containing narrowed table columns. The corresponding
16603 variable is @code{org-startup-align-all-tables}, with a default value
16605 @cindex @code{align}, STARTUP keyword
16606 @cindex @code{noalign}, STARTUP keyword
16608 align @r{align all tables}
16609 noalign @r{don't align tables on startup}
16612 @vindex org-startup-with-inline-images
16613 When visiting a file, inline images can be automatically displayed. The
16614 corresponding variable is @code{org-startup-with-inline-images}, with a
16615 default value @code{nil} to avoid delays when visiting a file.
16616 @cindex @code{inlineimages}, STARTUP keyword
16617 @cindex @code{noinlineimages}, STARTUP keyword
16619 inlineimages @r{show inline images}
16620 noinlineimages @r{don't show inline images on startup}
16623 @vindex org-startup-with-latex-preview
16624 When visiting a file, @LaTeX{} fragments can be converted to images
16625 automatically. The variable @code{org-startup-with-latex-preview} which
16626 controls this behavior, is set to @code{nil} by default to avoid delays on
16628 @cindex @code{latexpreview}, STARTUP keyword
16629 @cindex @code{nolatexpreview}, STARTUP keyword
16631 latexpreview @r{preview @LaTeX{} fragments}
16632 nolatexpreview @r{don't preview @LaTeX{} fragments}
16635 @vindex org-log-done
16636 @vindex org-log-note-clock-out
16637 @vindex org-log-repeat
16638 Logging the closing and reopening of TODO items and clock intervals can be
16639 configured using these options (see variables @code{org-log-done},
16640 @code{org-log-note-clock-out} and @code{org-log-repeat})
16641 @cindex @code{logdone}, STARTUP keyword
16642 @cindex @code{lognotedone}, STARTUP keyword
16643 @cindex @code{nologdone}, STARTUP keyword
16644 @cindex @code{lognoteclock-out}, STARTUP keyword
16645 @cindex @code{nolognoteclock-out}, STARTUP keyword
16646 @cindex @code{logrepeat}, STARTUP keyword
16647 @cindex @code{lognoterepeat}, STARTUP keyword
16648 @cindex @code{nologrepeat}, STARTUP keyword
16649 @cindex @code{logreschedule}, STARTUP keyword
16650 @cindex @code{lognotereschedule}, STARTUP keyword
16651 @cindex @code{nologreschedule}, STARTUP keyword
16652 @cindex @code{logredeadline}, STARTUP keyword
16653 @cindex @code{lognoteredeadline}, STARTUP keyword
16654 @cindex @code{nologredeadline}, STARTUP keyword
16655 @cindex @code{logrefile}, STARTUP keyword
16656 @cindex @code{lognoterefile}, STARTUP keyword
16657 @cindex @code{nologrefile}, STARTUP keyword
16658 @cindex @code{logdrawer}, STARTUP keyword
16659 @cindex @code{nologdrawer}, STARTUP keyword
16660 @cindex @code{logstatesreversed}, STARTUP keyword
16661 @cindex @code{nologstatesreversed}, STARTUP keyword
16663 logdone @r{record a timestamp when an item is marked DONE}
16664 lognotedone @r{record timestamp and a note when DONE}
16665 nologdone @r{don't record when items are marked DONE}
16666 logrepeat @r{record a time when reinstating a repeating item}
16667 lognoterepeat @r{record a note when reinstating a repeating item}
16668 nologrepeat @r{do not record when reinstating repeating item}
16669 lognoteclock-out @r{record a note when clocking out}
16670 nolognoteclock-out @r{don't record a note when clocking out}
16671 logreschedule @r{record a timestamp when scheduling time changes}
16672 lognotereschedule @r{record a note when scheduling time changes}
16673 nologreschedule @r{do not record when a scheduling date changes}
16674 logredeadline @r{record a timestamp when deadline changes}
16675 lognoteredeadline @r{record a note when deadline changes}
16676 nologredeadline @r{do not record when a deadline date changes}
16677 logrefile @r{record a timestamp when refiling}
16678 lognoterefile @r{record a note when refiling}
16679 nologrefile @r{do not record when refiling}
16680 logdrawer @r{store log into drawer}
16681 nologdrawer @r{store log outside of drawer}
16682 logstatesreversed @r{reverse the order of states notes}
16683 nologstatesreversed @r{do not reverse the order of states notes}
16686 @vindex org-hide-leading-stars
16687 @vindex org-odd-levels-only
16688 Here are the options for hiding leading stars in outline headings, and for
16689 indenting outlines. The corresponding variables are
16690 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16691 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16692 @cindex @code{hidestars}, STARTUP keyword
16693 @cindex @code{showstars}, STARTUP keyword
16694 @cindex @code{odd}, STARTUP keyword
16695 @cindex @code{even}, STARTUP keyword
16697 hidestars @r{make all but one of the stars starting a headline invisible.}
16698 showstars @r{show all stars starting a headline}
16699 indent @r{virtual indentation according to outline level}
16700 noindent @r{no virtual indentation according to outline level}
16701 odd @r{allow only odd outline levels (1,3,...)}
16702 oddeven @r{allow all outline levels}
16705 @vindex org-put-time-stamp-overlays
16706 @vindex org-time-stamp-overlay-formats
16707 To turn on custom format overlays over timestamps (variables
16708 @code{org-put-time-stamp-overlays} and
16709 @code{org-time-stamp-overlay-formats}), use
16710 @cindex @code{customtime}, STARTUP keyword
16712 customtime @r{overlay custom time format}
16715 @vindex constants-unit-system
16716 The following options influence the table spreadsheet (variable
16717 @code{constants-unit-system}).
16718 @cindex @code{constcgs}, STARTUP keyword
16719 @cindex @code{constSI}, STARTUP keyword
16721 constcgs @r{@file{constants.el} should use the c-g-s unit system}
16722 constSI @r{@file{constants.el} should use the SI unit system}
16725 @vindex org-footnote-define-inline
16726 @vindex org-footnote-auto-label
16727 @vindex org-footnote-auto-adjust
16728 To influence footnote settings, use the following keywords. The
16729 corresponding variables are @code{org-footnote-define-inline},
16730 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16731 @cindex @code{fninline}, STARTUP keyword
16732 @cindex @code{nofninline}, STARTUP keyword
16733 @cindex @code{fnlocal}, STARTUP keyword
16734 @cindex @code{fnprompt}, STARTUP keyword
16735 @cindex @code{fnauto}, STARTUP keyword
16736 @cindex @code{fnconfirm}, STARTUP keyword
16737 @cindex @code{fnplain}, STARTUP keyword
16738 @cindex @code{fnadjust}, STARTUP keyword
16739 @cindex @code{nofnadjust}, STARTUP keyword
16741 fninline @r{define footnotes inline}
16742 fnnoinline @r{define footnotes in separate section}
16743 fnlocal @r{define footnotes near first reference, but not inline}
16744 fnprompt @r{prompt for footnote labels}
16745 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
16746 fnconfirm @r{offer automatic label for editing or confirmation}
16747 fnplain @r{create @code{[1]}-like labels automatically}
16748 fnadjust @r{automatically renumber and sort footnotes}
16749 nofnadjust @r{do not renumber and sort automatically}
16752 @cindex org-hide-block-startup
16753 To hide blocks on startup, use these keywords. The corresponding variable is
16754 @code{org-hide-block-startup}.
16755 @cindex @code{hideblocks}, STARTUP keyword
16756 @cindex @code{nohideblocks}, STARTUP keyword
16758 hideblocks @r{Hide all begin/end blocks on startup}
16759 nohideblocks @r{Do not hide blocks on startup}
16762 @cindex org-pretty-entities
16763 The display of entities as UTF-8 characters is governed by the variable
16764 @code{org-pretty-entities} and the keywords
16765 @cindex @code{entitiespretty}, STARTUP keyword
16766 @cindex @code{entitiesplain}, STARTUP keyword
16768 entitiespretty @r{Show entities as UTF-8 characters where possible}
16769 entitiesplain @r{Leave entities plain}
16772 @item #+TAGS: TAG1(c1) TAG2(c2)
16773 @vindex org-tag-alist
16774 These lines (several such lines are allowed) specify the valid tags in
16775 this file, and (potentially) the corresponding @emph{fast tag selection}
16776 keys. The corresponding variable is @code{org-tag-alist}.
16779 This line contains the formulas for the table directly above the line.
16781 Table can have multiple lines containing @samp{#+TBLFM:}. Note
16782 that only the first line of @samp{#+TBLFM:} will be applied when
16783 you recalculate the table. For more details see @ref{Using
16784 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16786 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16787 @itemx #+OPTIONS:, #+BIND:,
16788 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16789 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
16790 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16791 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16792 These lines provide settings for exporting files. For more details see
16793 @ref{Export settings}.
16794 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
16795 @vindex org-todo-keywords
16796 These lines set the TODO keywords and their interpretation in the
16797 current file. The corresponding variable is @code{org-todo-keywords}.
16800 @node The very busy C-c C-c key
16801 @section The very busy C-c C-c key
16803 @cindex C-c C-c, overview
16805 The key @kbd{C-c C-c} has many purposes in Org, which are all
16806 mentioned scattered throughout this manual. One specific function of
16807 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
16808 other circumstances it means something like @emph{``Hey Org, look
16809 here and update according to what you see here''}. Here is a summary of
16810 what this means in different contexts.
16814 If there are highlights in the buffer from the creation of a sparse
16815 tree, or from clock display, remove these highlights.
16817 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16818 triggers scanning the buffer for these lines and updating the
16821 If the cursor is inside a table, realign the table. This command
16822 works even if the automatic table editor has been turned off.
16824 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16827 If the current buffer is a capture buffer, close the note and file it.
16828 With a prefix argument, file it, without further interaction, to the
16831 If the cursor is on a @code{<<<target>>>}, update radio targets and
16832 corresponding links in this buffer.
16834 If the cursor is in a property line or at the start or end of a property
16835 drawer, offer property commands.
16837 If the cursor is at a footnote reference, go to the corresponding
16838 definition, and @emph{vice versa}.
16840 If the cursor is on a statistics cookie, update it.
16842 If the cursor is in a plain list item with a checkbox, toggle the status
16845 If the cursor is on a numbered item in a plain list, renumber the
16848 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16851 If the cursor is at a timestamp, fix the day name in the timestamp.
16855 @section A cleaner outline view
16856 @cindex hiding leading stars
16857 @cindex dynamic indentation
16858 @cindex odd-levels-only outlines
16859 @cindex clean outline view
16861 Some people find it noisy and distracting that the Org headlines start with a
16862 potentially large number of stars, and that text below the headlines is not
16863 indented. While this is no problem when writing a @emph{book-like} document
16864 where the outline headings are really section headings, in a more
16865 @emph{list-oriented} outline, indented structure is a lot cleaner:
16869 * Top level headline | * Top level headline
16870 ** Second level | * Second level
16871 *** 3rd level | * 3rd level
16872 some text | some text
16873 *** 3rd level | * 3rd level
16874 more text | more text
16875 * Another top level headline | * Another top level headline
16881 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16882 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16883 be achieved dynamically at display time using @code{org-indent-mode}. In
16884 this minor mode, all lines are prefixed for display with the necessary amount
16885 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16886 property, such that @code{visual-line-mode} (or purely setting
16887 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16888 }. Also headlines are prefixed with additional stars, so that the amount of
16889 indentation shifts by two@footnote{See the variable
16890 @code{org-indent-indentation-per-level}.} spaces per level. All headline
16891 stars but the last one are made invisible using the @code{org-hide}
16892 face@footnote{Turning on @code{org-indent-mode} sets
16893 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16894 @code{nil}.}; see below under @samp{2.} for more information on how this
16895 works. You can turn on @code{org-indent-mode} for all files by customizing
16896 the variable @code{org-startup-indented}, or you can turn it on for
16897 individual files using
16903 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16904 you want the indentation to be hard space characters so that the plain text
16905 file looks as similar as possible to the Emacs display, Org supports you in
16910 @emph{Indentation of text below headlines}@*
16911 You may indent text below each headline to make the left boundary line up
16912 with the headline, like
16916 more text, now indented
16919 @vindex org-adapt-indentation
16920 Org supports this with paragraph filling, line wrapping, and structure
16921 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16922 preserving or adapting the indentation as appropriate.
16925 @vindex org-hide-leading-stars
16926 @emph{Hiding leading stars}@* You can modify the display in such a way that
16927 all leading stars become invisible. To do this in a global way, configure
16928 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16932 #+STARTUP: hidestars
16933 #+STARTUP: showstars
16936 With hidden stars, the tree becomes:
16940 * Top level headline
16948 @vindex org-hide @r{(face)}
16949 The leading stars are not truly replaced by whitespace, they are only
16950 fontified with the face @code{org-hide} that uses the background color as
16951 font color. If you are not using either white or black background, you may
16952 have to customize this face to get the wanted effect. Another possibility is
16953 to set this font such that the extra stars are @i{almost} invisible, for
16954 example using the color @code{grey90} on a white background.
16957 @vindex org-odd-levels-only
16958 Things become cleaner still if you skip all the even levels and use only odd
16959 levels 1, 3, 5..., effectively adding two stars to go from one outline level
16960 to the next@footnote{When you need to specify a level for a property search
16961 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
16962 way we get the outline view shown at the beginning of this section. In order
16963 to make the structure editing and export commands handle this convention
16964 correctly, configure the variable @code{org-odd-levels-only}, or set this on
16965 a per-file basis with one of the following lines:
16972 You can convert an Org file from single-star-per-level to the
16973 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
16974 RET} in that file. The reverse operation is @kbd{M-x
16975 org-convert-to-oddeven-levels}.
16979 @section Using Org on a tty
16980 @cindex tty key bindings
16982 Because Org contains a large number of commands, by default many of
16983 Org's core commands are bound to keys that are generally not
16984 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
16985 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
16986 together with modifiers like @key{Meta} and/or @key{Shift}. To access
16987 these commands on a tty when special keys are unavailable, the following
16988 alternative bindings can be used. The tty bindings below will likely be
16989 more cumbersome; you may find for some of the bindings below that a
16990 customized workaround suits you better. For example, changing a timestamp
16991 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
16992 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
16994 @multitable @columnfractions 0.15 0.2 0.1 0.2
16995 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
16996 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
16997 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
16998 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
16999 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
17000 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
17001 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
17002 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
17003 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
17004 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
17005 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
17006 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
17007 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
17008 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
17009 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
17010 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
17011 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
17012 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
17013 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17018 @section Interaction with other packages
17019 @cindex packages, interaction with other
17020 Org lives in the world of GNU Emacs and interacts in various ways
17021 with other code out there.
17024 * Cooperation:: Packages Org cooperates with
17025 * Conflicts:: Packages that lead to conflicts
17029 @subsection Packages that Org cooperates with
17032 @cindex @file{calc.el}
17033 @cindex Gillespie, Dave
17034 @item @file{calc.el} by Dave Gillespie
17035 Org uses the Calc package for implementing spreadsheet
17036 functionality in its tables (@pxref{The spreadsheet}). Org
17037 checks for the availability of Calc by looking for the function
17038 @code{calc-eval} which will have been autoloaded during setup if Calc has
17039 been installed properly. As of Emacs 22, Calc is part of the Emacs
17040 distribution. Another possibility for interaction between the two
17041 packages is using Calc for embedded calculations. @xref{Embedded Mode,
17042 , Embedded Mode, calc, GNU Emacs Calc Manual}.
17043 @item @file{constants.el} by Carsten Dominik
17044 @cindex @file{constants.el}
17045 @cindex Dominik, Carsten
17046 @vindex org-table-formula-constants
17047 In a table formula (@pxref{The spreadsheet}), it is possible to use
17048 names for natural constants or units. Instead of defining your own
17049 constants in the variable @code{org-table-formula-constants}, install
17050 the @file{constants} package which defines a large number of constants
17051 and units, and lets you use unit prefixes like @samp{M} for
17052 @samp{Mega}, etc. You will need version 2.0 of this package, available
17053 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
17054 the function @code{constants-get}, which has to be autoloaded in your
17055 setup. See the installation instructions in the file
17056 @file{constants.el}.
17057 @item @file{cdlatex.el} by Carsten Dominik
17058 @cindex @file{cdlatex.el}
17059 @cindex Dominik, Carsten
17060 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17061 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
17062 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17063 @cindex @file{imenu.el}
17064 Imenu allows menu access to an index of items in a file. Org mode
17065 supports Imenu---all you need to do to get the index is the following:
17067 (add-hook 'org-mode-hook
17068 (lambda () (imenu-add-to-menubar "Imenu")))
17070 @vindex org-imenu-depth
17071 By default the index is two levels deep---you can modify the depth using
17072 the option @code{org-imenu-depth}.
17073 @item @file{remember.el} by John Wiegley
17074 @cindex @file{remember.el}
17075 @cindex Wiegley, John
17076 Org used to use this package for capture, but no longer does.
17077 @item @file{speedbar.el} by Eric M. Ludlam
17078 @cindex @file{speedbar.el}
17079 @cindex Ludlam, Eric M.
17080 Speedbar is a package that creates a special frame displaying files and
17081 index items in files. Org mode supports Speedbar and allows you to
17082 drill into Org files directly from the Speedbar. It also allows you to
17083 restrict the scope of agenda commands to a file or a subtree by using
17084 the command @kbd{<} in the Speedbar frame.
17085 @cindex @file{table.el}
17086 @item @file{table.el} by Takaaki Ota
17088 @cindex table editor, @file{table.el}
17089 @cindex @file{table.el}
17090 @cindex Ota, Takaaki
17092 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17093 and alignment can be created using the Emacs table package by Takaaki Ota
17094 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
17095 Org mode will recognize these tables and export them properly. Because of
17096 interference with other Org mode functionality, you unfortunately cannot edit
17097 these tables directly in the buffer. Instead, you need to use the command
17098 @kbd{C-c '} to edit them, similar to source code snippets.
17101 @orgcmd{C-c ',org-edit-special}
17102 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
17104 @orgcmd{C-c ~,org-table-create-with-table.el}
17105 Insert a @file{table.el} table. If there is already a table at point, this
17106 command converts it between the @file{table.el} format and the Org mode
17107 format. See the documentation string of the command
17108 @code{org-convert-table} for the restrictions under which this is
17111 @file{table.el} is part of Emacs since Emacs 22.
17112 @item @file{footnote.el} by Steven L. Baur
17113 @cindex @file{footnote.el}
17114 @cindex Baur, Steven L.
17115 Org mode recognizes numerical footnotes as provided by this package.
17116 However, Org mode also has its own footnote support (@pxref{Footnotes}),
17117 which makes using @file{footnote.el} unnecessary.
17121 @subsection Packages that lead to conflicts with Org mode
17125 @cindex @code{shift-selection-mode}
17126 @vindex org-support-shift-select
17127 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
17128 cursor motions combined with the shift key should start or enlarge regions.
17129 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17130 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17131 at such a location. By default, @kbd{S-@key{cursor}} commands outside
17132 special contexts don't do anything, but you can customize the variable
17133 @code{org-support-shift-select}. Org mode then tries to accommodate shift
17134 selection by (i) using it outside of the special contexts where special
17135 commands apply, and by (ii) extending an existing active region even if the
17136 cursor moves across a special context.
17138 @item @file{CUA.el} by Kim. F. Storm
17139 @cindex @file{CUA.el}
17140 @cindex Storm, Kim. F.
17141 @vindex org-replace-disputed-keys
17142 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
17143 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
17144 extend the region. In fact, Emacs 23 has this built-in in the form of
17145 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
17146 23, you probably don't want to use another package for this purpose.
17147 However, if you prefer to leave these keys to a different package while
17148 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
17149 When set, Org will move the following key bindings in Org files, and in the
17150 agenda buffer (but not during date selection).
17153 S-UP @result{} M-p S-DOWN @result{} M-n
17154 S-LEFT @result{} M-- S-RIGHT @result{} M-+
17155 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
17158 @vindex org-disputed-keys
17159 Yes, these are unfortunately more difficult to remember. If you want
17160 to have other replacement keys, look at the variable
17161 @code{org-disputed-keys}.
17163 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17164 @cindex @file{ecomplete.el}
17166 Ecomplete provides ``electric'' address completion in address header
17167 lines in message buffers. Sadly Orgtbl mode cuts ecompletes power
17168 supply: No completion happens when Orgtbl mode is enabled in message
17169 buffers while entering text in address header lines. If one wants to
17170 use ecomplete one should @emph{not} follow the advice to automagically
17171 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17172 instead---after filling in the message headers---turn on Orgtbl mode
17173 manually when needed in the messages body.
17175 @item @file{filladapt.el} by Kyle Jones
17176 @cindex @file{filladapt.el}
17178 Org mode tries to do the right thing when filling paragraphs, list items and
17179 other elements. Many users reported they had problems using both
17180 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17184 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17187 @item @file{yasnippet.el}
17188 @cindex @file{yasnippet.el}
17189 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17190 @code{"\t"}) overrules YASnippet's access to this key. The following code
17191 fixed this problem:
17194 (add-hook 'org-mode-hook
17196 (org-set-local 'yas/trigger-key [tab])
17197 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17200 The latest version of yasnippet doesn't play well with Org mode. If the
17201 above code does not fix the conflict, start by defining the following
17205 (defun yas/org-very-safe-expand ()
17206 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17209 Then, tell Org mode what to do with the new function:
17212 (add-hook 'org-mode-hook
17214 (make-variable-buffer-local 'yas/trigger-key)
17215 (setq yas/trigger-key [tab])
17216 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17217 (define-key yas/keymap [tab] 'yas/next-field)))
17220 @item @file{windmove.el} by Hovav Shacham
17221 @cindex @file{windmove.el}
17222 This package also uses the @kbd{S-<cursor>} keys, so everything written
17223 in the paragraph above about CUA mode also applies here. If you want make
17224 the windmove function active in locations where Org mode does not have
17225 special functionality on @kbd{S-@key{cursor}}, add this to your
17229 ;; Make windmove work in org-mode:
17230 (add-hook 'org-shiftup-final-hook 'windmove-up)
17231 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17232 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17233 (add-hook 'org-shiftright-final-hook 'windmove-right)
17236 @item @file{viper.el} by Michael Kifer
17237 @cindex @file{viper.el}
17239 Viper uses @kbd{C-c /} and therefore makes this key not access the
17240 corresponding Org mode command @code{org-sparse-tree}. You need to find
17241 another key for this command, or override the key in
17242 @code{viper-vi-global-user-map} with
17245 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17253 @section org-crypt.el
17254 @cindex @file{org-crypt.el}
17255 @cindex @code{org-decrypt-entry}
17257 Org-crypt will encrypt the text of an entry, but not the headline, or
17258 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17261 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17262 be encrypted when the file is saved. If you want to use a different tag just
17263 customize the @code{org-crypt-tag-matcher} setting.
17265 To use org-crypt it is suggested that you have the following in your
17269 (require 'org-crypt)
17270 (org-crypt-use-before-save-magic)
17271 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17273 (setq org-crypt-key nil)
17274 ;; GPG key to use for encryption
17275 ;; Either the Key ID or set to nil to use symmetric encryption.
17277 (setq auto-save-default nil)
17278 ;; Auto-saving does not cooperate with org-crypt.el: so you need
17279 ;; to turn it off if you plan to use org-crypt.el quite often.
17280 ;; Otherwise, you'll get an (annoying) message each time you
17283 ;; To turn it off only locally, you can insert this:
17285 ;; # -*- buffer-auto-save-file-name: nil; -*-
17288 Excluding the crypt tag from inheritance prevents already encrypted text
17289 being encrypted again.
17295 This appendix covers some areas where users can extend the functionality of
17299 * Hooks:: How to reach into Org's internals
17300 * Add-on packages:: Available extensions
17301 * Adding hyperlink types:: New custom link types
17302 * Adding export back-ends:: How to write new export back-ends
17303 * Context-sensitive commands:: How to add functionality to such commands
17304 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
17305 * Dynamic blocks:: Automatically filled blocks
17306 * Special agenda views:: Customized views
17307 * Speeding up your agendas:: Tips on how to speed up your agendas
17308 * Extracting agenda information:: Post-processing of agenda information
17309 * Using the property API:: Writing programs that use entry properties
17310 * Using the mapping API:: Mapping over all or selected entries
17317 Org has a large number of hook variables that can be used to add
17318 functionality. This appendix about hacking is going to illustrate the
17319 use of some of them. A complete list of all hooks with documentation is
17320 maintained by the Worg project and can be found at
17321 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17323 @node Add-on packages
17324 @section Add-on packages
17325 @cindex add-on packages
17327 A large number of add-on packages have been written by various authors.
17329 These packages are not part of Emacs, but they are distributed as contributed
17330 packages with the separate release available at @uref{http://orgmode.org}.
17331 See the @file{contrib/README} file in the source code directory for a list of
17332 contributed files. You may also find some more information on the Worg page:
17333 @uref{http://orgmode.org/worg/org-contrib/}.
17335 @node Adding hyperlink types
17336 @section Adding hyperlink types
17337 @cindex hyperlinks, adding new types
17339 Org has a large number of hyperlink types built-in
17340 (@pxref{Hyperlinks}). If you would like to add new link types, Org
17341 provides an interface for doing so. Let's look at an example file,
17342 @file{org-man.el}, that will add support for creating links like
17343 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17347 ;;; org-man.el - Support for links to manpages in Org
17351 (org-add-link-type "man" 'org-man-open)
17352 (add-hook 'org-store-link-functions 'org-man-store-link)
17354 (defcustom org-man-command 'man
17355 "The Emacs command to be used to display a man page."
17357 :type '(choice (const man) (const woman)))
17359 (defun org-man-open (path)
17360 "Visit the manpage on PATH.
17361 PATH should be a topic that can be thrown at the man command."
17362 (funcall org-man-command path))
17364 (defun org-man-store-link ()
17365 "Store a link to a manpage."
17366 (when (memq major-mode '(Man-mode woman-mode))
17367 ;; This is a man page, we do make this link
17368 (let* ((page (org-man-get-page-name))
17369 (link (concat "man:" page))
17370 (description (format "Manpage for %s" page)))
17371 (org-store-link-props
17374 :description description))))
17376 (defun org-man-get-page-name ()
17377 "Extract the page name from the buffer name."
17378 ;; This works for both `Man-mode' and `woman-mode'.
17379 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17380 (match-string 1 (buffer-name))
17381 (error "Cannot create link to this man page")))
17385 ;;; org-man.el ends here
17389 You would activate this new link type in @file{.emacs} with
17396 Let's go through the file and see what it does.
17399 It does @code{(require 'org)} to make sure that @file{org.el} has been
17402 The next line calls @code{org-add-link-type} to define a new link type
17403 with prefix @samp{man}. The call also contains the name of a function
17404 that will be called to follow such a link.
17406 @vindex org-store-link-functions
17407 The next line adds a function to @code{org-store-link-functions}, in
17408 order to allow the command @kbd{C-c l} to record a useful link in a
17409 buffer displaying a man page.
17412 The rest of the file defines the necessary variables and functions.
17413 First there is a customization variable that determines which Emacs
17414 command should be used to display man pages. There are two options,
17415 @code{man} and @code{woman}. Then the function to follow a link is
17416 defined. It gets the link path as an argument---in this case the link
17417 path is just a topic for the manual command. The function calls the
17418 value of @code{org-man-command} to display the man page.
17420 Finally the function @code{org-man-store-link} is defined. When you try
17421 to store a link with @kbd{C-c l}, this function will be called to
17422 try to make a link. The function must first decide if it is supposed to
17423 create the link for this buffer type; we do this by checking the value
17424 of the variable @code{major-mode}. If not, the function must exit and
17425 return the value @code{nil}. If yes, the link is created by getting the
17426 manual topic from the buffer name and prefixing it with the string
17427 @samp{man:}. Then it must call the command @code{org-store-link-props}
17428 and set the @code{:type} and @code{:link} properties. Optionally you
17429 can also set the @code{:description} property to provide a default for
17430 the link description when the link is later inserted into an Org
17431 buffer with @kbd{C-c C-l}.
17433 When it makes sense for your new link type, you may also define a function
17434 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
17435 support for inserting such a link with @kbd{C-c C-l}. Such a function should
17436 not accept any arguments, and return the full link with prefix.
17438 @node Adding export back-ends
17439 @section Adding export back-ends
17440 @cindex Export, writing back-ends
17442 Org 8.0 comes with a completely rewritten export engine which makes it easy
17443 to write new export back-ends, either from scratch, or by deriving them
17444 from existing ones.
17446 Your two entry points are respectively @code{org-export-define-backend} and
17447 @code{org-export-define-derived-backend}. To grok these functions, you
17448 should first have a look at @file{ox-latex.el} (for how to define a new
17449 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17450 back-end from an existing one.
17452 When creating a new back-end from scratch, the basic idea is to set the name
17453 of the back-end (as a symbol) and an an alist of elements and export
17454 functions. On top of this, you will need to set additional keywords like
17455 @code{:menu-entry} (to display the back-end in the export dispatcher),
17456 @code{:export-block} (to specify what blocks should not be exported by this
17457 back-end), and @code{:options-alist} (to let the user set export options that
17458 are specific to this back-end.)
17460 Deriving a new back-end is similar, except that you need to set
17461 @code{:translate-alist} to an alist of export functions that should be used
17462 instead of the parent back-end functions.
17464 For a complete reference documentation, see
17465 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17466 Reference on Worg}.
17468 @node Context-sensitive commands
17469 @section Context-sensitive commands
17470 @cindex context-sensitive commands, hooks
17471 @cindex add-ons, context-sensitive commands
17472 @vindex org-ctrl-c-ctrl-c-hook
17474 Org has several commands that act differently depending on context. The most
17475 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17476 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17478 Add-ons can tap into this functionality by providing a function that detects
17479 special context for that add-on and executes functionality appropriate for
17480 the context. Here is an example from Dan Davison's @file{org-R.el} which
17481 allows you to evaluate commands based on the @file{R} programming language
17482 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17483 described in @ref{Working with source code} and is now obsolete.}. For this
17484 package, special contexts are lines that start with @code{#+R:} or
17488 (defun org-R-apply-maybe ()
17489 "Detect if this is context for org-R and execute R commands."
17490 (if (save-excursion
17491 (beginning-of-line 1)
17492 (looking-at "#\\+RR?:"))
17493 (progn (call-interactively 'org-R-apply)
17494 t) ;; to signal that we took action
17495 nil)) ;; to signal that we did not
17497 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
17500 The function first checks if the cursor is in such a line. If that is the
17501 case, @code{org-R-apply} is called and the function returns @code{t} to
17502 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
17503 contexts. If the function finds it should do nothing locally, it returns
17504 @code{nil} so that other, similar functions can have a try.
17507 @node Tables in arbitrary syntax
17508 @section Tables and lists in arbitrary syntax
17509 @cindex tables, in other modes
17510 @cindex lists, in other modes
17511 @cindex Orgtbl mode
17513 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
17514 frequent feature request has been to make it work with native tables in
17515 specific languages, for example @LaTeX{}. However, this is extremely
17516 hard to do in a general way, would lead to a customization nightmare,
17517 and would take away much of the simplicity of the Orgtbl mode table
17520 This appendix describes a different approach. We keep the Orgtbl mode
17521 table in its native format (the @i{source table}), and use a custom
17522 function to @i{translate} the table to the correct syntax, and to
17523 @i{install} it in the right location (the @i{target table}). This puts
17524 the burden of writing conversion functions on the user, but it allows
17525 for a very flexible system.
17527 Bastien added the ability to do the same with lists, in Orgstruct mode. You
17528 can use Org's facilities to edit and structure lists by turning
17529 @code{orgstruct-mode} on, then locally exporting such lists in another format
17530 (HTML, @LaTeX{} or Texinfo.)
17534 * Radio tables:: Sending and receiving radio tables
17535 * A @LaTeX{} example:: Step by step, almost a tutorial
17536 * Translator functions:: Copy and modify
17537 * Radio lists:: Sending and receiving lists
17541 @subsection Radio tables
17542 @cindex radio tables
17544 To define the location of the target table, you first need to create two
17545 lines that are comments in the current mode, but contain magic words
17546 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will
17547 insert the translated table between these lines, replacing whatever was there
17548 before. For example in C mode where comments are between @code{/* ... */}:
17551 /* BEGIN RECEIVE ORGTBL table_name */
17552 /* END RECEIVE ORGTBL table_name */
17556 Just above the source table, we put a special line that tells
17557 Orgtbl mode how to translate this table and where to install it. For
17561 #+ORGTBL: SEND table_name translation_function arguments...
17565 @code{table_name} is the reference name for the table that is also used
17566 in the receiver lines. @code{translation_function} is the Lisp function
17567 that does the translation. Furthermore, the line can contain a list of
17568 arguments (alternating key and value) at the end. The arguments will be
17569 passed as a property list to the translation function for
17570 interpretation. A few standard parameters are already recognized and
17571 acted upon before the translation function is called:
17575 Skip the first N lines of the table. Hlines do count as separate lines for
17578 @item :skipcols (n1 n2 ...)
17579 List of columns that should be skipped. If the table has a column with
17580 calculation marks, that column is automatically discarded as well.
17581 Please note that the translator function sees the table @emph{after} the
17582 removal of these columns, the function never knows that there have been
17583 additional columns.
17587 The one problem remaining is how to keep the source table in the buffer
17588 without disturbing the normal workings of the file, for example during
17589 compilation of a C file or processing of a @LaTeX{} file. There are a
17590 number of different solutions:
17594 The table could be placed in a block comment if that is supported by the
17595 language. For example, in C mode you could wrap the table between
17596 @samp{/*} and @samp{*/} lines.
17598 Sometimes it is possible to put the table after some kind of @i{END}
17599 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
17602 You can just comment the table line-by-line whenever you want to process
17603 the file, and uncomment it whenever you need to edit the table. This
17604 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
17605 makes this comment-toggling very easy, in particular if you bind it to a
17609 @node A @LaTeX{} example
17610 @subsection A @LaTeX{} example of radio tables
17611 @cindex @LaTeX{}, and Orgtbl mode
17613 The best way to wrap the source table in @LaTeX{} is to use the
17614 @code{comment} environment provided by @file{comment.sty}. It has to be
17615 activated by placing @code{\usepackage@{comment@}} into the document
17616 header. Orgtbl mode can insert a radio table skeleton@footnote{By
17617 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
17618 variable @code{orgtbl-radio-table-templates} to install templates for other
17619 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
17620 be prompted for a table name, let's say we use @samp{salesfigures}. You
17621 will then get the following template:
17623 @cindex #+ORGTBL, SEND
17625 % BEGIN RECEIVE ORGTBL salesfigures
17626 % END RECEIVE ORGTBL salesfigures
17628 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17634 @vindex @LaTeX{}-verbatim-environments
17635 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
17636 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
17637 into the receiver location with name @code{salesfigures}. You may now
17638 fill in the table---feel free to use the spreadsheet features@footnote{If
17639 the @samp{#+TBLFM} line contains an odd number of dollar characters,
17640 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
17641 example you can fix this by adding an extra line inside the
17642 @code{comment} environment that is used to balance the dollar
17643 expressions. If you are using AUC@TeX{} with the font-latex library, a
17644 much better solution is to add the @code{comment} environment to the
17645 variable @code{LaTeX-verbatim-environments}.}:
17648 % BEGIN RECEIVE ORGTBL salesfigures
17649 % END RECEIVE ORGTBL salesfigures
17651 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17652 | Month | Days | Nr sold | per day |
17653 |-------+------+---------+---------|
17654 | Jan | 23 | 55 | 2.4 |
17655 | Feb | 21 | 16 | 0.8 |
17656 | March | 22 | 278 | 12.6 |
17657 #+TBLFM: $4=$3/$2;%.1f
17658 % $ (optional extra dollar to keep font-lock happy, see footnote)
17663 When you are done, press @kbd{C-c C-c} in the table to get the converted
17664 table inserted between the two marker lines.
17666 Now let's assume you want to make the table header by hand, because you
17667 want to control how columns are aligned, etc. In this case we make sure
17668 that the table translator skips the first 2 lines of the source
17669 table, and tell the command to work as a @i{splice}, i.e., to not produce
17670 header and footer commands of the target table:
17673 \begin@{tabular@}@{lrrr@}
17674 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
17675 % BEGIN RECEIVE ORGTBL salesfigures
17676 % END RECEIVE ORGTBL salesfigures
17680 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17681 | Month | Days | Nr sold | per day |
17682 |-------+------+---------+---------|
17683 | Jan | 23 | 55 | 2.4 |
17684 | Feb | 21 | 16 | 0.8 |
17685 | March | 22 | 278 | 12.6 |
17686 #+TBLFM: $4=$3/$2;%.1f
17690 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17691 Orgtbl mode. By default, it uses a @code{tabular} environment to typeset the
17692 table and marks horizontal lines with @code{\hline}. You can control the
17693 output through several parameters (see also @pxref{Translator functions}),
17694 including the following ones :
17697 @item :splice nil/t
17698 When non-nil, return only table body lines, don't wrap them into a tabular
17699 environment. Default is @code{nil}.
17702 A format to be used to wrap each field, it should contain @code{%s} for the
17703 original field value. For example, to wrap each field value in dollars,
17704 you could use @code{:fmt "$%s$"}. This may also be a property list with
17705 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17706 A function of one argument can be used in place of the strings; the
17707 function must return a formatted string.
17710 Use this format to print numbers with exponentials. The format should have
17711 @code{%s} twice for inserting mantissa and exponent, for example
17712 @code{"%s\\times10^@{%s@}"}. This may also be a property list with column
17713 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
17714 4 "$%s\\cdot10^@{%s@}$")}. After @code{efmt} has been applied to a value,
17715 @code{fmt} will also be applied. Similar to @code{fmt}, functions of two
17716 arguments can be supplied instead of strings. By default, no special
17717 formatting is applied.
17720 @node Translator functions
17721 @subsection Translator functions
17722 @cindex HTML, and Orgtbl mode
17723 @cindex translator function
17725 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17726 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17727 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
17728 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}. These all use
17729 a generic translator, @code{orgtbl-to-generic}, which, in turn, can delegate
17730 translations to various export back-ends (@pxref{Export back-ends}).
17732 In particular, properties passed into the function (i.e., the ones set by the
17733 @samp{ORGTBL SEND} line) take precedence over translations defined in the
17734 function. So if you would like to use the @LaTeX{} translator, but wanted
17735 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
17736 could just overrule the default with
17739 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17742 For a new language, you can use the generic function to write your own
17743 converter function. For example, if you have a language where a table is
17744 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
17745 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17746 separator is a TAB, you could define your generic translator like this:
17749 (defun orgtbl-to-language (table params)
17750 "Convert the orgtbl-mode TABLE to language."
17753 (org-combine-plists
17754 '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
17759 Please check the documentation string of the function
17760 @code{orgtbl-to-generic} for a full list of parameters understood by
17761 that function, and remember that you can pass each of them into
17762 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17763 using the generic function.
17765 Of course you can also write a completely new function doing complicated
17766 things the generic translator cannot do. A translator function takes
17767 two arguments. The first argument is the table, a list of lines, each
17768 line either the symbol @code{hline} or a list of fields. The second
17769 argument is the property list containing all parameters specified in the
17770 @samp{#+ORGTBL: SEND} line. The function must return a single string
17771 containing the formatted table. If you write a generally useful
17772 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17773 others can benefit from your work.
17776 @subsection Radio lists
17777 @cindex radio lists
17778 @cindex org-list-insert-radio-list
17780 Sending and receiving radio lists works exactly the same way as sending and
17781 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
17782 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17783 @code{org-list-insert-radio-list}.
17785 Here are the differences with radio tables:
17789 Orgstruct mode must be active.
17791 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17793 The available translation functions for radio lists don't take
17796 @kbd{C-c C-c} will work when pressed on the first item of the list.
17799 Here is a @LaTeX{} example. Let's say that you have this in your
17804 % BEGIN RECEIVE ORGLST to-buy
17805 % END RECEIVE ORGLST to-buy
17807 #+ORGLST: SEND to-buy org-list-to-latex
17816 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17817 @LaTeX{} list between the two marker lines.
17819 @node Dynamic blocks
17820 @section Dynamic blocks
17821 @cindex dynamic blocks
17823 Org documents can contain @emph{dynamic blocks}. These are
17824 specially marked regions that are updated by some user-written function.
17825 A good example for such a block is the clock table inserted by the
17826 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17828 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17829 to the block and can also specify parameters for the function producing
17830 the content of the block.
17832 @cindex #+BEGIN:dynamic block
17834 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17839 Dynamic blocks are updated with the following commands
17842 @orgcmd{C-c C-x C-u,org-dblock-update}
17843 Update dynamic block at point.
17844 @orgkey{C-u C-c C-x C-u}
17845 Update all dynamic blocks in the current file.
17848 Updating a dynamic block means to remove all the text between BEGIN and
17849 END, parse the BEGIN line for parameters and then call the specific
17850 writer function for this block to insert the new content. If you want
17851 to use the original content in the writer function, you can use the
17852 extra parameter @code{:content}.
17854 For a block with name @code{myblock}, the writer function is
17855 @code{org-dblock-write:myblock} with as only parameter a property list
17856 with the parameters given in the begin line. Here is a trivial example
17857 of a block that keeps track of when the block update function was last
17861 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17867 The corresponding block writer function could look like this:
17870 (defun org-dblock-write:block-update-time (params)
17871 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17872 (insert "Last block update at: "
17873 (format-time-string fmt (current-time)))))
17876 If you want to make sure that all dynamic blocks are always up-to-date,
17877 you could add the function @code{org-update-all-dblocks} to a hook, for
17878 example @code{before-save-hook}. @code{org-update-all-dblocks} is
17879 written in a way such that it does nothing in buffers that are not in
17882 You can narrow the current buffer to the current dynamic block (like any
17883 other block) with @code{org-narrow-to-block}.
17885 @node Special agenda views
17886 @section Special agenda views
17887 @cindex agenda views, user-defined
17889 @vindex org-agenda-skip-function
17890 @vindex org-agenda-skip-function-global
17891 Org provides a special hook that can be used to narrow down the selection
17892 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17893 @code{agenda*} view is the same as @code{agenda} except that it only
17894 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17895 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17896 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
17897 specify a function that is used at each match to verify if the match should
17898 indeed be part of the agenda view, and if not, how much should be skipped.
17899 You can specify a global condition that will be applied to all agenda views,
17900 this condition would be stored in the variable
17901 @code{org-agenda-skip-function-global}. More commonly, such a definition is
17902 applied only to specific custom searches, using
17903 @code{org-agenda-skip-function}.
17905 Let's say you want to produce a list of projects that contain a WAITING
17906 tag anywhere in the project tree. Let's further assume that you have
17907 marked all tree headings that define a project with the TODO keyword
17908 PROJECT@. In this case you would run a TODO search for the keyword
17909 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17910 the subtree belonging to the project line.
17912 To achieve this, you must write a function that searches the subtree for
17913 the tag. If the tag is found, the function must return @code{nil} to
17914 indicate that this match should not be skipped. If there is no such
17915 tag, return the location of the end of the subtree, to indicate that
17916 search should continue from there.
17919 (defun my-skip-unless-waiting ()
17920 "Skip trees that are not waiting"
17921 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17922 (if (re-search-forward ":waiting:" subtree-end t)
17923 nil ; tag found, do not skip
17924 subtree-end))) ; tag not found, continue after end of subtree
17927 Now you may use this function in an agenda custom command, for example
17931 (org-add-agenda-custom-command
17932 '("b" todo "PROJECT"
17933 ((org-agenda-skip-function 'my-skip-unless-waiting)
17934 (org-agenda-overriding-header "Projects waiting for something: "))))
17937 @vindex org-agenda-overriding-header
17938 Note that this also binds @code{org-agenda-overriding-header} to get a
17939 meaningful header in the agenda view.
17941 @vindex org-odd-levels-only
17942 @vindex org-agenda-skip-function
17943 A general way to create custom searches is to base them on a search for
17944 entries with a certain level limit. If you want to study all entries with
17945 your custom search function, simply do a search for
17946 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
17947 level number corresponds to order in the hierarchy, not to the number of
17948 stars.}, and then use @code{org-agenda-skip-function} to select the entries
17949 you really want to have.
17951 You may also put a Lisp form into @code{org-agenda-skip-function}. In
17952 particular, you may use the functions @code{org-agenda-skip-entry-if}
17953 and @code{org-agenda-skip-subtree-if} in this form, for example:
17956 @item (org-agenda-skip-entry-if 'scheduled)
17957 Skip current entry if it has been scheduled.
17958 @item (org-agenda-skip-entry-if 'notscheduled)
17959 Skip current entry if it has not been scheduled.
17960 @item (org-agenda-skip-entry-if 'deadline)
17961 Skip current entry if it has a deadline.
17962 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
17963 Skip current entry if it has a deadline, or if it is scheduled.
17964 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
17965 Skip current entry if the TODO keyword is TODO or WAITING.
17966 @item (org-agenda-skip-entry-if 'todo 'done)
17967 Skip current entry if the TODO keyword marks a DONE state.
17968 @item (org-agenda-skip-entry-if 'timestamp)
17969 Skip current entry if it has any timestamp, may also be deadline or scheduled.
17970 @anchor{x-agenda-skip-entry-regexp}
17971 @item (org-agenda-skip-entry-if 'regexp "regular expression")
17972 Skip current entry if the regular expression matches in the entry.
17973 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
17974 Skip current entry unless the regular expression matches.
17975 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
17976 Same as above, but check and skip the entire subtree.
17979 Therefore we could also have written the search for WAITING projects
17980 like this, even without defining a special function:
17983 (org-add-agenda-custom-command
17984 '("b" todo "PROJECT"
17985 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
17986 'regexp ":waiting:"))
17987 (org-agenda-overriding-header "Projects waiting for something: "))))
17990 @node Speeding up your agendas
17991 @section Speeding up your agendas
17992 @cindex agenda views, optimization
17994 When your Org files grow in both number and size, agenda commands may start
17995 to become slow. Below are some tips on how to speed up the agenda commands.
17999 Reduce the number of Org agenda files: this will reduce the slowdown caused
18000 by accessing a hard drive.
18002 Reduce the number of DONE and archived headlines: this way the agenda does
18003 not need to skip them.
18005 @vindex org-agenda-dim-blocked-tasks
18006 Inhibit the dimming of blocked tasks:
18008 (setq org-agenda-dim-blocked-tasks nil)
18011 @vindex org-startup-folded
18012 @vindex org-agenda-inhibit-startup
18013 Inhibit agenda files startup options:
18015 (setq org-agenda-inhibit-startup nil)
18018 @vindex org-agenda-show-inherited-tags
18019 @vindex org-agenda-use-tag-inheritance
18020 Disable tag inheritance in agenda:
18022 (setq org-agenda-use-tag-inheritance nil)
18026 You can set these options for specific agenda views only. See the docstrings
18027 of these variables for details on why they affect the agenda generation, and
18028 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18029 page} for further explanations.
18031 @node Extracting agenda information
18032 @section Extracting agenda information
18033 @cindex agenda, pipe
18034 @cindex Scripts, for agenda processing
18036 @vindex org-agenda-custom-commands
18037 Org provides commands to access agenda information for the command
18038 line in Emacs batch mode. This extracted information can be sent
18039 directly to a printer, or it can be read by a program that does further
18040 processing of the data. The first of these commands is the function
18041 @code{org-batch-agenda}, that produces an agenda view and sends it as
18042 ASCII text to STDOUT@. The command takes a single string as parameter.
18043 If the string has length 1, it is used as a key to one of the commands
18044 you have configured in @code{org-agenda-custom-commands}, basically any
18045 key you can use after @kbd{C-c a}. For example, to directly print the
18046 current TODO list, you could use
18049 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18052 If the parameter is a string with 2 or more characters, it is used as a
18053 tags/TODO match string. For example, to print your local shopping list
18054 (all items with the tag @samp{shop}, but excluding the tag
18055 @samp{NewYork}), you could use
18058 emacs -batch -l ~/.emacs \
18059 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18063 You may also modify parameters on the fly like this:
18066 emacs -batch -l ~/.emacs \
18067 -eval '(org-batch-agenda "a" \
18068 org-agenda-span (quote month) \
18069 org-agenda-include-diary nil \
18070 org-agenda-files (quote ("~/org/project.org")))' \
18075 which will produce a 30-day agenda, fully restricted to the Org file
18076 @file{~/org/projects.org}, not even including the diary.
18078 If you want to process the agenda data in more sophisticated ways, you
18079 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18080 list of values for each agenda item. Each line in the output will
18081 contain a number of fields separated by commas. The fields in a line
18085 category @r{The category of the item}
18086 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
18087 type @r{The type of the agenda entry, can be}
18088 todo @r{selected in TODO match}
18089 tagsmatch @r{selected in tags match}
18090 diary @r{imported from diary}
18091 deadline @r{a deadline}
18092 scheduled @r{scheduled}
18093 timestamp @r{appointment, selected by timestamp}
18094 closed @r{entry was closed on date}
18095 upcoming-deadline @r{warning about nearing deadline}
18096 past-scheduled @r{forwarded scheduled item}
18097 block @r{entry has date block including date}
18098 todo @r{The TODO keyword, if any}
18099 tags @r{All tags including inherited ones, separated by colons}
18100 date @r{The relevant date, like 2007-2-14}
18101 time @r{The time, like 15:00-16:50}
18102 extra @r{String with extra planning info}
18103 priority-l @r{The priority letter if any was given}
18104 priority-n @r{The computed numerical priority}
18108 Time and date will only be given if a timestamp (or deadline/scheduled)
18109 led to the selection of the item.
18111 A CSV list like this is very easy to use in a post-processing script.
18112 For example, here is a Perl program that gets the TODO list from
18113 Emacs/Org and prints all the items, preceded by a checkbox:
18118 # define the Emacs command to run
18119 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18121 # run it and capture the output
18122 $agenda = qx@{$cmd 2>/dev/null@};
18124 # loop over all lines
18125 foreach $line (split(/\n/,$agenda)) @{
18126 # get the individual values
18127 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18128 $priority_l,$priority_n) = split(/,/,$line);
18129 # process and print
18130 print "[ ] $head\n";
18134 @node Using the property API
18135 @section Using the property API
18136 @cindex API, for properties
18137 @cindex properties, API
18139 Here is a description of the functions that can be used to work with
18142 @defun org-entry-properties &optional pom which
18143 Get all properties of the entry at point-or-marker POM.@*
18144 This includes the TODO keyword, the tags, time strings for deadline,
18145 scheduled, and clocking, and any additional properties defined in the
18146 entry. The return value is an alist. Keys may occur multiple times
18147 if the property key was used several times.@*
18148 POM may also be @code{nil}, in which case the current entry is used.
18149 If WHICH is @code{nil} or `all', get all properties. If WHICH is
18150 `special' or `standard', only get that subclass.
18152 @vindex org-use-property-inheritance
18153 @findex org-insert-property-drawer
18154 @defun org-entry-get pom property &optional inherit
18155 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
18156 this only looks at properties defined locally in the entry. If @code{INHERIT}
18157 is non-@code{nil} and the entry does not have the property, then also check
18158 higher levels of the hierarchy. If @code{INHERIT} is the symbol
18159 @code{selective}, use inheritance if and only if the setting of
18160 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18163 @defun org-entry-delete pom property
18164 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18167 @defun org-entry-put pom property value
18168 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18171 @defun org-buffer-property-keys &optional include-specials
18172 Get all property keys in the current buffer.
18175 @defun org-insert-property-drawer
18176 Insert a property drawer for the current entry.
18179 @defun org-entry-put-multivalued-property pom property &rest values
18180 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18181 @code{VALUES} should be a list of strings. They will be concatenated, with
18182 spaces as separators.
18185 @defun org-entry-get-multivalued-property pom property
18186 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18187 list of values and return the values as a list of strings.
18190 @defun org-entry-add-to-multivalued-property pom property value
18191 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18192 list of values and make sure that @code{VALUE} is in this list.
18195 @defun org-entry-remove-from-multivalued-property pom property value
18196 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18197 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18200 @defun org-entry-member-in-multivalued-property pom property value
18201 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18202 list of values and check if @code{VALUE} is in this list.
18205 @defopt org-property-allowed-value-functions
18206 Hook for functions supplying allowed values for a specific property.
18207 The functions must take a single argument, the name of the property, and
18208 return a flat list of allowed values. If @samp{:ETC} is one of
18209 the values, use the values as completion help, but allow also other values
18210 to be entered. The functions must return @code{nil} if they are not
18211 responsible for this property.
18214 @node Using the mapping API
18215 @section Using the mapping API
18216 @cindex API, for mapping
18217 @cindex mapping entries, API
18219 Org has sophisticated mapping capabilities to find all entries satisfying
18220 certain criteria. Internally, this functionality is used to produce agenda
18221 views, but there is also an API that can be used to execute arbitrary
18222 functions for each or selected entries. The main entry point for this API
18225 @defun org-map-entries func &optional match scope &rest skip
18226 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18228 @code{FUNC} is a function or a Lisp form. The function will be called
18229 without arguments, with the cursor positioned at the beginning of the
18230 headline. The return values of all calls to the function will be collected
18231 and returned as a list.
18233 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18234 @code{FUNC} does not need to preserve point. After evaluation, the cursor
18235 will be moved to the end of the line (presumably of the headline of the
18236 processed entry) and search continues from there. Under some circumstances,
18237 this may not produce the wanted results. For example, if you have removed
18238 (e.g., archived) the current (sub)tree it could mean that the next entry will
18239 be skipped entirely. In such cases, you can specify the position from where
18240 search should continue by making @code{FUNC} set the variable
18241 @code{org-map-continue-from} to the desired buffer position.
18243 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18244 view. Only headlines that are matched by this query will be considered
18245 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
18246 headlines will be visited by the iteration.
18248 @code{SCOPE} determines the scope of this command. It can be any of:
18251 nil @r{the current buffer, respecting the restriction if any}
18252 tree @r{the subtree started with the entry at point}
18253 region @r{The entries within the active region, if any}
18254 file @r{the current buffer, without restriction}
18256 @r{the current buffer, and any archives associated with it}
18257 agenda @r{all agenda files}
18258 agenda-with-archives
18259 @r{all agenda files with any archive files associated with them}
18261 @r{if this is a list, all files in the list will be scanned}
18264 The remaining args are treated as settings for the skipping facilities of
18265 the scanner. The following items can be given here:
18267 @vindex org-agenda-skip-function
18269 archive @r{skip trees with the archive tag}
18270 comment @r{skip trees with the COMMENT keyword}
18271 function or Lisp form
18272 @r{will be used as value for @code{org-agenda-skip-function},}
18273 @r{so whenever the function returns t, FUNC}
18274 @r{will not be called for that entry and search will}
18275 @r{continue from the point where the function leaves it}
18279 The function given to that mapping routine can really do anything you like.
18280 It can use the property API (@pxref{Using the property API}) to gather more
18281 information about the entry, or in order to change metadata in the entry.
18282 Here are a couple of functions that might be handy:
18284 @defun org-todo &optional arg
18285 Change the TODO state of the entry. See the docstring of the functions for
18286 the many possible values for the argument @code{ARG}.
18289 @defun org-priority &optional action
18290 Change the priority of the entry. See the docstring of this function for the
18291 possible values for @code{ACTION}.
18294 @defun org-toggle-tag tag &optional onoff
18295 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
18296 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18301 Promote the current entry.
18305 Demote the current entry.
18308 Here is a simple example that will turn all entries in the current file with
18309 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18310 Entries in comment trees and in archive trees will be ignored.
18314 '(org-todo "UPCOMING")
18315 "+TOMORROW" 'file 'archive 'comment)
18318 The following example counts the number of entries with TODO keyword
18319 @code{WAITING}, in all agenda files.
18322 (length (org-map-entries t "/+WAITING" 'agenda))
18326 @appendix MobileOrg
18330 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18331 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
18332 capture support for an Org mode system rooted on a ``real'' computer. It
18333 also allows you to record changes to existing entries. The
18334 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18335 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18336 and is now in the hands Sean Escriva. Android users should check out
18337 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18338 by Matt Jones. The two implementations are not identical but offer similar
18341 This appendix describes the support Org has for creating agenda views in a
18342 format that can be displayed by @i{MobileOrg}, and for integrating notes
18343 captured and changes made by @i{MobileOrg} into the main system.
18345 For changing tags and TODO states in MobileOrg, you should have set up the
18346 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18347 cover all important tags and TODO keywords, even if individual files use only
18348 part of these. MobileOrg will also offer you states and tags set up with
18349 in-buffer settings, but it will understand the logistics of TODO state
18350 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18351 (@pxref{Setting tags}) only for those set in these variables.
18354 * Setting up the staging area:: Where to interact with the mobile device
18355 * Pushing to MobileOrg:: Uploading Org files and agendas
18356 * Pulling from MobileOrg:: Integrating captured and flagged items
18359 @node Setting up the staging area
18360 @section Setting up the staging area
18362 MobileOrg needs to interact with Emacs through a directory on a server. If
18363 you are using a public server, you should consider encrypting the files that
18364 are uploaded to the server. This can be done with Org mode 7.02 and with
18365 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18366 installation on your system. To turn on encryption, set a password in
18367 @i{MobileOrg} and, on the Emacs side, configure the variable
18368 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18369 password in your Emacs setup, you might also want to configure
18370 @code{org-mobile-encryption-password}. Please read the docstring of that
18371 variable. Note that encryption will apply only to the contents of the
18372 @file{.org} files. The file names themselves will remain visible.}.
18374 The easiest way to create that directory is to use a free
18375 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18376 Dropbox, or if your version of MobileOrg does not support it, you can use a
18377 webdav server. For more information, check out the documentation of MobileOrg and also this
18378 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18379 When MobileOrg first connects to your Dropbox, it will create a directory
18380 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
18384 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18387 Org mode has commands to put files for @i{MobileOrg} into that directory,
18388 and to read captured notes from there.
18390 @node Pushing to MobileOrg
18391 @section Pushing to MobileOrg
18393 This operation copies all files currently listed in @code{org-mobile-files}
18394 to the directory @code{org-mobile-directory}. By default this list contains
18395 all agenda files (as listed in @code{org-agenda-files}), but additional files
18396 can be included by customizing @code{org-mobile-files}. File names will be
18397 staged with paths relative to @code{org-directory}, so all files should be
18398 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18399 have the same name as their targets.}.
18401 The push operation also creates a special Org file @file{agendas.org} with
18402 all custom agenda view defined by the user@footnote{While creating the
18403 agendas, Org mode will force ID properties on all referenced entries, so that
18404 these entries can be uniquely identified if @i{MobileOrg} flags them for
18405 further action. If you do not want to get these properties in so many
18406 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18407 to @code{nil}. Org mode will then rely on outline paths, in the hope that
18408 these will be unique enough.}.
18410 Finally, Org writes the file @file{index.org}, containing links to all other
18411 files. @i{MobileOrg} first reads this file from the server, and then
18412 downloads all agendas and Org files listed in it. To speed up the download,
18413 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18414 automatically in the file @file{checksums.dat}} have changed.
18416 @node Pulling from MobileOrg
18417 @section Pulling from MobileOrg
18419 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18420 files for viewing. It also appends captured entries and pointers to flagged
18421 and changed entries to the file @file{mobileorg.org} on the server. Org has
18422 a @emph{pull} operation that integrates this information into an inbox file
18423 and operates on the pointers to flagged entries. Here is how it works:
18427 Org moves all entries found in
18428 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18429 operation.} and appends them to the file pointed to by the variable
18430 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
18431 will be a top-level entry in the inbox file.
18433 After moving the entries, Org will attempt to implement the changes made in
18434 @i{MobileOrg}. Some changes are applied directly and without user
18435 interaction. Examples are all changes to tags, TODO state, headline and body
18436 text that can be cleanly applied. Entries that have been flagged for further
18437 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18438 again. When there is a problem finding an entry or applying the change, the
18439 pointer entry will remain in the inbox and will be marked with an error
18440 message. You need to later resolve these issues by hand.
18442 Org will then generate an agenda view with all flagged entries. The user
18443 should then go through these entries and do whatever actions are necessary.
18444 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18445 will be displayed in the echo area when the cursor is on the corresponding
18451 Pressing @kbd{?} in that special agenda will display the full flagging note in
18452 another window and also push it onto the kill ring. So you could use @kbd{?
18453 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18454 Pressing @kbd{?} twice in succession will offer to remove the
18455 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18456 in a property). In this way you indicate that the intended processing for
18457 this flagged entry is finished.
18462 If you are not able to process all flagged entries directly, you can always
18463 return to this agenda view@footnote{Note, however, that there is a subtle
18464 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
18465 is guaranteed to search all files that have been addressed by the last pull.
18466 This might include a file that is not currently in your list of agenda files.
18467 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18468 agenda files will be searched.} using @kbd{C-c a ?}.
18470 @node History and acknowledgments
18471 @appendix History and acknowledgments
18472 @cindex acknowledgments
18476 @section From Carsten
18478 Org was born in 2003, out of frustration over the user interface of the Emacs
18479 Outline mode. I was trying to organize my notes and projects, and using
18480 Emacs seemed to be the natural way to go. However, having to remember eleven
18481 different commands with two or three keys per command, only to hide and show
18482 parts of the outline tree, that seemed entirely unacceptable to me. Also,
18483 when using outlines to take notes, I constantly wanted to restructure the
18484 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
18485 cycling} and @emph{structure editing} were originally implemented in the
18486 package @file{outline-magic.el}, but quickly moved to the more general
18487 @file{org.el}. As this environment became comfortable for project planning,
18488 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
18489 @emph{table support}. These areas highlighted the two main goals that Org
18490 still has today: to be a new, outline-based, plain text mode with innovative
18491 and intuitive editing features, and to incorporate project planning
18492 functionality directly into a notes file.
18494 Since the first release, literally thousands of emails to me or to
18495 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
18496 reports, feedback, new ideas, and sometimes patches and add-on code.
18497 Many thanks to everyone who has helped to improve this package. I am
18498 trying to keep here a list of the people who had significant influence
18499 in shaping one or more aspects of Org. The list may not be
18500 complete, if I have forgotten someone, please accept my apologies and
18503 Before I get to this list, a few special mentions are in order:
18506 @item Bastien Guerry
18507 Bastien has written a large number of extensions to Org (most of them
18508 integrated into the core by now), including the @LaTeX{} exporter and the
18509 plain list parser. His support during the early days was central to the
18510 success of this project. Bastien also invented Worg, helped establishing the
18511 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
18512 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
18513 I desparately needed a break.
18514 @item Eric Schulte and Dan Davison
18515 Eric and Dan are jointly responsible for the Org-babel system, which turns
18516 Org into a multi-language environment for evaluating code and doing literate
18517 programming and reproducible research. This has become one of Org's killer
18518 features that define what Org is today.
18520 John has contributed a number of great ideas and patches directly to Org,
18521 including the attachment system (@file{org-attach.el}), integration with
18522 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
18523 items, habit tracking (@file{org-habits.el}), and encryption
18524 (@file{org-crypt.el}). Also, the capture system is really an extended copy
18525 of his great @file{remember.el}.
18526 @item Sebastian Rose
18527 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
18528 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
18529 higher level. He also wrote @file{org-info.js}, a Java script for displaying
18530 web pages derived from Org using an Info-like or a folding interface with
18531 single-key navigation.
18534 @noindent See below for the full list of contributions! Again, please
18535 let me know what I am missing here!
18537 @section From Bastien
18539 I (Bastien) have been maintaining Org between 2011 and 2013. This appendix
18540 would not be complete without adding a few more acknowledgements and thanks.
18542 I am first grateful to Carsten for his trust while handing me over the
18543 maintainership of Org. His unremitting support is what really helped me
18544 getting more confident over time, with both the community and the code.
18546 When I took over maintainership, I knew I would have to make Org more
18547 collaborative than ever, as I would have to rely on people that are more
18548 knowledgeable than I am on many parts of the code. Here is a list of the
18549 persons I could rely on, they should really be considered co-maintainers,
18550 either of the code or the community:
18554 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
18555 from worrying about possible bugs here and let me focus on other parts.
18557 @item Nicolas Goaziou
18558 Nicolas is maintaining the consistency of the deepest parts of Org. His work
18559 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
18560 the doors for many new ideas and features. He rewrote many of the old
18561 exporters to use the new export engine, and helped with documenting this
18562 major change. More importantly (if that's possible), he has been more than
18563 reliable during all the work done for Org 8.0, and always very reactive on
18567 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
18568 into a flexible and conceptually clean process. He patiently coped with the
18569 many hiccups that such a change can create for users.
18572 The Org mode mailing list would not be such a nice place without Nick, who
18573 patiently helped users so many times. It is impossible to overestimate such
18574 a great help, and the list would not be so active without him.
18577 I received support from so many users that it is clearly impossible to be
18578 fair when shortlisting a few of them, but Org's history would not be
18579 complete if the ones above were not mentioned in this manual.
18581 @section List of contributions
18586 @i{Russel Adams} came up with the idea for drawers.
18588 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
18589 feedback on many features and several patches.
18591 @i{Luis Anaya} wrote @file{ox-man.el}.
18593 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
18595 @i{Michael Brand} helped by reporting many bugs and testing many features.
18596 He also implemented the distinction between empty fields and 0-value fields
18597 in Org's spreadsheets.
18599 @i{Christophe Bataillon} created the great unicorn logo that we use on the
18602 @i{Alex Bochannek} provided a patch for rounding timestamps.
18604 @i{Jan Böcker} wrote @file{org-docview.el}.
18606 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
18608 @i{Tom Breton} wrote @file{org-choose.el}.
18610 @i{Charles Cave}'s suggestion sparked the implementation of templates
18611 for Remember, which are now templates for capture.
18613 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
18616 @i{Gregory Chernov} patched support for Lisp forms into table
18617 calculations and improved XEmacs compatibility, in particular by porting
18618 @file{nouline.el} to XEmacs.
18620 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
18621 make Org pupular through her blog.
18623 @i{Toby S. Cubitt} contributed to the code for clock formats.
18625 @i{Baoqiu Cui} contributed the first DocBook exporter. In Org 8.0, we go a
18626 different route: you can now export to Texinfo and export the @file{.texi}
18627 file to DocBook using @code{makeinfo}.
18629 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
18630 came up with the idea of properties, and that there should be an API for
18633 @i{Nick Dokos} tracked down several nasty bugs.
18635 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
18636 inspired some of the early development, including HTML export. He also
18637 asked for a way to narrow wide table columns.
18639 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
18640 several years now. He also sponsored the hosting costs until Rackspace
18641 started to host us for free.
18643 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
18644 the Org-Babel documentation into the manual.
18646 @i{Christian Egli} converted the documentation into Texinfo format, inspired
18647 the agenda, patched CSS formatting into the HTML exporter, and wrote
18648 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
18649 @file{ox-taskjuggler.el} for Org 8.0.
18651 @i{David Emery} provided a patch for custom CSS support in exported
18654 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
18656 @i{Nic Ferrier} contributed mailcap and XOXO support.
18658 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
18660 @i{John Foerch} figured out how to make incremental search show context
18661 around a match in a hidden outline tree.
18663 @i{Raimar Finken} wrote @file{org-git-line.el}.
18665 @i{Mikael Fornius} works as a mailing list moderator.
18667 @i{Austin Frank} works as a mailing list moderator.
18669 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18672 @i{Barry Gidden} did proofreading the manual in preparation for the book
18673 publication through Network Theory Ltd.
18675 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18677 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
18678 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18679 in implementing a clean framework for Org exporters.
18681 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18683 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18686 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18687 task state change logging, and the clocktable. His clear explanations have
18688 been critical when we started to adopt the Git version control system.
18690 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18693 @i{Phil Jackson} wrote @file{org-irc.el}.
18695 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18696 folded entries, and column view for properties.
18698 @i{Matt Jones} wrote @i{MobileOrg Android}.
18700 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18702 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18704 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
18705 provided frequent feedback and some patches.
18707 @i{Matt Lundin} has proposed last-row references for table formulas and named
18708 invisible anchors. He has also worked a lot on the FAQ.
18710 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18711 and is a prolific contributor on the mailing list with competent replies,
18712 small fixes and patches.
18714 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18716 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18718 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18721 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18724 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18726 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18727 and being able to quickly restrict the agenda to a subtree.
18729 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18731 @i{Greg Newman} refreshed the unicorn logo into its current form.
18733 @i{Tim O'Callaghan} suggested in-file links, search options for general
18734 file links, and TAGS.
18736 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18737 version of the reference card.
18739 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18742 @i{Oliver Oppitz} suggested multi-state TODO items.
18744 @i{Scott Otterson} sparked the introduction of descriptive text for
18745 links, among other things.
18747 @i{Pete Phillips} helped during the development of the TAGS feature, and
18748 provided frequent feedback.
18750 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18753 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18754 into bundles of 20 for undo.
18756 @i{Rackspace.com} is hosting our website for free. Thank you Rackspace!
18758 @i{T.V. Raman} reported bugs and suggested improvements.
18760 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18763 @i{Paul Rivier} provided the basic implementation of named footnotes. He
18764 also acted as mailing list moderator for some time.
18766 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18768 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18769 conflict with @file{allout.el}.
18771 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18774 @i{Philip Rooke} created the Org reference card, provided lots
18775 of feedback, developed and applied standards to the Org documentation.
18777 @i{Christian Schlauer} proposed angular brackets around links, among
18780 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18781 enjoy folding in non-org buffers by using Org headlines in comments.
18783 @i{Paul Sexton} wrote @file{org-ctags.el}.
18785 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18786 @file{organizer-mode.el}.
18788 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18789 examples, and remote highlighting for referenced code lines.
18791 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18792 now packaged into Org's @file{contrib} directory.
18794 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18797 @i{Dale Smith} proposed link abbreviations.
18799 @i{James TD Smith} has contributed a large number of patches for useful
18800 tweaks and features.
18802 @i{Adam Spiers} asked for global linking commands, inspired the link
18803 extension system, added support for mairix, and proposed the mapping API.
18805 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18806 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18808 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18809 with links transformation to Org syntax.
18811 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18812 chapter about publishing.
18814 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18816 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18817 enabled source code highlighting in Gnus.
18819 @i{Stefan Vollmar} organized a video-recorded talk at the
18820 Max-Planck-Institute for Neurology. He also inspired the creation of a
18821 concept index for HTML export.
18823 @i{J@"urgen Vollmer} contributed code generating the table of contents
18826 @i{Samuel Wales} has provided important feedback and bug reports.
18828 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18831 @i{David Wainberg} suggested archiving, and improvements to the linking
18834 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18837 @i{Roland Winkler} requested additional key bindings to make Org
18840 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18841 and contributed various ideas and code snippets.
18845 @node GNU Free Documentation License
18846 @appendix GNU Free Documentation License
18847 @include doclicense.texi
18851 @unnumbered Concept index
18856 @unnumbered Key index
18860 @node Command and Function Index
18861 @unnumbered Command and function index
18865 @node Variable Index
18866 @unnumbered Variable index
18868 This is not a complete index of variables and faces, only the ones that are
18869 mentioned in the manual. For a more complete list, use @kbd{M-x
18870 org-customize @key{RET}} and then click yourself through the tree.
18876 @c Local variables:
18878 @c indent-tabs-mode: nil
18879 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
18880 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
18884 @c LocalWords: webdavhost pre