3 @setfilename ../../info/org
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 * iCalendar export:: Exporting to iCalendar
587 * Other built-in back-ends:: Exporting to @code{Texinfo} or a man page
588 * Export in foreign buffers:: Author tables and lists in Org syntax
589 * Advanced configuration:: Fine-tuning the export output
593 * HTML Export commands:: How to invoke HTML export
594 * HTML doctypes:: Org can export to various (X)HTML flavors
595 * HTML preamble and postamble:: How to insert a preamble and a postamble
596 * Quoting HTML tags:: Using direct HTML in Org mode
597 * Links in HTML export:: How links will be interpreted and formatted
598 * Tables in HTML export:: How to modify the formatting of tables
599 * Images in HTML export:: How to insert figures into HTML output
600 * Math formatting in HTML export:: Beautiful math also on the web
601 * Text areas in HTML export:: An alternative way to show an example
602 * CSS support:: Changing the appearance of the output
603 * JavaScript support:: Info and Folding in a web browser
605 @LaTeX{} and PDF export
607 * @LaTeX{} export commands:: How to export to LaTeX and PDF
608 * Header and sectioning:: Setting up the export file structure
609 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
610 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
612 OpenDocument text export
614 * Pre-requisites for ODT export:: What packages ODT exporter relies on
615 * ODT export commands:: How to invoke ODT export
616 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
617 * Applying custom styles:: How to apply custom styles to the output
618 * Links in ODT export:: How links will be interpreted and formatted
619 * Tables in ODT export:: How Tables are exported
620 * Images in ODT export:: How to insert images
621 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
622 * Labels and captions in ODT export:: How captions are rendered
623 * Literal examples in ODT export:: How source and example blocks are formatted
624 * Advanced topics in ODT export:: Read this if you are a power user
626 Math formatting in ODT export
628 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
629 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
631 Advanced topics in ODT export
633 * Configuring a document converter:: How to register a document converter
634 * Working with OpenDocument style files:: Explore the internals
635 * Creating one-off styles:: How to produce custom highlighting etc
636 * Customizing tables in ODT export:: How to define and use Table templates
637 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
641 * Configuration:: Defining projects
642 * Uploading files:: How to get files up on the server
643 * Sample configuration:: Example projects
644 * Triggering publication:: Publication commands
648 * Project alist:: The central configuration variable
649 * Sources and destinations:: From here to there
650 * Selecting files:: What files are part of the project?
651 * Publishing action:: Setting the function doing the publishing
652 * Publishing options:: Tweaking HTML/@LaTeX{} export
653 * Publishing links:: Which links keep working after publishing?
654 * Sitemap:: Generating a list of all pages
655 * Generating an index:: An index that reaches across pages
659 * Simple example:: One-component publishing
660 * Complex example:: A multi-component publishing example
662 Working with source code
664 * Structure of code blocks:: Code block syntax described
665 * Editing source code:: Language major-mode editing
666 * Exporting code blocks:: Export contents and/or results
667 * Extracting source code:: Create pure source code files
668 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
669 * Library of Babel:: Use and contribute to a library of useful code blocks
670 * Languages:: List of supported code block languages
671 * Header arguments:: Configure code block functionality
672 * Results of evaluation:: How evaluation results are handled
673 * Noweb reference syntax:: Literate programming in Org mode
674 * Key bindings and useful functions:: Work quickly with code blocks
675 * Batch execution:: Call functions from the command line
679 * Using header arguments:: Different ways to set header arguments
680 * Specific header arguments:: List of header arguments
682 Using header arguments
684 * System-wide header arguments:: Set global default values
685 * Language-specific header arguments:: Set default values by language
686 * Header arguments in Org mode properties:: Set default values for a buffer or heading
687 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
688 * Code block specific header arguments:: The most common way to set values
689 * Header arguments in function calls:: The most specific level
691 Specific header arguments
693 * var:: Pass arguments to code blocks
694 * Results:: Specify the type of results and how they will
695 be collected and handled
696 * file:: Specify a path for file output
697 * file-desc:: Specify a description for file results
698 * dir:: Specify the default (possibly remote)
699 directory for code block execution
700 * exports:: Export code and/or results
701 * tangle:: Toggle tangling and specify file name
702 * mkdirp:: Toggle creation of parent directories of target
703 files during tangling
704 * comments:: Toggle insertion of comments in tangled
706 * padline:: Control insertion of padding lines in tangled
708 * no-expand:: Turn off variable assignment and noweb
709 expansion during tangling
710 * session:: Preserve the state of code evaluation
711 * noweb:: Toggle expansion of noweb references
712 * noweb-ref:: Specify block's noweb reference resolution target
713 * noweb-sep:: String used to separate noweb references
714 * cache:: Avoid re-evaluating unchanged code blocks
715 * sep:: Delimiter for writing tabular results outside Org
716 * hlines:: Handle horizontal lines in tables
717 * colnames:: Handle column names in tables
718 * rownames:: Handle row names in tables
719 * shebang:: Make tangled files executable
720 * tangle-mode:: Set permission of tangled files
721 * eval:: Limit evaluation of specific code blocks
722 * wrap:: Mark source block evaluation results
723 * post:: Post processing of code block results
724 * prologue:: Text to prepend to code block body
725 * epilogue:: Text to append to code block body
729 * Completion:: M-TAB knows what you need
730 * Easy templates:: Quick insertion of structural elements
731 * Speed keys:: Electric commands at the beginning of a headline
732 * Code evaluation security:: Org mode files evaluate inline code
733 * Customization:: Adapting Org to your taste
734 * In-buffer settings:: Overview of the #+KEYWORDS
735 * The very busy C-c C-c key:: When in doubt, press C-c C-c
736 * Clean view:: Getting rid of leading stars in the outline
737 * TTY keys:: Using Org on a tty
738 * Interaction:: Other Emacs packages
739 * org-crypt:: Encrypting Org files
741 Interaction with other packages
743 * Cooperation:: Packages Org cooperates with
744 * Conflicts:: Packages that lead to conflicts
748 * Hooks:: How to reach into Org's internals
749 * Add-on packages:: Available extensions
750 * Adding hyperlink types:: New custom link types
751 * Adding export back-ends:: How to write new export back-ends
752 * Context-sensitive commands:: How to add functionality to such commands
753 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
754 * Dynamic blocks:: Automatically filled blocks
755 * Special agenda views:: Customized views
756 * Speeding up your agendas:: Tips on how to speed up your agendas
757 * Extracting agenda information:: Post-processing of agenda information
758 * Using the property API:: Writing programs that use entry properties
759 * Using the mapping API:: Mapping over all or selected entries
761 Tables and lists in arbitrary syntax
763 * Radio tables:: Sending and receiving radio tables
764 * A @LaTeX{} example:: Step by step, almost a tutorial
765 * Translator functions:: Copy and modify
766 * Radio lists:: Sending and receiving lists
770 * Setting up the staging area:: Where to interact with the mobile device
771 * Pushing to MobileOrg:: Uploading Org files and agendas
772 * Pulling from MobileOrg:: Integrating captured and flagged items
778 @chapter Introduction
782 * Summary:: Brief summary of what Org does
783 * Installation:: Installing Org
784 * Activation:: How to activate Org for certain buffers
785 * Feedback:: Bug reports, ideas, patches etc.
786 * Conventions:: Typesetting conventions in the manual
793 Org is a mode for keeping notes, maintaining TODO lists, and project planning
794 with a fast and effective plain-text system. It also is an authoring system
795 with unique support for literate programming and reproducible research.
797 Org is implemented on top of Outline mode, which makes it possible to keep
798 the content of large files well structured. Visibility cycling and structure
799 editing help to work with the tree. Tables are easily created with a
800 built-in table editor. Plain text URL-like links connect to websites,
801 emails, Usenet messages, BBDB entries, and any files related to the projects.
803 Org develops organizational tasks around notes files that contain lists or
804 information about projects as plain text. Project planning and task
805 management makes use of metadata which is part of an outline node. Based on
806 this data, specific entries can be extracted in queries and create dynamic
807 @i{agenda views} that also integrate the Emacs calendar and diary. Org can
808 be used to implement many different project planning schemes, such as David
811 Org files can serve as a single source authoring system with export to many
812 different formats such as HTML, @LaTeX{}, Open Document, and Markdown. New
813 export backends can be derived from existing ones, or defined from scratch.
815 Org files can include source code blocks, which makes Org uniquely suited for
816 authoring technical documents with code examples. Org source code blocks are
817 fully functional; they can be evaluated in place and their results can be
818 captured in the file. This makes it possible to create a single file
819 reproducible research compendium.
821 Org keeps simple things simple. When first fired up, it should feel like a
822 straightforward, easy to use outliner. Complexity is not imposed, but a
823 large amount of functionality is available when needed. Org is a toolbox.
824 Many users usilize only a (very personal) fraction of Org's capabilities, and
825 know that there is more whenever they need it.
827 All of this is achieved with strictly plain text files, the most portable and
828 future-proof file format. Org runs in Emacs. Emacs is one of the most
829 widely ported programs, so that Org mode is available on every major
833 There is a website for Org which provides links to the newest
834 version of Org, as well as additional information, frequently asked
835 questions (FAQ), links to tutorials, etc. This page is located at
836 @uref{http://orgmode.org}.
837 @cindex print edition
839 An earlier version (7.3) of this manual is available as a
840 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
846 @section Installation
850 Org is part of recent distributions of GNU Emacs, so you normally don't need
851 to install it. If, for one reason or another, you want to install Org on top
852 of this pre-packaged version, there are three ways to do it:
855 @item By using Emacs package system.
856 @item By downloading Org as an archive.
857 @item By using Org's git repository.
860 We @b{strongly recommend} to stick to a single installation method.
862 @subsubheading Using Emacs packaging system
864 Recent Emacs distributions include a packaging system which lets you install
865 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
867 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
868 been visited, i.e. where no Org built-in function have been loaded.
869 Otherwise autoload Org functions will mess up the installation.
871 Then, to make sure your Org configuration is taken into account, initialize
872 the package system with @code{(package-initialize)} in your @file{.emacs}
873 before setting any Org option. If you want to use Org's package repository,
874 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
876 @subsubheading Downloading Org as an archive
878 You can download Org latest release from @uref{http://orgmode.org/, Org's
879 website}. In this case, make sure you set the load-path correctly in your
883 (add-to-list 'load-path "~/path/to/orgdir/lisp")
886 The downloaded archive contains contributed libraries that are not included
887 in Emacs. If you want to use them, add the @file{contrib} directory to your
891 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
894 Optionally, you can compile the files and/or install them in your system.
895 Run @code{make help} to list compilation and installation options.
897 @subsubheading Using Org's git repository
899 You can clone Org's repository and install Org like this:
903 $ git clone git://orgmode.org/org-mode.git
907 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
908 version in @file{org-version.el} and Org's autoloads in
909 @file{org-loaddefs.el}.
911 Remember to add the correct load-path as described in the method above.
913 You can also compile with @code{make}, generate the documentation with
914 @code{make doc}, create a local configuration with @code{make config} and
915 install Org with @code{make install}. Please run @code{make help} to get
916 the list of compilation/installation options.
918 For more detailed explanations on Org's build system, please check the Org
919 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
927 @cindex global key bindings
928 @cindex key bindings, global
931 @findex org-store-link
934 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
935 default. If you are using an earlier version of Emacs, add this line to your
939 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
942 Org mode buffers need font-lock to be turned on: this is the default in
943 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
944 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
946 There are compatibility issues between Org mode and some other Elisp
947 packages, please take the time to check the list (@pxref{Conflicts}).
949 The four Org commands @command{org-store-link}, @command{org-capture},
950 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
951 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
952 suggested bindings for these keys, please modify the keys to your own
955 (global-set-key "\C-cl" 'org-store-link)
956 (global-set-key "\C-ca" 'org-agenda)
957 (global-set-key "\C-cc" 'org-capture)
958 (global-set-key "\C-cb" 'org-iswitchb)
961 @cindex Org mode, turning on
962 To turn on Org mode in a file that does not have the extension @file{.org},
963 make the first line of a file look like this:
966 MY PROJECTS -*- mode: org; -*-
969 @vindex org-insert-mode-line-in-empty-file
970 @noindent which will select Org mode for this buffer no matter what
971 the file's name is. See also the variable
972 @code{org-insert-mode-line-in-empty-file}.
974 Many commands in Org work on the region if the region is @i{active}. To make
975 use of this, you need to have @code{transient-mark-mode}
976 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
977 in Emacs 22 you need to do this yourself with
979 (transient-mark-mode 1)
981 @noindent If you do not like @code{transient-mark-mode}, you can create an
982 active region by using the mouse to select a region, or pressing
983 @kbd{C-@key{SPC}} twice before moving the cursor.
992 If you find problems with Org, or if you have questions, remarks, or ideas
993 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
994 You can subscribe to the list
995 @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, on this web page}.
996 If you are not a member of the mailing list, your mail will be passed to the
997 list after a moderator has approved it@footnote{Please consider subscribing
998 to the mailing list, in order to minimize the work the mailing list
999 moderators have to do.}.
1001 For bug reports, please first try to reproduce the bug with the latest
1002 version of Org available---if you are running an outdated version, it is
1003 quite possible that the bug has been fixed already. If the bug persists,
1004 prepare a report and provide as much information as possible, including the
1005 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1006 (@kbd{M-x org-version RET}), as well as the Org related setup in
1007 @file{.emacs}. The easiest way to do this is to use the command
1009 @kbd{M-x org-submit-bug-report RET}
1011 @noindent which will put all this information into an Emacs mail buffer so
1012 that you only need to add your description. If you are not sending the Email
1013 from within Emacs, please copy and paste the content into your Email program.
1015 Sometimes you might face a problem due to an error in your Emacs or Org mode
1016 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1017 customizations and reproduce the problem. Doing so often helps you determine
1018 if the problem is with your customization or with Org mode itself. You can
1019 start a typical minimal session with a command like the example below.
1022 $ emacs -Q -l /path/to/minimal-org.el
1025 However if you are using Org mode as distributed with Emacs, a minimal setup
1026 is not necessary. In that case it is sufficient to start Emacs as
1027 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1031 ;;; Minimal setup to load latest `org-mode'
1033 ;; activate debugging
1034 (setq debug-on-error t
1038 ;; add latest org-mode to load path
1039 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1040 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1043 If an error occurs, a backtrace can be very useful (see below on how to
1044 create one). Often a small example file helps, along with clear information
1048 @item What exactly did you do?
1049 @item What did you expect to happen?
1050 @item What happened instead?
1052 @noindent Thank you for helping to improve this program.
1054 @subsubheading How to create a useful backtrace
1056 @cindex backtrace of an error
1057 If working with Org produces an error with a message you don't
1058 understand, you may have hit a bug. The best way to report this is by
1059 providing, in addition to what was mentioned above, a @emph{backtrace}.
1060 This is information from the built-in debugger about where and how the
1061 error occurred. Here is how to produce a useful backtrace:
1065 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1066 contains much more information if it is produced with uncompiled code.
1069 @kbd{C-u M-x org-reload RET}
1072 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1075 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1076 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1078 Do whatever you have to do to hit the error. Don't forget to
1079 document the steps you take.
1081 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1082 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1083 attach it to your bug report.
1087 @section Typesetting conventions used in this manual
1089 @subsubheading TODO keywords, tags, properties, etc.
1091 Org mainly uses three types of keywords: TODO keywords, tags and property
1092 names. In this manual we use the following conventions:
1097 TODO keywords are written with all capitals, even if they are
1101 User-defined tags are written in lowercase; built-in tags with special
1102 meaning are written with all capitals.
1105 User-defined properties are capitalized; built-in properties with
1106 special meaning are written with all capitals.
1109 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1110 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1111 environment). They are written in uppercase in the manual to enhance its
1112 readability, but you can use lowercase in your Org files@footnote{Easy
1113 templates insert lowercase keywords and Babel dynamically inserts
1116 @subsubheading Keybindings and commands
1122 The manual suggests a few global keybindings, in particular @kbd{C-c a} for
1123 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}. These are only
1124 suggestions, but the rest of the manual assumes that these keybindings are in
1125 place in order to list commands by key access.
1127 Also, the manual lists both the keys and the corresponding commands for
1128 accessing a functionality. Org mode often uses the same key for different
1129 functions, depending on context. The command that is bound to such keys has
1130 a generic name, like @code{org-metaright}. In the manual we will, wherever
1131 possible, give the function that is internally called by the generic command.
1132 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1133 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1134 will be listed to call @code{org-table-move-column-right}. If you prefer,
1135 you can compile the manual without the command names by unsetting the flag
1136 @code{cmdnames} in @file{org.texi}.
1138 @node Document structure
1139 @chapter Document structure
1140 @cindex document structure
1141 @cindex structure of document
1143 Org is based on Outline mode and provides flexible commands to
1144 edit the structure of the document.
1147 * Outlines:: Org is based on Outline mode
1148 * Headlines:: How to typeset Org tree headlines
1149 * Visibility cycling:: Show and hide, much simplified
1150 * Motion:: Jumping to other headlines
1151 * Structure editing:: Changing sequence and level of headlines
1152 * Sparse trees:: Matches embedded in context
1153 * Plain lists:: Additional structure within an entry
1154 * Drawers:: Tucking stuff away
1155 * Blocks:: Folding blocks
1156 * Footnotes:: How footnotes are defined in Org's syntax
1157 * Orgstruct mode:: Structure editing outside Org
1158 * Org syntax:: Formal description of Org's syntax
1164 @cindex Outline mode
1166 Org is implemented on top of Outline mode. Outlines allow a
1167 document to be organized in a hierarchical structure, which (at least
1168 for me) is the best representation of notes and thoughts. An overview
1169 of this structure is achieved by folding (hiding) large parts of the
1170 document to show only the general document structure and the parts
1171 currently being worked on. Org greatly simplifies the use of
1172 outlines by compressing the entire show/hide functionality into a single
1173 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1178 @cindex outline tree
1179 @vindex org-special-ctrl-a/e
1180 @vindex org-special-ctrl-k
1181 @vindex org-ctrl-k-protect-subtree
1183 Headlines define the structure of an outline tree. The headlines in Org
1184 start with one or more stars, on the left margin@footnote{See the variables
1185 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1186 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1187 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1188 headings indented less then 30 stars.}. For example:
1191 * Top level headline
1198 * Another top level headline
1201 @noindent Some people find the many stars too noisy and would prefer an
1202 outline that has whitespace followed by a single star as headline
1203 starters. @ref{Clean view}, describes a setup to realize this.
1205 @vindex org-cycle-separator-lines
1206 An empty line after the end of a subtree is considered part of it and
1207 will be hidden when the subtree is folded. However, if you leave at
1208 least two empty lines, one empty line will remain visible after folding
1209 the subtree, in order to structure the collapsed view. See the
1210 variable @code{org-cycle-separator-lines} to modify this behavior.
1212 @node Visibility cycling
1213 @section Visibility cycling
1214 @cindex cycling, visibility
1215 @cindex visibility cycling
1216 @cindex trees, visibility
1217 @cindex show hidden text
1221 * Global and local cycling:: Cycling through various visibility states
1222 * Initial visibility:: Setting the initial visibility state
1223 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1226 @node Global and local cycling
1227 @subsection Global and local cycling
1229 Outlines make it possible to hide parts of the text in the buffer.
1230 Org uses just two commands, bound to @key{TAB} and
1231 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1233 @cindex subtree visibility states
1234 @cindex subtree cycling
1235 @cindex folded, subtree visibility state
1236 @cindex children, subtree visibility state
1237 @cindex subtree, subtree visibility state
1239 @orgcmd{@key{TAB},org-cycle}
1240 @emph{Subtree cycling}: Rotate current subtree among the states
1243 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1244 '-----------------------------------'
1247 @vindex org-cycle-emulate-tab
1248 @vindex org-cycle-global-at-bob
1249 The cursor must be on a headline for this to work@footnote{see, however,
1250 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1251 beginning of the buffer and the first line is not a headline, then
1252 @key{TAB} actually runs global cycling (see below)@footnote{see the
1253 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1254 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1256 @cindex global visibility states
1257 @cindex global cycling
1258 @cindex overview, global visibility state
1259 @cindex contents, global visibility state
1260 @cindex show all, global visibility state
1261 @orgcmd{S-@key{TAB},org-global-cycle}
1262 @itemx C-u @key{TAB}
1263 @emph{Global cycling}: Rotate the entire buffer among the states
1266 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1267 '--------------------------------------'
1270 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1271 CONTENTS view up to headlines of level N will be shown. Note that inside
1272 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1274 @cindex set startup visibility, command
1275 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1276 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1277 @cindex show all, command
1278 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1279 Show all, including drawers.
1280 @cindex revealing context
1281 @orgcmd{C-c C-r,org-reveal}
1282 Reveal context around point, showing the current entry, the following heading
1283 and the hierarchy above. Useful for working near a location that has been
1284 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1285 (@pxref{Agenda commands}). With a prefix argument show, on each
1286 level, all sibling headings. With a double prefix argument, also show the
1287 entire subtree of the parent.
1288 @cindex show branches, command
1289 @orgcmd{C-c C-k,show-branches}
1290 Expose all the headings of the subtree, CONTENT view for just one subtree.
1291 @cindex show children, command
1292 @orgcmd{C-c @key{TAB},show-children}
1293 Expose all direct children of the subtree. With a numeric prefix argument N,
1294 expose all children down to level N@.
1295 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1296 Show the current subtree in an indirect buffer@footnote{The indirect buffer
1297 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
1298 buffer, but will be narrowed to the current tree. Editing the indirect
1299 buffer will also change the original buffer, but without affecting visibility
1300 in that buffer.}. With a numeric prefix argument N, go up to level N and
1301 then take that tree. If N is negative then go up that many levels. With a
1302 @kbd{C-u} prefix, do not remove the previously used indirect buffer.
1303 @orgcmd{C-c C-x v,org-copy-visible}
1304 Copy the @i{visible} text in the region into the kill ring.
1307 @node Initial visibility
1308 @subsection Initial visibility
1310 @cindex visibility, initialize
1311 @vindex org-startup-folded
1312 @vindex org-agenda-inhibit-startup
1313 @cindex @code{overview}, STARTUP keyword
1314 @cindex @code{content}, STARTUP keyword
1315 @cindex @code{showall}, STARTUP keyword
1316 @cindex @code{showeverything}, STARTUP keyword
1318 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1319 i.e., only the top level headlines are visible@footnote{When
1320 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1321 visibility state when first opening a file for the agenda (@pxref{Speeding up
1322 your agendas}).}. This can be configured through the variable
1323 @code{org-startup-folded}, or on a per-file basis by adding one of the
1324 following lines anywhere in the buffer:
1330 #+STARTUP: showeverything
1333 The startup visibility options are ignored when the file is open for the
1334 first time during the agenda generation: if you want the agenda to honor
1335 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1337 @cindex property, VISIBILITY
1339 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1340 and columns}) will get their visibility adapted accordingly. Allowed values
1341 for this property are @code{folded}, @code{children}, @code{content}, and
1345 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1346 Switch back to the startup visibility of the buffer, i.e., whatever is
1347 requested by startup options and @samp{VISIBILITY} properties in individual
1351 @node Catching invisible edits
1352 @subsection Catching invisible edits
1354 @vindex org-catch-invisible-edits
1355 @cindex edits, catching invisible
1356 Sometimes you may inadvertently edit an invisible part of the buffer and be
1357 confused on what has been edited and how to undo the mistake. Setting
1358 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
1359 docstring of this option on how Org should catch invisible edits and process
1364 @cindex motion, between headlines
1365 @cindex jumping, to headlines
1366 @cindex headline navigation
1367 The following commands jump to other headlines in the buffer.
1370 @orgcmd{C-c C-n,outline-next-visible-heading}
1372 @orgcmd{C-c C-p,outline-previous-visible-heading}
1374 @orgcmd{C-c C-f,org-forward-same-level}
1375 Next heading same level.
1376 @orgcmd{C-c C-b,org-backward-same-level}
1377 Previous heading same level.
1378 @orgcmd{C-c C-u,outline-up-heading}
1379 Backward to higher level heading.
1380 @orgcmd{C-c C-j,org-goto}
1381 Jump to a different place without changing the current outline
1382 visibility. Shows the document structure in a temporary buffer, where
1383 you can use the following keys to find your destination:
1384 @vindex org-goto-auto-isearch
1386 @key{TAB} @r{Cycle visibility.}
1387 @key{down} / @key{up} @r{Next/previous visible headline.}
1388 @key{RET} @r{Select this location.}
1389 @kbd{/} @r{Do a Sparse-tree search}
1390 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1391 n / p @r{Next/previous visible headline.}
1392 f / b @r{Next/previous headline same level.}
1394 0-9 @r{Digit argument.}
1397 @vindex org-goto-interface
1399 See also the option @code{org-goto-interface}.
1402 @node Structure editing
1403 @section Structure editing
1404 @cindex structure editing
1405 @cindex headline, promotion and demotion
1406 @cindex promotion, of subtrees
1407 @cindex demotion, of subtrees
1408 @cindex subtree, cut and paste
1409 @cindex pasting, of subtrees
1410 @cindex cutting, of subtrees
1411 @cindex copying, of subtrees
1412 @cindex sorting, of subtrees
1413 @cindex subtrees, cut and paste
1416 @orgcmd{M-@key{RET},org-insert-heading}
1417 @vindex org-M-RET-may-split-line
1418 Insert a new heading/item with the same level as the one at point.
1419 If the cursor is in a plain list item, a new item is created
1420 (@pxref{Plain lists}). To prevent this behavior in lists, call the
1421 command with a prefix argument. When this command is used in the
1422 middle of a line, the line is split and the rest of the line becomes
1423 the new item or headline@footnote{If you do not want the line to be
1424 split, customize the variable @code{org-M-RET-may-split-line}.}. If
1425 the command is used at the @emph{beginning} of a headline, the new
1426 headline is created before the current line. If the command is used
1427 at the @emph{end} of a folded subtree (i.e., behind the ellipses at
1428 the end of a headline), then a headline will be
1429 inserted after the end of the subtree. Calling this command with
1430 @kbd{C-u C-u} will unconditionally respect the headline's content and
1431 create a new item at the end of the parent subtree.
1432 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1433 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1434 current heading, the new heading is placed after the body instead of before
1435 it. This command works from anywhere in the entry.
1436 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1437 @vindex org-treat-insert-todo-heading-as-state-change
1438 Insert new TODO entry with same level as current heading. See also the
1439 variable @code{org-treat-insert-todo-heading-as-state-change}.
1440 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1441 Insert new TODO entry with same level as current heading. Like
1442 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1444 @orgcmd{@key{TAB},org-cycle}
1445 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1446 become a child of the previous one. The next @key{TAB} makes it a parent,
1447 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1448 to the initial level.
1449 @orgcmd{M-@key{left},org-do-promote}
1450 Promote current heading by one level.
1451 @orgcmd{M-@key{right},org-do-demote}
1452 Demote current heading by one level.
1453 @orgcmd{M-S-@key{left},org-promote-subtree}
1454 Promote the current subtree by one level.
1455 @orgcmd{M-S-@key{right},org-demote-subtree}
1456 Demote the current subtree by one level.
1457 @orgcmd{M-S-@key{up},org-move-subtree-up}
1458 Move subtree up (swap with previous subtree of same
1460 @orgcmd{M-S-@key{down},org-move-subtree-down}
1461 Move subtree down (swap with next subtree of same level).
1462 @orgcmd{M-h,org-mark-element}
1463 Mark the element at point. Hitting repeatedly will mark subsequent elements
1464 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1465 hitting @key{M-h} immediately again will mark the next one.
1466 @orgcmd{C-c @@,org-mark-subtree}
1467 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1468 of the same level than the marked subtree.
1469 @orgcmd{C-c C-x C-w,org-cut-subtree}
1470 Kill subtree, i.e., remove it from buffer but save in kill ring.
1471 With a numeric prefix argument N, kill N sequential subtrees.
1472 @orgcmd{C-c C-x M-w,org-copy-subtree}
1473 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1474 sequential subtrees.
1475 @orgcmd{C-c C-x C-y,org-paste-subtree}
1476 Yank subtree from kill ring. This does modify the level of the subtree to
1477 make sure the tree fits in nicely at the yank position. The yank level can
1478 also be specified with a numeric prefix argument, or by yanking after a
1479 headline marker like @samp{****}.
1480 @orgcmd{C-y,org-yank}
1481 @vindex org-yank-adjusted-subtrees
1482 @vindex org-yank-folded-subtrees
1483 Depending on the options @code{org-yank-adjusted-subtrees} and
1484 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1485 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1486 C-x C-y}. With the default settings, no level adjustment will take place,
1487 but the yanked tree will be folded unless doing so would swallow text
1488 previously visible. Any prefix argument to this command will force a normal
1489 @code{yank} to be executed, with the prefix passed along. A good way to
1490 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1491 yank, it will yank previous kill items plainly, without adjustment and
1493 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1494 Clone a subtree by making a number of sibling copies of it. You will be
1495 prompted for the number of copies to make, and you can also specify if any
1496 timestamps in the entry should be shifted. This can be useful, for example,
1497 to create a number of tasks related to a series of lectures to prepare. For
1498 more details, see the docstring of the command
1499 @code{org-clone-subtree-with-time-shift}.
1500 @orgcmd{C-c C-w,org-refile}
1501 Refile entry or region to a different location. @xref{Refile and copy}.
1502 @orgcmd{C-c ^,org-sort}
1503 Sort same-level entries. When there is an active region, all entries in the
1504 region will be sorted. Otherwise the children of the current headline are
1505 sorted. The command prompts for the sorting method, which can be
1506 alphabetically, numerically, by time (first timestamp with active preferred,
1507 creation time, scheduled time, deadline time), by priority, by TODO keyword
1508 (in the sequence the keywords have been defined in the setup) or by the value
1509 of a property. Reverse sorting is possible as well. You can also supply
1510 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1511 sorting will be case-sensitive.
1512 @orgcmd{C-x n s,org-narrow-to-subtree}
1513 Narrow buffer to current subtree.
1514 @orgcmd{C-x n b,org-narrow-to-block}
1515 Narrow buffer to current block.
1516 @orgcmd{C-x n w,widen}
1517 Widen buffer to remove narrowing.
1518 @orgcmd{C-c *,org-toggle-heading}
1519 Turn a normal line or plain list item into a headline (so that it becomes a
1520 subheading at its location). Also turn a headline into a normal line by
1521 removing the stars. If there is an active region, turn all lines in the
1522 region into headlines. If the first line in the region was an item, turn
1523 only the item lines into headlines. Finally, if the first line is a
1524 headline, remove the stars from all headlines in the region.
1527 @cindex region, active
1528 @cindex active region
1529 @cindex transient mark mode
1530 When there is an active region (Transient Mark mode), promotion and
1531 demotion work on all headlines in the region. To select a region of
1532 headlines, it is best to place both point and mark at the beginning of a
1533 line, mark at the beginning of the first headline, and point at the line
1534 just after the last headline to change. Note that when the cursor is
1535 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1540 @section Sparse trees
1541 @cindex sparse trees
1542 @cindex trees, sparse
1543 @cindex folding, sparse trees
1544 @cindex occur, command
1546 @vindex org-show-hierarchy-above
1547 @vindex org-show-following-heading
1548 @vindex org-show-siblings
1549 @vindex org-show-entry-below
1550 An important feature of Org mode is the ability to construct @emph{sparse
1551 trees} for selected information in an outline tree, so that the entire
1552 document is folded as much as possible, but the selected information is made
1553 visible along with the headline structure above it@footnote{See also the
1554 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1555 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1556 control on how much context is shown around each match.}. Just try it out
1557 and you will see immediately how it works.
1559 Org mode contains several commands for creating such trees, all these
1560 commands can be accessed through a dispatcher:
1563 @orgcmd{C-c /,org-sparse-tree}
1564 This prompts for an extra key to select a sparse-tree creating command.
1565 @orgcmd{C-c / r,org-occur}
1566 @vindex org-remove-highlights-with-change
1567 Prompts for a regexp and shows a sparse tree with all matches. If
1568 the match is in a headline, the headline is made visible. If the match is in
1569 the body of an entry, headline and body are made visible. In order to
1570 provide minimal context, also the full hierarchy of headlines above the match
1571 is shown, as well as the headline following the match. Each match is also
1572 highlighted; the highlights disappear when the buffer is changed by an
1573 editing command@footnote{This depends on the option
1574 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1575 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1576 so several calls to this command can be stacked.
1577 @orgcmdkkc{M-g n,M-g M-n,next-error}
1578 Jump to the next sparse tree match in this buffer.
1579 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1580 Jump to the previous sparse tree match in this buffer.
1584 @vindex org-agenda-custom-commands
1585 For frequently used sparse trees of specific search strings, you can
1586 use the option @code{org-agenda-custom-commands} to define fast
1587 keyboard access to specific sparse trees. These commands will then be
1588 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1592 (setq org-agenda-custom-commands
1593 '(("f" occur-tree "FIXME")))
1596 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1597 a sparse tree matching the string @samp{FIXME}.
1599 The other sparse tree commands select headings based on TODO keywords,
1600 tags, or properties and will be discussed later in this manual.
1603 @cindex printing sparse trees
1604 @cindex visible text, printing
1605 To print a sparse tree, you can use the Emacs command
1606 @code{ps-print-buffer-with-faces} which does not print invisible parts
1607 of the document @footnote{This does not work under XEmacs, because
1608 XEmacs uses selective display for outlining, not text properties.}.
1609 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1610 the document and print the resulting file.
1613 @section Plain lists
1615 @cindex lists, plain
1616 @cindex lists, ordered
1617 @cindex ordered lists
1619 Within an entry of the outline tree, hand-formatted lists can provide
1620 additional structure. They also provide a way to create lists of checkboxes
1621 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1622 (@pxref{Exporting}) can parse and format them.
1624 Org knows ordered lists, unordered lists, and description lists.
1627 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1628 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1629 they will be seen as top-level headlines. Also, when you are hiding leading
1630 stars to get a clean outline view, plain list items starting with a star may
1631 be hard to distinguish from true headlines. In short: even though @samp{*}
1632 is supported, it may be better to not use it for plain list items.} as
1635 @vindex org-plain-list-ordered-item-terminator
1636 @vindex org-list-allow-alphabetical
1637 @emph{Ordered} list items start with a numeral followed by either a period or
1638 a right parenthesis@footnote{You can filter out any of them by configuring
1639 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1640 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1641 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1642 confusion with normal text, those are limited to one character only. Beyond
1643 that limit, bullets will automatically fallback to numbers.}. If you want a
1644 list to start with a different value (e.g., 20), start the text of the item
1645 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1646 must be put @emph{before} the checkbox. If you have activated alphabetical
1647 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1648 be used in any item of the list in order to enforce a particular numbering.
1650 @emph{Description} list items are unordered list items, and contain the
1651 separator @samp{ :: } to distinguish the description @emph{term} from the
1655 Items belonging to the same list must have the same indentation on the first
1656 line. In particular, if an ordered list reaches number @samp{10.}, then the
1657 2--digit numbers must be written left-aligned with the other numbers in the
1658 list. An item ends before the next line that is less or equally indented
1659 than its bullet/number.
1661 @vindex org-list-empty-line-terminates-plain-lists
1662 A list ends whenever every item has ended, which means before any line less
1663 or equally indented than items at top level. It also ends before two blank
1664 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1665 In that case, all items are closed. Here is an example:
1669 ** Lord of the Rings
1670 My favorite scenes are (in this order)
1671 1. The attack of the Rohirrim
1672 2. Eowyn's fight with the witch king
1673 + this was already my favorite scene in the book
1674 + I really like Miranda Otto.
1675 3. Peter Jackson being shot by Legolas
1677 He makes a really funny face when it happens.
1678 But in the end, no individual scenes matter but the film as a whole.
1679 Important actors in this film are:
1680 - @b{Elijah Wood} :: He plays Frodo
1681 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1682 him very well from his role as Mikey Walsh in @i{The Goonies}.
1686 Org supports these lists by tuning filling and wrapping commands to deal with
1687 them correctly@footnote{Org only changes the filling settings for Emacs. For
1688 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1689 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1690 properly (@pxref{Exporting}). Since indentation is what governs the
1691 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1692 blocks can be indented to signal that they belong to a particular item.
1694 @vindex org-list-demote-modify-bullet
1695 @vindex org-list-indent-offset
1696 If you find that using a different bullet for a sub-list (than that used for
1697 the current list-level) improves readability, customize the variable
1698 @code{org-list-demote-modify-bullet}. To get a greater difference of
1699 indentation between items and their sub-items, customize
1700 @code{org-list-indent-offset}.
1702 @vindex org-list-automatic-rules
1703 The following commands act on items when the cursor is in the first line of
1704 an item (the line with the bullet or number). Some of them imply the
1705 application of automatic rules to keep list structure intact. If some of
1706 these actions get in your way, configure @code{org-list-automatic-rules}
1707 to disable them individually.
1710 @orgcmd{@key{TAB},org-cycle}
1711 @cindex cycling, in plain lists
1712 @vindex org-cycle-include-plain-lists
1713 Items can be folded just like headline levels. Normally this works only if
1714 the cursor is on a plain list item. For more details, see the variable
1715 @code{org-cycle-include-plain-lists}. If this variable is set to
1716 @code{integrate}, plain list items will be treated like low-level
1717 headlines. The level of an item is then given by the indentation of the
1718 bullet/number. Items are always subordinate to real headlines, however; the
1719 hierarchies remain completely separated. In a new item with no text yet, the
1720 first @key{TAB} demotes the item to become a child of the previous
1721 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1722 and eventually get it back to its initial position.
1723 @orgcmd{M-@key{RET},org-insert-heading}
1724 @vindex org-M-RET-may-split-line
1725 @vindex org-list-automatic-rules
1726 Insert new item at current level. With a prefix argument, force a new
1727 heading (@pxref{Structure editing}). If this command is used in the middle
1728 of an item, that item is @emph{split} in two, and the second part becomes the
1729 new item@footnote{If you do not want the item to be split, customize the
1730 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1731 @emph{before item's body}, the new item is created @emph{before} the current
1736 @kindex M-S-@key{RET}
1738 Insert a new item with a checkbox (@pxref{Checkboxes}).
1739 @kindex S-@key{down}
1742 @cindex shift-selection-mode
1743 @vindex org-support-shift-select
1744 @vindex org-list-use-circular-motion
1745 Jump to the previous/next item in the current list@footnote{If you want to
1746 cycle around items that way, you may customize
1747 @code{org-list-use-circular-motion}.}, but only if
1748 @code{org-support-shift-select} is off. If not, you can still use paragraph
1749 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1752 @kindex M-@key{down}
1755 Move the item including subitems up/down@footnote{See
1756 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1757 previous/next item of same indentation). If the list is ordered, renumbering
1759 @kindex M-@key{left}
1760 @kindex M-@key{right}
1763 Decrease/increase the indentation of an item, leaving children alone.
1764 @kindex M-S-@key{left}
1765 @kindex M-S-@key{right}
1766 @item M-S-@key{left}
1767 @itemx M-S-@key{right}
1768 Decrease/increase the indentation of the item, including subitems.
1769 Initially, the item tree is selected based on current indentation. When
1770 these commands are executed several times in direct succession, the initially
1771 selected region is used, even if the new indentation would imply a different
1772 hierarchy. To use the new hierarchy, break the command chain with a cursor
1775 As a special case, using this command on the very first item of a list will
1776 move the whole list. This behavior can be disabled by configuring
1777 @code{org-list-automatic-rules}. The global indentation of a list has no
1778 influence on the text @emph{after} the list.
1781 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1782 state of the checkbox. In any case, verify bullets and indentation
1783 consistency in the whole list.
1785 @vindex org-plain-list-ordered-item-terminator
1787 Cycle the entire list level through the different itemize/enumerate bullets
1788 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1789 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1790 and its indentation. With a numeric prefix argument N, select the Nth bullet
1791 from this list. If there is an active region when calling this, selected
1792 text will be changed into an item. With a prefix argument, all lines will be
1793 converted to list items. If the first line already was a list item, any item
1794 marker will be removed from the list. Finally, even without an active
1795 region, a normal line will be converted into a list item.
1798 Turn a plain list item into a headline (so that it becomes a subheading at
1799 its location). @xref{Structure editing}, for a detailed explanation.
1802 Turn the whole plain list into a subtree of the current heading. Checkboxes
1803 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1805 @kindex S-@key{left}
1806 @kindex S-@key{right}
1808 @vindex org-support-shift-select
1809 This command also cycles bullet styles when the cursor in on the bullet or
1810 anywhere in an item line, details depending on
1811 @code{org-support-shift-select}.
1813 @cindex sorting, of plain list
1815 Sort the plain list. You will be prompted for the sorting method:
1816 numerically, alphabetically, by time, by checked status for check lists,
1817 or by a custom function.
1823 @cindex visibility cycling, drawers
1825 @cindex org-insert-drawer
1827 Sometimes you want to keep information associated with an entry, but you
1828 normally don't want to see it. For this, Org mode has @emph{drawers}. They
1829 can contain anything but a headline and another drawer. Drawers look like
1833 ** This is a headline
1834 Still outside the drawer
1836 This is inside the drawer.
1841 You can interactively insert drawers at point by calling
1842 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1843 region, this command will put the region inside the drawer. With a prefix
1844 argument, this command calls @code{org-insert-property-drawer} and add a
1845 property drawer right below the current headline. Completion over drawer
1846 keywords is also possible using @key{M-TAB}.
1848 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1849 show the entry, but keep the drawer collapsed to a single line. In order to
1850 look inside the drawer, you need to move the cursor to the drawer line and
1851 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1852 storing properties (@pxref{Properties and columns}), and you can also arrange
1853 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1854 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1855 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1861 Add a time-stamped note to the LOGBOOK drawer.
1864 @vindex org-export-with-drawers
1865 @vindex org-export-with-properties
1866 You can select the name of the drawers which should be exported with
1867 @code{org-export-with-drawers}. In that case, drawer contents will appear in
1868 export output. Property drawers are not affected by this variable: configure
1869 @code{org-export-with-properties} instead.
1874 @vindex org-hide-block-startup
1875 @cindex blocks, folding
1876 Org mode uses begin...end blocks for various purposes from including source
1877 code examples (@pxref{Literal examples}) to capturing time logging
1878 information (@pxref{Clocking work time}). These blocks can be folded and
1879 unfolded by pressing TAB in the begin line. You can also get all blocks
1880 folded at startup by configuring the option @code{org-hide-block-startup}
1881 or on a per-file basis by using
1883 @cindex @code{hideblocks}, STARTUP keyword
1884 @cindex @code{nohideblocks}, STARTUP keyword
1886 #+STARTUP: hideblocks
1887 #+STARTUP: nohideblocks
1894 Org mode supports the creation of footnotes. In contrast to the
1895 @file{footnote.el} package, Org mode's footnotes are designed for work on
1896 a larger document, not only for one-off documents like emails.
1898 A footnote is started by a footnote marker in square brackets in column 0, no
1899 indentation allowed. It ends at the next footnote definition, headline, or
1900 after two consecutive empty lines. The footnote reference is simply the
1901 marker in square brackets, inside text. For example:
1904 The Org homepage[fn:1] now looks a lot better than it used to.
1906 [fn:1] The link is: http://orgmode.org
1909 Org mode extends the number-based syntax to @emph{named} footnotes and
1910 optional inline definition. Using plain numbers as markers (as
1911 @file{footnote.el} does) is supported for backward compatibility, but not
1912 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1913 @LaTeX{}}). Here are the valid references:
1917 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1918 recommended because something like @samp{[1]} could easily be part of a code
1921 A named footnote reference, where @code{name} is a unique label word, or, for
1922 simplicity of automatic creation, a number.
1923 @item [fn:: This is the inline definition of this footnote]
1924 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1926 @item [fn:name: a definition]
1927 An inline definition of a footnote, which also specifies a name for the note.
1928 Since Org allows multiple references to the same note, you can then use
1929 @code{[fn:name]} to create additional references.
1932 @vindex org-footnote-auto-label
1933 Footnote labels can be created automatically, or you can create names yourself.
1934 This is handled by the variable @code{org-footnote-auto-label} and its
1935 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1938 @noindent The following command handles footnotes:
1943 The footnote action command.
1945 When the cursor is on a footnote reference, jump to the definition. When it
1946 is at a definition, jump to the (first) reference.
1948 @vindex org-footnote-define-inline
1949 @vindex org-footnote-section
1950 @vindex org-footnote-auto-adjust
1951 Otherwise, create a new footnote. Depending on the option
1952 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1953 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1954 definition will be placed right into the text as part of the reference, or
1955 separately into the location determined by the option
1956 @code{org-footnote-section}.
1958 When this command is called with a prefix argument, a menu of additional
1961 s @r{Sort the footnote definitions by reference sequence. During editing,}
1962 @r{Org makes no effort to sort footnote definitions into a particular}
1963 @r{sequence. If you want them sorted, use this command, which will}
1964 @r{also move entries according to @code{org-footnote-section}. Automatic}
1965 @r{sorting after each insertion/deletion can be configured using the}
1966 @r{option @code{org-footnote-auto-adjust}.}
1967 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1968 @r{after each insertion/deletion can be configured using the option}
1969 @r{@code{org-footnote-auto-adjust}.}
1970 S @r{Short for first @code{r}, then @code{s} action.}
1971 n @r{Normalize the footnotes by collecting all definitions (including}
1972 @r{inline definitions) into a special section, and then numbering them}
1973 @r{in sequence. The references will then also be numbers. This is}
1974 @r{meant to be the final step before finishing a document (e.g., sending}
1976 d @r{Delete the footnote at point, and all definitions of and references}
1979 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1980 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1981 renumbering and sorting footnotes can be automatic after each insertion or
1986 If the cursor is on a footnote reference, jump to the definition. If it is a
1987 the definition, jump back to the reference. When called at a footnote
1988 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1992 @item C-c C-o @r{or} mouse-1/2
1993 Footnote labels are also links to the corresponding definition/reference, and
1994 you can use the usual commands to follow these links.
1997 @node Orgstruct mode
1998 @section The Orgstruct minor mode
1999 @cindex Orgstruct mode
2000 @cindex minor mode for structure editing
2002 If you like the intuitive way the Org mode structure editing and list
2003 formatting works, you might want to use these commands in other modes like
2004 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2005 this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2006 turn it on by default, for example in Message mode, with one of:
2009 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2010 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2013 When this mode is active and the cursor is on a line that looks to Org like a
2014 headline or the first line of a list item, most structure editing commands
2015 will work, even if the same keys normally have different functionality in the
2016 major mode you are using. If the cursor is not in one of those special
2017 lines, Orgstruct mode lurks silently in the shadows.
2019 When you use @code{orgstruct++-mode}, Org will also export indentation and
2020 autofill settings into that mode, and detect item context after the first
2023 @vindex orgstruct-heading-prefix-regexp
2024 You can also use Org structure editing to fold and unfold headlines in
2025 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2026 the regular expression must match the local prefix to use before Org's
2027 headlines. For example, if you set this variable to @code{";; "} in Emacs
2028 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2029 commented lines. Some commands like @code{org-demote} are disabled when the
2030 prefix is set, but folding/unfolding will work correctly.
2036 A reference document providing a formal description of Org's syntax is
2037 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2038 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2039 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2040 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2041 file falls into one of the categories above.
2043 To explore the abstract structure of an Org buffer, run this in a buffer:
2046 M-: (org-element-parse-buffer) RET
2049 It will output a list containing the buffer's content represented as an
2050 abstract structure. The export engine relies on the information stored in
2051 this list. Most interactive commands (e.g., for structure editing) also
2052 rely on the syntactic meaning of the surrounding context.
2057 @cindex editing tables
2059 Org comes with a fast and intuitive table editor. Spreadsheet-like
2060 calculations are supported using the Emacs @file{calc} package
2061 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2064 * Built-in table editor:: Simple tables
2065 * Column width and alignment:: Overrule the automatic settings
2066 * Column groups:: Grouping to trigger vertical lines
2067 * Orgtbl mode:: The table editor as minor mode
2068 * The spreadsheet:: The table editor has spreadsheet capabilities
2069 * Org-Plot:: Plotting from org tables
2072 @node Built-in table editor
2073 @section The built-in table editor
2074 @cindex table editor, built-in
2076 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2077 the first non-whitespace character is considered part of a table. @samp{|}
2078 is also the column separator@footnote{To insert a vertical bar into a table
2079 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2080 might look like this:
2083 | Name | Phone | Age |
2084 |-------+-------+-----|
2085 | Peter | 1234 | 17 |
2086 | Anna | 4321 | 25 |
2089 A table is re-aligned automatically each time you press @key{TAB} or
2090 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2091 the next field (@key{RET} to the next row) and creates new table rows
2092 at the end of the table or before horizontal lines. The indentation
2093 of the table is set by the first line. Any line starting with
2094 @samp{|-} is considered as a horizontal separator line and will be
2095 expanded on the next re-align to span the whole table width. So, to
2096 create the above table, you would only type
2103 @noindent and then press @key{TAB} to align the table and start filling in
2104 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2105 @kbd{C-c @key{RET}}.
2107 @vindex org-enable-table-editor
2108 @vindex org-table-auto-blank-field
2109 When typing text into a field, Org treats @key{DEL},
2110 @key{Backspace}, and all character keys in a special way, so that
2111 inserting and deleting avoids shifting other fields. Also, when
2112 typing @emph{immediately after the cursor was moved into a new field
2113 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2114 field is automatically made blank. If this behavior is too
2115 unpredictable for you, configure the options
2116 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2119 @tsubheading{Creation and conversion}
2120 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2121 Convert the active region to a table. If every line contains at least one
2122 TAB character, the function assumes that the material is tab separated.
2123 If every line contains a comma, comma-separated values (CSV) are assumed.
2124 If not, lines are split at whitespace into fields. You can use a prefix
2125 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2126 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2127 match the separator, and a numeric argument N indicates that at least N
2128 consecutive spaces, or alternatively a TAB will be the separator.
2130 If there is no active region, this command creates an empty Org
2131 table. But it is easier just to start typing, like
2132 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2134 @tsubheading{Re-aligning and field motion}
2135 @orgcmd{C-c C-c,org-table-align}
2136 Re-align the table and don't move to another field.
2138 @orgcmd{<TAB>,org-table-next-field}
2139 Re-align the table, move to the next field. Creates a new row if
2142 @orgcmd{S-@key{TAB},org-table-previous-field}
2143 Re-align, move to previous field.
2145 @orgcmd{@key{RET},org-table-next-row}
2146 Re-align the table and move down to next row. Creates a new row if
2147 necessary. At the beginning or end of a line, @key{RET} still does
2148 NEWLINE, so it can be used to split a table.
2150 @orgcmd{M-a,org-table-beginning-of-field}
2151 Move to beginning of the current table field, or on to the previous field.
2152 @orgcmd{M-e,org-table-end-of-field}
2153 Move to end of the current table field, or on to the next field.
2155 @tsubheading{Column and row editing}
2156 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2157 Move the current column left/right.
2159 @orgcmd{M-S-@key{left},org-table-delete-column}
2160 Kill the current column.
2162 @orgcmd{M-S-@key{right},org-table-insert-column}
2163 Insert a new column to the left of the cursor position.
2165 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2166 Move the current row up/down.
2168 @orgcmd{M-S-@key{up},org-table-kill-row}
2169 Kill the current row or horizontal line.
2171 @orgcmd{M-S-@key{down},org-table-insert-row}
2172 Insert a new row above the current row. With a prefix argument, the line is
2173 created below the current one.
2175 @orgcmd{C-c -,org-table-insert-hline}
2176 Insert a horizontal line below current row. With a prefix argument, the line
2177 is created above the current line.
2179 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2180 Insert a horizontal line below current row, and move the cursor into the row
2183 @orgcmd{C-c ^,org-table-sort-lines}
2184 Sort the table lines in the region. The position of point indicates the
2185 column to be used for sorting, and the range of lines is the range
2186 between the nearest horizontal separator lines, or the entire table. If
2187 point is before the first column, you will be prompted for the sorting
2188 column. If there is an active region, the mark specifies the first line
2189 and the sorting column, while point should be in the last line to be
2190 included into the sorting. The command prompts for the sorting type
2191 (alphabetically, numerically, or by time). When called with a prefix
2192 argument, alphabetic sorting will be case-sensitive.
2194 @tsubheading{Regions}
2195 @orgcmd{C-c C-x M-w,org-table-copy-region}
2196 Copy a rectangular region from a table to a special clipboard. Point and
2197 mark determine edge fields of the rectangle. If there is no active region,
2198 copy just the current field. The process ignores horizontal separator lines.
2200 @orgcmd{C-c C-x C-w,org-table-cut-region}
2201 Copy a rectangular region from a table to a special clipboard, and
2202 blank all fields in the rectangle. So this is the ``cut'' operation.
2204 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2205 Paste a rectangular region into a table.
2206 The upper left corner ends up in the current field. All involved fields
2207 will be overwritten. If the rectangle does not fit into the present table,
2208 the table is enlarged as needed. The process ignores horizontal separator
2211 @orgcmd{M-@key{RET},org-table-wrap-region}
2212 Split the current field at the cursor position and move the rest to the line
2213 below. If there is an active region, and both point and mark are in the same
2214 column, the text in the column is wrapped to minimum width for the given
2215 number of lines. A numeric prefix argument may be used to change the number
2216 of desired lines. If there is no region, but you specify a prefix argument,
2217 the current field is made blank, and the content is appended to the field
2220 @tsubheading{Calculations}
2221 @cindex formula, in tables
2222 @cindex calculations, in tables
2223 @cindex region, active
2224 @cindex active region
2225 @cindex transient mark mode
2226 @orgcmd{C-c +,org-table-sum}
2227 Sum the numbers in the current column, or in the rectangle defined by
2228 the active region. The result is shown in the echo area and can
2229 be inserted with @kbd{C-y}.
2231 @orgcmd{S-@key{RET},org-table-copy-down}
2232 @vindex org-table-copy-increment
2233 When current field is empty, copy from first non-empty field above. When not
2234 empty, copy current field down to next row and move cursor along with it.
2235 Depending on the option @code{org-table-copy-increment}, integer field
2236 values will be incremented during copy. Integers that are too large will not
2237 be incremented. Also, a @code{0} prefix argument temporarily disables the
2238 increment. This key is also used by shift-selection and related modes
2239 (@pxref{Conflicts}).
2241 @tsubheading{Miscellaneous}
2242 @orgcmd{C-c `,org-table-edit-field}
2243 Edit the current field in a separate window. This is useful for fields that
2244 are not fully visible (@pxref{Column width and alignment}). When called with
2245 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2246 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2247 window follow the cursor through the table and always show the current
2248 field. The follow mode exits automatically when the cursor leaves the table,
2249 or when you repeat this command with @kbd{C-u C-u C-c `}.
2251 @item M-x org-table-import RET
2252 Import a file as a table. The table should be TAB or whitespace
2253 separated. Use, for example, to import a spreadsheet table or data
2254 from a database, because these programs generally can write
2255 TAB-separated text files. This command works by inserting the file into
2256 the buffer and then converting the region to a table. Any prefix
2257 argument is passed on to the converter, which uses it to determine the
2259 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2260 Tables can also be imported by pasting tabular text into the Org
2261 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2262 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2264 @item M-x org-table-export RET
2265 @findex org-table-export
2266 @vindex org-table-export-default-format
2267 Export the table, by default as a TAB-separated file. Use for data
2268 exchange with, for example, spreadsheet or database programs. The format
2269 used to export the file can be configured in the option
2270 @code{org-table-export-default-format}. You may also use properties
2271 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2272 name and the format for table export in a subtree. Org supports quite
2273 general formats for exported tables. The exporter format is the same as the
2274 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2275 detailed description.
2278 If you don't like the automatic table editor because it gets in your
2279 way on lines which you would like to start with @samp{|}, you can turn
2283 (setq org-enable-table-editor nil)
2286 @noindent Then the only table command that still works is
2287 @kbd{C-c C-c} to do a manual re-align.
2289 @node Column width and alignment
2290 @section Column width and alignment
2291 @cindex narrow columns in tables
2292 @cindex alignment in tables
2294 The width of columns is automatically determined by the table editor. And
2295 also the alignment of a column is determined automatically from the fraction
2296 of number-like versus non-number fields in the column.
2298 Sometimes a single field or a few fields need to carry more text, leading to
2299 inconveniently wide columns. Or maybe you want to make a table with several
2300 columns having a fixed width, regardless of content. To set@footnote{This
2301 feature does not work on XEmacs.} the width of a column, one field anywhere
2302 in the column may contain just the string @samp{<N>} where @samp{N} is an
2303 integer specifying the width of the column in characters. The next re-align
2304 will then set the width of this column to this value.
2308 |---+------------------------------| |---+--------|
2310 | 1 | one | | 1 | one |
2311 | 2 | two | ----\ | 2 | two |
2312 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2313 | 4 | four | | 4 | four |
2314 |---+------------------------------| |---+--------|
2319 Fields that are wider become clipped and end in the string @samp{=>}.
2320 Note that the full text is still in the buffer but is hidden.
2321 To see the full text, hold the mouse over the field---a tool-tip window
2322 will show the full content. To edit such a field, use the command
2323 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2324 open a new window with the full field. Edit it and finish with @kbd{C-c
2327 @vindex org-startup-align-all-tables
2328 When visiting a file containing a table with narrowed columns, the
2329 necessary character hiding has not yet happened, and the table needs to
2330 be aligned before it looks nice. Setting the option
2331 @code{org-startup-align-all-tables} will realign all tables in a file
2332 upon visiting, but also slow down startup. You can also set this option
2333 on a per-file basis with:
2340 If you would like to overrule the automatic alignment of number-rich columns
2341 to the right and of string-rich column to the left, you can use @samp{<r>},
2342 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2343 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2344 also combine alignment and field width like this: @samp{<r10>}.
2346 Lines which only contain these formatting cookies will be removed
2347 automatically when exporting the document.
2350 @section Column groups
2351 @cindex grouping columns in tables
2353 When Org exports tables, it does so by default without vertical
2354 lines because that is visually more satisfying in general. Occasionally
2355 however, vertical lines can be useful to structure a table into groups
2356 of columns, much like horizontal lines can do for groups of rows. In
2357 order to specify column groups, you can use a special row where the
2358 first field contains only @samp{/}. The further fields can either
2359 contain @samp{<} to indicate that this column should start a group,
2360 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2361 and @samp{>}) to make a column
2362 a group of its own. Boundaries between column groups will upon export be
2363 marked with vertical lines. Here is an example:
2366 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2367 |---+-----+-----+-----+---------+------------|
2368 | / | < | | > | < | > |
2369 | 1 | 1 | 1 | 1 | 1 | 1 |
2370 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2371 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2372 |---+-----+-----+-----+---------+------------|
2373 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2376 It is also sufficient to just insert the column group starters after
2377 every vertical line you would like to have:
2380 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2381 |----+-----+-----+-----+---------+------------|
2386 @section The Orgtbl minor mode
2388 @cindex minor mode for tables
2390 If you like the intuitive way the Org table editor works, you
2391 might also want to use it in other modes like Text mode or Mail mode.
2392 The minor mode Orgtbl mode makes this possible. You can always toggle
2393 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2394 example in Message mode, use
2397 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2400 Furthermore, with some special setup, it is possible to maintain tables
2401 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2402 construct @LaTeX{} tables with the underlying ease and power of
2403 Orgtbl mode, including spreadsheet capabilities. For details, see
2404 @ref{Tables in arbitrary syntax}.
2406 @node The spreadsheet
2407 @section The spreadsheet
2408 @cindex calculations, in tables
2409 @cindex spreadsheet capabilities
2410 @cindex @file{calc} package
2412 The table editor makes use of the Emacs @file{calc} package to implement
2413 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2414 derive fields from other fields. While fully featured, Org's implementation
2415 is not identical to other spreadsheets. For example, Org knows the concept
2416 of a @emph{column formula} that will be applied to all non-header fields in a
2417 column without having to copy the formula to each relevant field. There is
2418 also a formula debugger, and a formula editor with features for highlighting
2419 fields in the table corresponding to the references at the point in the
2420 formula, moving these references by arrow keys
2423 * References:: How to refer to another field or range
2424 * Formula syntax for Calc:: Using Calc to compute stuff
2425 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2426 * Durations and time values:: How to compute durations and time values
2427 * Field and range formulas:: Formula for specific (ranges of) fields
2428 * Column formulas:: Formulas valid for an entire column
2429 * Lookup functions:: Lookup functions for searching tables
2430 * Editing and debugging formulas:: Fixing formulas
2431 * Updating the table:: Recomputing all dependent fields
2432 * Advanced features:: Field and column names, parameters and automatic recalc
2436 @subsection References
2439 To compute fields in the table from other fields, formulas must
2440 reference other fields or ranges. In Org, fields can be referenced
2441 by name, by absolute coordinates, and by relative coordinates. To find
2442 out what the coordinates of a field are, press @kbd{C-c ?} in that
2443 field, or press @kbd{C-c @}} to toggle the display of a grid.
2445 @subsubheading Field references
2446 @cindex field references
2447 @cindex references, to fields
2449 Formulas can reference the value of another field in two ways. Like in
2450 any other spreadsheet, you may reference fields with a letter/number
2451 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2452 @vindex org-table-use-standard-references
2453 However, Org prefers@footnote{Org will understand references typed by the
2454 user as @samp{B4}, but it will not use this syntax when offering a formula
2455 for editing. You can customize this behavior using the option
2456 @code{org-table-use-standard-references}.} to use another, more general
2457 representation that looks like this:
2459 @@@var{row}$@var{column}
2462 Column specifications can be absolute like @code{$1},
2463 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2464 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2465 @code{$<} and @code{$>} are immutable references to the first and last
2466 column, respectively, and you can use @code{$>>>} to indicate the third
2467 column from the right.
2469 The row specification only counts data lines and ignores horizontal separator
2470 lines (hlines). Like with columns, you can use absolute row numbers
2471 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2472 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2473 immutable references the first and last@footnote{For backward compatibility
2474 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2475 a stable way to the 5th and 12th field in the last row of the table.
2476 However, this syntax is deprecated, it should not be used for new documents.
2477 Use @code{@@>$} instead.} row in the table, respectively. You may also
2478 specify the row relative to one of the hlines: @code{@@I} refers to the first
2479 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2480 line above the current line, @code{@@+I} to the first such line below the
2481 current line. You can also write @code{@@III+2} which is the second data line
2482 after the third hline in the table.
2484 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2485 i.e., to the row/column for the field being computed. Also, if you omit
2486 either the column or the row part of the reference, the current row/column is
2489 Org's references with @emph{unsigned} numbers are fixed references
2490 in the sense that if you use the same reference in the formula for two
2491 different fields, the same field will be referenced each time.
2492 Org's references with @emph{signed} numbers are floating
2493 references because the same reference operator can reference different
2494 fields depending on the field being calculated by the formula.
2496 Here are a few examples:
2499 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2500 $5 @r{column 5 in the current row (same as @code{E&})}
2501 @@2 @r{current column, row 2}
2502 @@-1$-3 @r{the field one row up, three columns to the left}
2503 @@-I$2 @r{field just under hline above current row, column 2}
2504 @@>$5 @r{field in the last row, in column 5}
2507 @subsubheading Range references
2508 @cindex range references
2509 @cindex references, to ranges
2511 You may reference a rectangular range of fields by specifying two field
2512 references connected by two dots @samp{..}. If both fields are in the
2513 current row, you may simply use @samp{$2..$7}, but if at least one field
2514 is in a different row, you need to use the general @code{@@row$column}
2515 format at least for the first field (i.e the reference must start with
2516 @samp{@@} in order to be interpreted correctly). Examples:
2519 $1..$3 @r{first three fields in the current row}
2520 $P..$Q @r{range, using column names (see under Advanced)}
2521 $<<<..$>> @r{start in third column, continue to the last but one}
2522 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2523 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2524 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2527 @noindent Range references return a vector of values that can be fed
2528 into Calc vector functions. Empty fields in ranges are normally suppressed,
2529 so that the vector contains only the non-empty fields. For other options
2530 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2533 @subsubheading Field coordinates in formulas
2534 @cindex field coordinates
2535 @cindex coordinates, of field
2536 @cindex row, of field coordinates
2537 @cindex column, of field coordinates
2539 One of the very first actions during evaluation of Calc formulas and Lisp
2540 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2541 row or column number of the field where the current result will go to. The
2542 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2543 @code{org-table-current-column}. Examples:
2546 @item if(@@# % 2, $#, string(""))
2547 Insert column number on odd rows, set field to empty on even rows.
2548 @item $2 = '(identity remote(FOO, @@@@#$1))
2549 Copy text or values of each row of column 1 of the table named @code{FOO}
2550 into column 2 of the current table.
2551 @item @@3 = 2 * remote(FOO, @@1$$#)
2552 Insert the doubled value of each column of row 1 of the table named
2553 @code{FOO} into row 3 of the current table.
2556 @noindent For the second/third example, the table named @code{FOO} must have
2557 at least as many rows/columns as the current table. Note that this is
2558 inefficient@footnote{The computation time scales as O(N^2) because the table
2559 named @code{FOO} is parsed for each field to be read.} for large number of
2562 @subsubheading Named references
2563 @cindex named references
2564 @cindex references, named
2565 @cindex name, of column or field
2566 @cindex constants, in calculations
2569 @vindex org-table-formula-constants
2570 @samp{$name} is interpreted as the name of a column, parameter or
2571 constant. Constants are defined globally through the option
2572 @code{org-table-formula-constants}, and locally (for the file) through a
2576 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2580 @vindex constants-unit-system
2581 @pindex constants.el
2582 Also properties (@pxref{Properties and columns}) can be used as
2583 constants in table formulas: for a property @samp{:Xyz:} use the name
2584 @samp{$PROP_Xyz}, and the property will be searched in the current
2585 outline entry and in the hierarchy above it. If you have the
2586 @file{constants.el} package, it will also be used to resolve constants,
2587 including natural constants like @samp{$h} for Planck's constant, and
2588 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2589 supply the values of constants in two different unit systems, @code{SI}
2590 and @code{cgs}. Which one is used depends on the value of the variable
2591 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2592 @code{constSI} and @code{constcgs} to set this value for the current
2593 buffer.}. Column names and parameters can be specified in special table
2594 lines. These are described below, see @ref{Advanced features}. All
2595 names must start with a letter, and further consist of letters and
2598 @subsubheading Remote references
2599 @cindex remote references
2600 @cindex references, remote
2601 @cindex references, to a different table
2602 @cindex name, of column or field
2603 @cindex constants, in calculations
2604 @cindex #+NAME, for table
2606 You may also reference constants, fields and ranges from a different table,
2607 either in the current file or even in a different file. The syntax is
2610 remote(NAME-OR-ID,REF)
2614 where NAME can be the name of a table in the current file as set by a
2615 @code{#+NAME: Name} line before the table. It can also be the ID of an
2616 entry, even in a different file, and the reference then refers to the first
2617 table in that entry. REF is an absolute field or range reference as
2618 described above for example @code{@@3$3} or @code{$somename}, valid in the
2621 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2622 it will be substituted with the name or ID found in this field of the current
2623 table. For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2624 @@>$1)}. The format @code{B3} is not supported because it can not be
2625 distinguished from a plain table name or ID.
2627 @node Formula syntax for Calc
2628 @subsection Formula syntax for Calc
2629 @cindex formula syntax, Calc
2630 @cindex syntax, of formulas
2632 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2633 package. Note that @file{calc} has the non-standard convention that @samp{/}
2634 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2635 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2636 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2637 GNU Emacs Calc Manual}), variable substitution takes place according to the
2638 rules described above.
2639 @cindex vectors, in table calculations
2640 The range vectors can be directly fed into the Calc vector functions
2641 like @samp{vmean} and @samp{vsum}.
2643 @cindex format specifier
2644 @cindex mode, for @file{calc}
2645 @vindex org-calc-default-modes
2646 A formula can contain an optional mode string after a semicolon. This
2647 string consists of flags to influence Calc and other modes during
2648 execution. By default, Org uses the standard Calc modes (precision
2649 12, angular units degrees, fraction and symbolic modes off). The display
2650 format, however, has been changed to @code{(float 8)} to keep tables
2651 compact. The default settings can be configured using the option
2652 @code{org-calc-default-modes}.
2654 @noindent List of modes:
2658 Set the internal Calc calculation precision to 20 digits.
2659 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2660 Normal, scientific, engineering or fixed format of the result of Calc passed
2661 back to Org. Calc formatting is unlimited in precision as long as the Calc
2662 calculation precision is greater.
2663 @item @code{D}, @code{R}
2664 Degree and radian angle modes of Calc.
2665 @item @code{F}, @code{S}
2666 Fraction and symbolic modes of Calc.
2667 @item @code{T}, @code{t}
2668 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2670 If and how to consider empty fields. Without @samp{E} empty fields in range
2671 references are suppressed so that the Calc vector or Lisp list contains only
2672 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2673 fields in ranges or empty field references the value @samp{nan} (not a
2674 number) is used in Calc formulas and the empty string is used for Lisp
2675 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2676 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2678 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2679 to see how this is essential for computations with Lisp formulas. In Calc
2680 formulas it is used only occasionally because there number strings are
2681 already interpreted as numbers without @samp{N}.
2683 Literal, for Lisp formulas only. See the next section.
2687 Unless you use large integer numbers or high-precision-calculation and
2688 -display for floating point numbers you may alternatively provide a
2689 @samp{printf} format specifier to reformat the Calc result after it has been
2690 passed back to Org instead of letting Calc already do the
2691 formatting@footnote{The @samp{printf} reformatting is limited in precision
2692 because the value passed to it is converted into an @samp{integer} or
2693 @samp{double}. The @samp{integer} is limited in size by truncating the
2694 signed value to 32 bits. The @samp{double} is limited in precision to 64
2695 bits overall which leaves approximately 16 significant decimal digits.}. A
2699 $1+$2 @r{Sum of first and second field}
2700 $1+$2;%.2f @r{Same, format result to two decimals}
2701 exp($2)+exp($1) @r{Math functions can be used}
2702 $0;%.1f @r{Reformat current cell to 1 decimal}
2703 ($3-32)*5/9 @r{Degrees F -> C conversion}
2704 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2705 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2706 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2707 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2710 Calc also contains a complete set of logical operations, (@pxref{Logical
2711 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2714 @item if($1 < 20, teen, string(""))
2715 "teen" if age $1 is less than 20, else the Org table result field is set to
2716 empty with the empty string.
2717 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E
2718 Sum of the first two columns. When at least one of the input fields is empty
2719 the Org table result field is set to empty.
2720 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2721 Mean value of a range unless there is any empty field. Every field in the
2722 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2723 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2724 @samp{vmean} and the Org table result field is set to empty. Use this when
2725 the sample set is expected to never have missing values.
2726 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2727 Mean value of a range with empty fields skipped. Every field in the range
2728 that is empty is skipped. When all fields in the range are empty the mean
2729 value is not defined and the Org table result field is set to empty. Use
2730 this when the sample set can have a variable size.
2731 @item vmean($1..$7); EN
2732 To complete the example before: Mean value of a range with empty fields
2733 counting as samples with value 0. Use this only when incomplete sample sets
2734 should be padded with 0 to the full size.
2737 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2738 and use them in formula syntax for Calc.
2740 @node Formula syntax for Lisp
2741 @subsection Emacs Lisp forms as formulas
2742 @cindex Lisp forms, as table formulas
2744 It is also possible to write a formula in Emacs Lisp. This can be useful
2745 for string manipulation and control structures, if Calc's functionality is
2748 If a formula starts with a single-quote followed by an opening parenthesis,
2749 then it is evaluated as a Lisp form. The evaluation should return either a
2750 string or a number. Just as with @file{calc} formulas, you can specify modes
2751 and a printf format after a semicolon.
2753 With Emacs Lisp forms, you need to be conscious about the way field
2754 references are interpolated into the form. By default, a reference will be
2755 interpolated as a Lisp string (in double-quotes) containing the field. If
2756 you provide the @samp{N} mode switch, all referenced elements will be numbers
2757 (non-number fields will be zero) and interpolated as Lisp numbers, without
2758 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2759 literally, without quotes. I.e., if you want a reference to be interpreted
2760 as a string by the Lisp form, enclose the reference operator itself in
2761 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2762 fields, so you can embed them in list or vector syntax.
2764 Here are a few examples---note how the @samp{N} mode is used when we do
2765 computations in Lisp:
2768 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2769 Swap the first two characters of the content of column 1.
2771 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2772 @item '(apply '+ '($1..$4));N
2773 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2776 @node Durations and time values
2777 @subsection Durations and time values
2778 @cindex Duration, computing
2779 @cindex Time, computing
2780 @vindex org-table-duration-custom-format
2782 If you want to compute time values use the @code{T} flag, either in Calc
2783 formulas or Elisp formulas:
2787 | Task 1 | Task 2 | Total |
2788 |---------+----------+----------|
2789 | 2:12 | 1:47 | 03:59:00 |
2790 | 3:02:20 | -2:07:00 | 0.92 |
2791 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2795 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2796 are optional. With the @code{T} flag, computed durations will be displayed
2797 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2798 computed durations will be displayed according to the value of the option
2799 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2800 will display the result as a fraction of hours (see the second formula in the
2803 Negative duration values can be manipulated as well, and integers will be
2804 considered as seconds in addition and subtraction.
2806 @node Field and range formulas
2807 @subsection Field and range formulas
2808 @cindex field formula
2809 @cindex range formula
2810 @cindex formula, for individual table field
2811 @cindex formula, for range of fields
2813 To assign a formula to a particular field, type it directly into the field,
2814 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2815 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2816 the formula will be stored as the formula for this field, evaluated, and the
2817 current field will be replaced with the result.
2820 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2821 below the table. If you type the equation in the 4th field of the 3rd data
2822 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2823 inserting/deleting/swapping columns and rows with the appropriate commands,
2824 @i{absolute references} (but not relative ones) in stored formulas are
2825 modified in order to still reference the same field. To avoid this, in
2826 particular in range references, anchor ranges at the table borders (using
2827 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2828 @code{@@I} notation. Automatic adaptation of field references does of course
2829 not happen if you edit the table structure with normal editing
2830 commands---then you must fix the equations yourself.
2832 Instead of typing an equation into the field, you may also use the following
2836 @orgcmd{C-u C-c =,org-table-eval-formula}
2837 Install a new formula for the current field. The command prompts for a
2838 formula with default taken from the @samp{#+TBLFM:} line, applies
2839 it to the current field, and stores it.
2842 The left-hand side of a formula can also be a special expression in order to
2843 assign the formula to a number of different fields. There is no keyboard
2844 shortcut to enter such range formulas. To add them, use the formula editor
2845 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2850 Column formula, valid for the entire column. This is so common that Org
2851 treats these formulas in a special way, see @ref{Column formulas}.
2853 Row formula, applies to all fields in the specified row. @code{@@>=} means
2856 Range formula, applies to all fields in the given rectangular range. This
2857 can also be used to assign a formula to some but not all fields in a row.
2859 Named field, see @ref{Advanced features}.
2862 @node Column formulas
2863 @subsection Column formulas
2864 @cindex column formula
2865 @cindex formula, for table column
2867 When you assign a formula to a simple column reference like @code{$3=}, the
2868 same formula will be used in all fields of that column, with the following
2869 very convenient exceptions: (i) If the table contains horizontal separator
2870 hlines with rows above and below, everything before the first such hline is
2871 considered part of the table @emph{header} and will not be modified by column
2872 formulas. Therefore a header is mandatory when you use column formulas and
2873 want to add hlines to group rows, like for example to separate a total row at
2874 the bottom from the summand rows above. (ii) Fields that already get a value
2875 from a field/range formula will be left alone by column formulas. These
2876 conditions make column formulas very easy to use.
2878 To assign a formula to a column, type it directly into any field in the
2879 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2880 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2881 the formula will be stored as the formula for the current column, evaluated
2882 and the current field replaced with the result. If the field contains only
2883 @samp{=}, the previously stored formula for this column is used. For each
2884 column, Org will only remember the most recently used formula. In the
2885 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2886 left-hand side of a column formula cannot be the name of column, it must be
2887 the numeric column reference or @code{$>}.
2889 Instead of typing an equation into the field, you may also use the
2893 @orgcmd{C-c =,org-table-eval-formula}
2894 Install a new formula for the current column and replace current field with
2895 the result of the formula. The command prompts for a formula, with default
2896 taken from the @samp{#+TBLFM} line, applies it to the current field and
2897 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2898 will apply it to that many consecutive fields in the current column.
2901 @node Lookup functions
2902 @subsection Lookup functions
2903 @cindex lookup functions in tables
2904 @cindex table lookup functions
2906 Org has three predefined Emacs Lisp functions for lookups in tables.
2908 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2909 @findex org-lookup-first
2910 Searches for the first element @code{S} in list @code{S-LIST} for which
2914 is @code{t}; returns the value from the corresponding position in list
2915 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2916 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2917 order as the corresponding parameters are in the call to
2918 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2919 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2921 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2922 @findex org-lookup-last
2923 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2924 element for which @code{PREDICATE} is @code{t}.
2925 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2926 @findex org-lookup-all
2927 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2928 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2929 values. This function can not be used by itself in a formula, because it
2930 returns a list of values. However, powerful lookups can be built when this
2931 function is combined with other Emacs Lisp functions.
2934 If the ranges used in these functions contain empty fields, the @code{E} mode
2935 for the formula should usually be specified: otherwise empty fields will not be
2936 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2937 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2938 element of @code{R-LIST}.
2940 These three functions can be used to implement associative arrays, count
2941 matching cells, rank results, group data etc. For practical examples
2942 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2945 @node Editing and debugging formulas
2946 @subsection Editing and debugging formulas
2947 @cindex formula editing
2948 @cindex editing, of table formulas
2950 @vindex org-table-use-standard-references
2951 You can edit individual formulas in the minibuffer or directly in the field.
2952 Org can also prepare a special buffer with all active formulas of a table.
2953 When offering a formula for editing, Org converts references to the standard
2954 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2955 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2956 option @code{org-table-use-standard-references}.
2959 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2960 Edit the formula associated with the current column/field in the
2961 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2962 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2963 Re-insert the active formula (either a
2964 field formula, or a column formula) into the current field, so that you
2965 can edit it directly in the field. The advantage over editing in the
2966 minibuffer is that you can use the command @kbd{C-c ?}.
2967 @orgcmd{C-c ?,org-table-field-info}
2968 While editing a formula in a table field, highlight the field(s)
2969 referenced by the reference at the cursor position in the formula.
2971 @findex org-table-toggle-coordinate-overlays
2973 Toggle the display of row and column numbers for a table, using overlays
2974 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2975 time the table is aligned; you can force it with @kbd{C-c C-c}.
2977 @findex org-table-toggle-formula-debugger
2979 Toggle the formula debugger on and off
2980 (@command{org-table-toggle-formula-debugger}). See below.
2981 @orgcmd{C-c ',org-table-edit-formulas}
2982 Edit all formulas for the current table in a special buffer, where the
2983 formulas will be displayed one per line. If the current field has an
2984 active formula, the cursor in the formula editor will mark it.
2985 While inside the special buffer, Org will automatically highlight
2986 any field or range reference at the cursor position. You may edit,
2987 remove and add formulas, and use the following commands:
2990 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2991 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2992 prefix, also apply the new formulas to the entire table.
2993 @orgcmd{C-c C-q,org-table-fedit-abort}
2994 Exit the formula editor without installing changes.
2995 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2996 Toggle all references in the formula editor between standard (like
2997 @code{B3}) and internal (like @code{@@3$2}).
2998 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2999 Pretty-print or indent Lisp formula at point. When in a line containing
3000 a Lisp formula, format the formula according to Emacs Lisp rules.
3001 Another @key{TAB} collapses the formula back again. In the open
3002 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3003 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3004 Complete Lisp symbols, just like in Emacs Lisp mode.
3006 @kindex S-@key{down}
3007 @kindex S-@key{left}
3008 @kindex S-@key{right}
3009 @findex org-table-fedit-ref-up
3010 @findex org-table-fedit-ref-down
3011 @findex org-table-fedit-ref-left
3012 @findex org-table-fedit-ref-right
3013 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3014 Shift the reference at point. For example, if the reference is
3015 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3016 This also works for relative references and for hline references.
3017 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3018 Move the test line for column formulas in the Org buffer up and
3020 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3021 Scroll the window displaying the table.
3023 @findex org-table-toggle-coordinate-overlays
3025 Turn the coordinate grid in the table on and off.
3029 Making a table field blank does not remove the formula associated with
3030 the field, because that is stored in a different line (the @samp{#+TBLFM}
3031 line)---during the next recalculation the field will be filled again.
3032 To remove a formula from a field, you have to give an empty reply when
3033 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3036 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3037 equations with @kbd{C-c C-c} in that line or with the normal
3038 recalculation commands in the table.
3040 @anchor{Using multiple #+TBLFM lines}
3041 @subsubheading Using multiple #+TBLFM lines
3042 @cindex #+TBLFM line, multiple
3044 @cindex #+TBLFM, switching
3047 You may apply the formula temporarily. This is useful when you
3048 switch the formula. Place multiple @samp{#+TBLFM} lines right
3049 after the table, and then press @kbd{C-c C-c} on the formula to
3050 apply. Here is an example:
3062 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3074 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3075 will get the following result of applying only the first @samp{#+TBLFM} line.
3086 @subsubheading Debugging formulas
3087 @cindex formula debugging
3088 @cindex debugging, of table formulas
3089 When the evaluation of a formula leads to an error, the field content
3090 becomes the string @samp{#ERROR}. If you would like see what is going
3091 on during variable substitution and calculation in order to find a bug,
3092 turn on formula debugging in the @code{Tbl} menu and repeat the
3093 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3094 field. Detailed information will be displayed.
3096 @node Updating the table
3097 @subsection Updating the table
3098 @cindex recomputing table fields
3099 @cindex updating, table
3101 Recalculation of a table is normally not automatic, but needs to be
3102 triggered by a command. See @ref{Advanced features}, for a way to make
3103 recalculation at least semi-automatic.
3105 In order to recalculate a line of a table or the entire table, use the
3109 @orgcmd{C-c *,org-table-recalculate}
3110 Recalculate the current row by first applying the stored column formulas
3111 from left to right, and all field/range formulas in the current row.
3117 Recompute the entire table, line by line. Any lines before the first
3118 hline are left alone, assuming that these are part of the table header.
3120 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3121 Iterate the table by recomputing it until no further changes occur.
3122 This may be necessary if some computed fields use the value of other
3123 fields that are computed @i{later} in the calculation sequence.
3124 @item M-x org-table-recalculate-buffer-tables RET
3125 @findex org-table-recalculate-buffer-tables
3126 Recompute all tables in the current buffer.
3127 @item M-x org-table-iterate-buffer-tables RET
3128 @findex org-table-iterate-buffer-tables
3129 Iterate all tables in the current buffer, in order to converge table-to-table
3133 @node Advanced features
3134 @subsection Advanced features
3136 If you want the recalculation of fields to happen automatically, or if you
3137 want to be able to assign @i{names}@footnote{Such names must start by an
3138 alphabetic character and use only alphanumeric/underscore characters.} to
3139 fields and columns, you need to reserve the first column of the table for
3140 special marking characters.
3143 @orgcmd{C-#,org-table-rotate-recalc-marks}
3144 Rotate the calculation mark in first column through the states @samp{ },
3145 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3146 change all marks in the region.
3149 Here is an example of a table that collects exam results of students and
3150 makes use of these features:
3154 |---+---------+--------+--------+--------+-------+------|
3155 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3156 |---+---------+--------+--------+--------+-------+------|
3157 | ! | | P1 | P2 | P3 | Tot | |
3158 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3159 | ^ | | m1 | m2 | m3 | mt | |
3160 |---+---------+--------+--------+--------+-------+------|
3161 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3162 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3163 |---+---------+--------+--------+--------+-------+------|
3164 | | Average | | | | 25.0 | |
3165 | ^ | | | | | at | |
3166 | $ | max=50 | | | | | |
3167 |---+---------+--------+--------+--------+-------+------|
3168 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3172 @noindent @b{Important}: please note that for these special tables,
3173 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3174 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3175 to the field itself. The column formulas are not applied in rows with
3178 @cindex marking characters, tables
3179 The marking characters have the following meaning:
3183 The fields in this line define names for the columns, so that you may
3184 refer to a column as @samp{$Tot} instead of @samp{$6}.
3186 This row defines names for the fields @emph{above} the row. With such
3187 a definition, any formula in the table may use @samp{$m1} to refer to
3188 the value @samp{10}. Also, if you assign a formula to a names field, it
3189 will be stored as @samp{$name=...}.
3191 Similar to @samp{^}, but defines names for the fields in the row
3194 Fields in this row can define @emph{parameters} for formulas. For
3195 example, if a field in a @samp{$} row contains @samp{max=50}, then
3196 formulas in this table can refer to the value 50 using @samp{$max}.
3197 Parameters work exactly like constants, only that they can be defined on
3200 Fields in this row are automatically recalculated when pressing
3201 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3202 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3203 lines will be left alone by this command.
3205 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3206 not for automatic recalculation. Use this when automatic
3207 recalculation slows down editing too much.
3209 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3210 All lines that should be recalculated should be marked with @samp{#}
3213 Do not export this line. Useful for lines that contain the narrowing
3214 @samp{<N>} markers or column group markers.
3217 Finally, just to whet your appetite for what can be done with the
3218 fantastic @file{calc.el} package, here is a table that computes the Taylor
3219 series of degree @code{n} at location @code{x} for a couple of
3224 |---+-------------+---+-----+--------------------------------------|
3225 | | Func | n | x | Result |
3226 |---+-------------+---+-----+--------------------------------------|
3227 | # | exp(x) | 1 | x | 1 + x |
3228 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3229 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3230 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3231 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3232 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3233 |---+-------------+---+-----+--------------------------------------|
3234 #+TBLFM: $5=taylor($2,$4,$3);n3
3240 @cindex graph, in tables
3241 @cindex plot tables using Gnuplot
3244 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3245 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3246 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3247 that you have both Gnuplot and Gnuplot mode installed on your system, then
3248 call @code{org-plot/gnuplot} on the following table.
3252 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3253 | Sede | Max cites | H-index |
3254 |-----------+-----------+---------|
3255 | Chile | 257.72 | 21.39 |
3256 | Leeds | 165.77 | 19.68 |
3257 | Sao Paolo | 71.00 | 11.50 |
3258 | Stockholm | 134.19 | 14.33 |
3259 | Morelia | 257.56 | 17.67 |
3263 Notice that Org Plot is smart enough to apply the table's headers as labels.
3264 Further control over the labels, type, content, and appearance of plots can
3265 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3266 for a complete list of Org-plot options. For more information and examples
3267 see the Org-plot tutorial at
3268 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3270 @subsubheading Plot Options
3274 Specify any @command{gnuplot} option to be set when graphing.
3277 Specify the title of the plot.
3280 Specify which column of the table to use as the @code{x} axis.
3283 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3284 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3285 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3289 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3292 Specify a @code{with} option to be inserted for every col being plotted
3293 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3294 Defaults to @code{lines}.
3297 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3300 List of labels to be used for the @code{deps} (defaults to the column headers
3304 Specify an entire line to be inserted in the Gnuplot script.
3307 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3308 flat mapping rather than a @code{3d} slope.
3311 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3312 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3315 If you want total control, you can specify a script file (place the file name
3316 between double-quotes) which will be used to plot. Before plotting, every
3317 instance of @code{$datafile} in the specified script will be replaced with
3318 the path to the generated data file. Note: even if you set this option, you
3319 may still want to specify the plot type, as that can impact the content of
3327 Like HTML, Org provides links inside a file, external links to
3328 other files, Usenet articles, emails, and much more.
3331 * Link format:: How links in Org are formatted
3332 * Internal links:: Links to other places in the current file
3333 * External links:: URL-like links to the world
3334 * Handling links:: Creating, inserting and following
3335 * Using links outside Org:: Linking from my C source code?
3336 * Link abbreviations:: Shortcuts for writing complex links
3337 * Search options:: Linking to a specific location
3338 * Custom searches:: When the default search is not enough
3342 @section Link format
3344 @cindex format, of links
3346 Org will recognize plain URL-like links and activate them as
3347 clickable links. The general link format, however, looks like this:
3350 [[link][description]] @r{or alternatively} [[link]]
3354 Once a link in the buffer is complete (all brackets present), Org
3355 will change the display so that @samp{description} is displayed instead
3356 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3357 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3358 which by default is an underlined face. You can directly edit the
3359 visible part of a link. Note that this can be either the @samp{link}
3360 part (if there is no description) or the @samp{description} part. To
3361 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3364 If you place the cursor at the beginning or just behind the end of the
3365 displayed text and press @key{BACKSPACE}, you will remove the
3366 (invisible) bracket at that location. This makes the link incomplete
3367 and the internals are again displayed as plain text. Inserting the
3368 missing bracket hides the link internals again. To show the
3369 internal structure of all links, use the menu entry
3370 @code{Org->Hyperlinks->Literal links}.
3372 @node Internal links
3373 @section Internal links
3374 @cindex internal links
3375 @cindex links, internal
3376 @cindex targets, for links
3378 @cindex property, CUSTOM_ID
3379 If the link does not look like a URL, it is considered to be internal in the
3380 current file. The most important case is a link like
3381 @samp{[[#my-custom-id]]} which will link to the entry with the
3382 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3383 to make sure these custom IDs are unique in a file.
3385 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3386 lead to a text search in the current file.
3388 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3389 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3390 point to the corresponding headline. The preferred match for a text link is
3391 a @i{dedicated target}: the same string in double angular brackets, like
3392 @samp{<<My Target>>}.
3395 If no dedicated target exists, the link will then try to match the exact name
3396 of an element within the buffer. Naming is done with the @code{#+NAME}
3397 keyword, which has to be put in the line before the element it refers to, as
3398 in the following example
3407 If none of the above succeeds, Org will search for a headline that is exactly
3408 the link text but may also include a TODO keyword and tags@footnote{To insert
3409 a link targeting a headline, in-buffer completion can be used. Just type
3410 a star followed by a few optional letters into the buffer and press
3411 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3414 During export, internal links will be used to mark objects and assign them
3415 a number. Marked objects will then be referenced by links pointing to them.
3416 In particular, links without a description will appear as the number assigned
3417 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3418 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3419 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3423 - <<target>>another item
3424 Here we refer to item [[target]].
3428 The last sentence will appear as @samp{Here we refer to item 2} when
3431 In non-Org files, the search will look for the words in the link text. In
3432 the above example the search would be for @samp{my target}.
3434 Following a link pushes a mark onto Org's own mark ring. You can
3435 return to the previous position with @kbd{C-c &}. Using this command
3436 several times in direct succession goes back to positions recorded
3440 * Radio targets:: Make targets trigger links in plain text
3444 @subsection Radio targets
3445 @cindex radio targets
3446 @cindex targets, radio
3447 @cindex links, radio targets
3449 Org can automatically turn any occurrences of certain target names
3450 in normal text into a link. So without explicitly creating a link, the
3451 text connects to the target radioing its position. Radio targets are
3452 enclosed by triple angular brackets. For example, a target @samp{<<<My
3453 Target>>>} causes each occurrence of @samp{my target} in normal text to
3454 become activated as a link. The Org file is scanned automatically
3455 for radio targets only when the file is first loaded into Emacs. To
3456 update the target list during editing, press @kbd{C-c C-c} with the
3457 cursor on or at a target.
3459 @node External links
3460 @section External links
3461 @cindex links, external
3462 @cindex external links
3470 @cindex USENET links
3475 Org supports links to files, websites, Usenet and email messages, BBDB
3476 database entries and links to both IRC conversations and their logs.
3477 External links are URL-like locators. They start with a short identifying
3478 string followed by a colon. There can be no space after the colon. The
3479 following list shows examples for each link type.
3482 http://www.astro.uva.nl/~dominik @r{on the web}
3483 doi:10.1000/182 @r{DOI for an electronic resource}
3484 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3485 /home/dominik/images/jupiter.jpg @r{same as above}
3486 file:papers/last.pdf @r{file, relative path}
3487 ./papers/last.pdf @r{same as above}
3488 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3489 /myself@@some.where:papers/last.pdf @r{same as above}
3490 file:sometextfile::NNN @r{file, jump to line number}
3491 file:projects.org @r{another Org file}
3492 file:projects.org::some words @r{text search in Org file}@footnote{
3493 The actual behavior of the search will depend on the value of
3494 the option @code{org-link-search-must-match-exact-headline}. If its value
3495 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3496 exact headline will be matched. If the value is @code{'query-to-create},
3497 then an exact headline will be searched; if it is not found, then the user
3498 will be queried to create it.}
3499 file:projects.org::*task title @r{heading search in Org file}
3500 file+sys:/path/to/file @r{open via OS, like double-click}
3501 file+emacs:/path/to/file @r{force opening by Emacs}
3502 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3503 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3504 news:comp.emacs @r{Usenet link}
3505 mailto:adent@@galaxy.net @r{Mail link}
3506 mhe:folder @r{MH-E folder link}
3507 mhe:folder#id @r{MH-E message link}
3508 rmail:folder @r{RMAIL folder link}
3509 rmail:folder#id @r{RMAIL message link}
3510 gnus:group @r{Gnus group link}
3511 gnus:group#id @r{Gnus article link}
3512 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3513 irc:/irc.com/#emacs/bob @r{IRC link}
3514 info:org#External links @r{Info node link}
3515 shell:ls *.org @r{A shell command}
3516 elisp:org-agenda @r{Interactive Elisp command}
3517 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3521 @cindex WANDERLUST links
3522 On top of these built-in link types, some are available through the
3523 @code{contrib/} directory (@pxref{Installation}). For example, these links
3524 to VM or Wanderlust messages are available when you load the corresponding
3525 libraries from the @code{contrib/} directory:
3528 vm:folder @r{VM folder link}
3529 vm:folder#id @r{VM message link}
3530 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3531 vm-imap:account:folder @r{VM IMAP folder link}
3532 vm-imap:account:folder#id @r{VM IMAP message link}
3533 wl:folder @r{WANDERLUST folder link}
3534 wl:folder#id @r{WANDERLUST message link}
3537 For customizing Org to add new link types @ref{Adding hyperlink types}.
3539 A link should be enclosed in double brackets and may contain a descriptive
3540 text to be displayed instead of the URL (@pxref{Link format}), for example:
3543 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3547 If the description is a file name or URL that points to an image, HTML
3548 export (@pxref{HTML export}) will inline the image as a clickable
3549 button. If there is no description at all and the link points to an
3551 that image will be inlined into the exported HTML file.
3553 @cindex square brackets, around links
3554 @cindex plain text external links
3555 Org also finds external links in the normal text and activates them
3556 as links. If spaces must be part of the link (for example in
3557 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3558 about the end of the link, enclose them in square brackets.
3560 @node Handling links
3561 @section Handling links
3562 @cindex links, handling
3564 Org provides methods to create a link in the correct syntax, to
3565 insert it into an Org file, and to follow the link.
3568 @orgcmd{C-c l,org-store-link}
3569 @cindex storing links
3570 Store a link to the current location. This is a @emph{global} command (you
3571 must create the key binding yourself) which can be used in any buffer to
3572 create a link. The link will be stored for later insertion into an Org
3573 buffer (see below). What kind of link will be created depends on the current
3576 @b{Org mode buffers}@*
3577 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3578 to the target. Otherwise it points to the current headline, which will also
3579 be the description@footnote{If the headline contains a timestamp, it will be
3580 removed from the link and result in a wrong link---you should avoid putting
3581 timestamp in the headline.}.
3583 @vindex org-id-link-to-org-use-id
3584 @cindex property, CUSTOM_ID
3585 @cindex property, ID
3586 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3587 will be stored. In addition or alternatively (depending on the value of
3588 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3589 be created and/or used to construct a link@footnote{The library
3590 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3591 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3592 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3593 potentially create two links: a human-readable from the custom ID, and one
3594 that is globally unique and works even if the entry is moved from file to
3595 file. Later, when inserting the link, you need to decide which one to use.
3597 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3598 Pretty much all Emacs mail clients are supported. The link will point to the
3599 current article, or, in some GNUS buffers, to the group. The description is
3600 constructed from the author and the subject.
3602 @b{Web browsers: W3 and W3M}@*
3603 Here the link will be the current URL, with the page title as description.
3605 @b{Contacts: BBDB}@*
3606 Links created in a BBDB buffer will point to the current entry.
3609 @vindex org-irc-link-to-logs
3610 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3611 a @samp{file:/} style link to the relevant point in the logs for the current
3612 conversation is created. Otherwise an @samp{irc:/} style link to the
3613 user/channel/server under the point will be stored.
3616 For any other files, the link will point to the file, with a search string
3617 (@pxref{Search options}) pointing to the contents of the current line. If
3618 there is an active region, the selected words will form the basis of the
3619 search string. If the automatically created link is not working correctly or
3620 accurately enough, you can write custom functions to select the search string
3621 and to do the search for particular file types---see @ref{Custom searches}.
3622 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3625 When the cursor is in an agenda view, the created link points to the
3626 entry referenced by the current line.
3629 @orgcmd{C-c C-l,org-insert-link}
3630 @cindex link completion
3631 @cindex completion, of links
3632 @cindex inserting links
3633 @vindex org-keep-stored-link-after-insertion
3634 Insert a link@footnote{Note that you don't have to use this command to
3635 insert a link. Links in Org are plain text, and you can type or paste them
3636 straight into the buffer. By using this command, the links are automatically
3637 enclosed in double brackets, and you will be asked for the optional
3638 descriptive text.}. This prompts for a link to be inserted into the buffer.
3639 You can just type a link, using text for an internal link, or one of the link
3640 type prefixes mentioned in the examples above. The link will be inserted
3641 into the buffer@footnote{After insertion of a stored link, the link will be
3642 removed from the list of stored links. To keep it in the list later use, use
3643 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3644 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3645 If some text was selected when this command is called, the selected text
3646 becomes the default description.
3648 @b{Inserting stored links}@*
3649 All links stored during the
3650 current session are part of the history for this prompt, so you can access
3651 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3653 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3654 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3655 defined through link abbreviations (@pxref{Link abbreviations}). If you
3656 press @key{RET} after inserting only the @var{prefix}, Org will offer
3657 specific completion support for some link types@footnote{This works by
3658 calling a special function @code{org-PREFIX-complete-link}.} For
3659 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3660 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3661 @key{RET}} you can complete contact names.
3663 @cindex file name completion
3664 @cindex completion, of file names
3665 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3666 a file will be inserted and you may use file name completion to select
3667 the name of the file. The path to the file is inserted relative to the
3668 directory of the current Org file, if the linked file is in the current
3669 directory or in a sub-directory of it, or if the path is written relative
3670 to the current directory using @samp{../}. Otherwise an absolute path
3671 is used, if possible with @samp{~/} for your home directory. You can
3672 force an absolute path with two @kbd{C-u} prefixes.
3674 @item C-c C-l @ @r{(with cursor on existing link)}
3675 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3676 link and description parts of the link.
3678 @cindex following links
3679 @orgcmd{C-c C-o,org-open-at-point}
3680 @vindex org-file-apps
3681 @vindex org-link-frame-setup
3682 Open link at point. This will launch a web browser for URLs (using
3683 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3684 the corresponding links, and execute the command in a shell link. When the
3685 cursor is on an internal link, this command runs the corresponding search.
3686 When the cursor is on a TAG list in a headline, it creates the corresponding
3687 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3688 date. Furthermore, it will visit text and remote files in @samp{file:} links
3689 with Emacs and select a suitable application for local non-text files.
3690 Classification of files is based on file extension only. See option
3691 @code{org-file-apps}. If you want to override the default application and
3692 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3693 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3694 If the cursor is on a headline, but not on a link, offer all links in the
3695 headline and entry text. If you want to setup the frame configuration for
3696 following links, customize @code{org-link-frame-setup}.
3699 @vindex org-return-follows-link
3700 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3707 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3708 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3712 @vindex org-display-internal-link-with-indirect-buffer
3713 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3714 internal links to be displayed in another window@footnote{See the
3715 option @code{org-display-internal-link-with-indirect-buffer}}.
3717 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3718 @cindex inlining images
3719 @cindex images, inlining
3720 @vindex org-startup-with-inline-images
3721 @cindex @code{inlineimages}, STARTUP keyword
3722 @cindex @code{noinlineimages}, STARTUP keyword
3723 Toggle the inline display of linked images. Normally this will only inline
3724 images that have no description part in the link, i.e., images that will also
3725 be inlined during export. When called with a prefix argument, also display
3726 images that do have a link description. You can ask for inline images to be
3727 displayed at startup by configuring the variable
3728 @code{org-startup-with-inline-images}@footnote{with corresponding
3729 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3730 @orgcmd{C-c %,org-mark-ring-push}
3732 Push the current position onto the mark ring, to be able to return
3733 easily. Commands following an internal link do this automatically.
3735 @orgcmd{C-c &,org-mark-ring-goto}
3736 @cindex links, returning to
3737 Jump back to a recorded position. A position is recorded by the
3738 commands following internal links, and by @kbd{C-c %}. Using this
3739 command several times in direct succession moves through a ring of
3740 previously recorded positions.
3742 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3743 @cindex links, finding next/previous
3744 Move forward/backward to the next link in the buffer. At the limit of
3745 the buffer, the search fails once, and then wraps around. The key
3746 bindings for this are really too long; you might want to bind this also
3747 to @kbd{C-n} and @kbd{C-p}
3749 (add-hook 'org-load-hook
3751 (define-key org-mode-map "\C-n" 'org-next-link)
3752 (define-key org-mode-map "\C-p" 'org-previous-link)))
3756 @node Using links outside Org
3757 @section Using links outside Org
3759 You can insert and follow links that have Org syntax not only in
3760 Org, but in any Emacs buffer. For this, you should create two
3761 global commands, like this (please select suitable global keys
3765 (global-set-key "\C-c L" 'org-insert-link-global)
3766 (global-set-key "\C-c o" 'org-open-at-point-global)
3769 @node Link abbreviations
3770 @section Link abbreviations
3771 @cindex link abbreviations
3772 @cindex abbreviation, links
3774 Long URLs can be cumbersome to type, and often many similar links are
3775 needed in a document. For this you can use link abbreviations. An
3776 abbreviated link looks like this
3779 [[linkword:tag][description]]
3783 @vindex org-link-abbrev-alist
3784 where the tag is optional.
3785 The @i{linkword} must be a word, starting with a letter, followed by
3786 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3787 according to the information in the variable @code{org-link-abbrev-alist}
3788 that relates the linkwords to replacement text. Here is an example:
3792 (setq org-link-abbrev-alist
3793 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3794 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3795 ("google" . "http://www.google.com/search?q=")
3796 ("gmap" . "http://maps.google.com/maps?q=%s")
3797 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3798 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3802 If the replacement text contains the string @samp{%s}, it will be
3803 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3804 url-encode the tag (see the example above, where we need to encode
3805 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3806 to a custom function, and replace it by the resulting string.
3808 If the replacement text doesn't contain any specifier, it will simply
3809 be appended to the string in order to create the link.
3811 Instead of a string, you may also specify a function that will be
3812 called with the tag as the only argument to create the link.
3814 With the above setting, you could link to a specific bug with
3815 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3816 @code{[[google:OrgMode]]}, show the map location of the Free Software
3817 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3818 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3819 what the Org author is doing besides Emacs hacking with
3820 @code{[[ads:Dominik,C]]}.
3822 If you need special abbreviations just for a single Org buffer, you
3823 can define them in the file with
3827 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3828 #+LINK: google http://www.google.com/search?q=%s
3832 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3833 complete link abbreviations. You may also define a function
3834 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3835 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3836 not accept any arguments, and return the full link with prefix.
3838 @node Search options
3839 @section Search options in file links
3840 @cindex search option in file links
3841 @cindex file links, searching
3843 File links can contain additional information to make Emacs jump to a
3844 particular location in the file when following a link. This can be a
3845 line number or a search option after a double@footnote{For backward
3846 compatibility, line numbers can also follow a single colon.} colon. For
3847 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3848 links}) to a file, it encodes the words in the current line as a search
3849 string that can be used to find this line back later when following the
3850 link with @kbd{C-c C-o}.
3852 Here is the syntax of the different ways to attach a search to a file
3853 link, together with an explanation:
3856 [[file:~/code/main.c::255]]
3857 [[file:~/xx.org::My Target]]
3858 [[file:~/xx.org::*My Target]]
3859 [[file:~/xx.org::#my-custom-id]]
3860 [[file:~/xx.org::/regexp/]]
3867 Search for a link target @samp{<<My Target>>}, or do a text search for
3868 @samp{my target}, similar to the search in internal links, see
3869 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3870 link will become an HTML reference to the corresponding named anchor in
3873 In an Org file, restrict search to headlines.
3875 Link to a heading with a @code{CUSTOM_ID} property
3877 Do a regular expression search for @code{regexp}. This uses the Emacs
3878 command @code{occur} to list all matches in a separate window. If the
3879 target file is in Org mode, @code{org-occur} is used to create a
3880 sparse tree with the matches.
3881 @c If the target file is a directory,
3882 @c @code{grep} will be used to search all files in the directory.
3885 As a degenerate case, a file link with an empty file name can be used
3886 to search the current file. For example, @code{[[file:::find me]]} does
3887 a search for @samp{find me} in the current file, just as
3888 @samp{[[find me]]} would.
3890 @node Custom searches
3891 @section Custom Searches
3892 @cindex custom search strings
3893 @cindex search strings, custom
3895 The default mechanism for creating search strings and for doing the
3896 actual search related to a file link may not work correctly in all
3897 cases. For example, Bib@TeX{} database files have many entries like
3898 @samp{year="1993"} which would not result in good search strings,
3899 because the only unique identification for a Bib@TeX{} entry is the
3902 @vindex org-create-file-search-functions
3903 @vindex org-execute-file-search-functions
3904 If you come across such a problem, you can write custom functions to set
3905 the right search string for a particular file type, and to do the search
3906 for the string in the file. Using @code{add-hook}, these functions need
3907 to be added to the hook variables
3908 @code{org-create-file-search-functions} and
3909 @code{org-execute-file-search-functions}. See the docstring for these
3910 variables for more information. Org actually uses this mechanism
3911 for Bib@TeX{} database files, and you can use the corresponding code as
3912 an implementation example. See the file @file{org-bibtex.el}.
3918 Org mode does not maintain TODO lists as separate documents@footnote{Of
3919 course, you can make a document that contains only long lists of TODO items,
3920 but this is not required.}. Instead, TODO items are an integral part of the
3921 notes file, because TODO items usually come up while taking notes! With Org
3922 mode, simply mark any entry in a tree as being a TODO item. In this way,
3923 information is not duplicated, and the entire context from which the TODO
3924 item emerged is always present.
3926 Of course, this technique for managing TODO items scatters them
3927 throughout your notes file. Org mode compensates for this by providing
3928 methods to give you an overview of all the things that you have to do.
3931 * TODO basics:: Marking and displaying TODO entries
3932 * TODO extensions:: Workflow and assignments
3933 * Progress logging:: Dates and notes for progress
3934 * Priorities:: Some things are more important than others
3935 * Breaking down tasks:: Splitting a task into manageable pieces
3936 * Checkboxes:: Tick-off lists
3940 @section Basic TODO functionality
3942 Any headline becomes a TODO item when it starts with the word
3943 @samp{TODO}, for example:
3946 *** TODO Write letter to Sam Fortune
3950 The most important commands to work with TODO entries are:
3953 @orgcmd{C-c C-t,org-todo}
3954 @cindex cycling, of TODO states
3955 @vindex org-use-fast-todo-selection
3957 Rotate the TODO state of the current item among
3960 ,-> (unmarked) -> TODO -> DONE --.
3961 '--------------------------------'
3964 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3965 states}), you will be prompted for a TODO keyword through the fast selection
3966 interface; this is the default behavior when
3967 @code{org-use-fast-todo-selection} is non-@code{nil}.
3969 The same rotation can also be done ``remotely'' from the timeline and agenda
3970 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3972 @orgkey{C-u C-c C-t}
3973 When TODO keywords have no selection keys, select a specific keyword using
3974 completion; otherwise force cycling through TODO states with no prompt. When
3975 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3976 selection interface.
3978 @kindex S-@key{right}
3979 @kindex S-@key{left}
3980 @item S-@key{right} @ @r{/} @ S-@key{left}
3981 @vindex org-treat-S-cursor-todo-selection-as-state-change
3982 Select the following/preceding TODO state, similar to cycling. Useful
3983 mostly if more than two TODO states are possible (@pxref{TODO
3984 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3985 with @code{shift-selection-mode}. See also the variable
3986 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3987 @orgcmd{C-c / t,org-show-todo-tree}
3988 @cindex sparse tree, for TODO
3989 @vindex org-todo-keywords
3990 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3991 entire buffer, but shows all TODO items (with not-DONE state) and the
3992 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3993 / T}), search for a specific TODO@. You will be prompted for the keyword,
3994 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3995 entries that match any one of these keywords. With a numeric prefix argument
3996 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
3997 With two prefix arguments, find all TODO states, both un-done and done.
3998 @orgcmd{C-c a t,org-todo-list}
3999 Show the global TODO list. Collects the TODO items (with not-DONE states)
4000 from all agenda files (@pxref{Agenda views}) into a single buffer. The new
4001 buffer will be in @code{agenda-mode}, which provides commands to examine and
4002 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4003 @xref{Global TODO list}, for more information.
4004 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4005 Insert a new TODO entry below the current one.
4009 @vindex org-todo-state-tags-triggers
4010 Changing a TODO state can also trigger tag changes. See the docstring of the
4011 option @code{org-todo-state-tags-triggers} for details.
4013 @node TODO extensions
4014 @section Extended use of TODO keywords
4015 @cindex extended TODO keywords
4017 @vindex org-todo-keywords
4018 By default, marked TODO entries have one of only two states: TODO and
4019 DONE@. Org mode allows you to classify TODO items in more complex ways
4020 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
4021 special setup, the TODO keyword system can work differently in different
4024 Note that @i{tags} are another way to classify headlines in general and
4025 TODO items in particular (@pxref{Tags}).
4028 * Workflow states:: From TODO to DONE in steps
4029 * TODO types:: I do this, Fred does the rest
4030 * Multiple sets in one file:: Mixing it all, and still finding your way
4031 * Fast access to TODO states:: Single letter selection of a state
4032 * Per-file keywords:: Different files, different requirements
4033 * Faces for TODO keywords:: Highlighting states
4034 * TODO dependencies:: When one task needs to wait for others
4037 @node Workflow states
4038 @subsection TODO keywords as workflow states
4039 @cindex TODO workflow
4040 @cindex workflow states as TODO keywords
4042 You can use TODO keywords to indicate different @emph{sequential} states
4043 in the process of working on an item, for example@footnote{Changing
4044 this variable only becomes effective after restarting Org mode in a
4048 (setq org-todo-keywords
4049 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4052 The vertical bar separates the TODO keywords (states that @emph{need
4053 action}) from the DONE states (which need @emph{no further action}). If
4054 you don't provide the separator bar, the last state is used as the DONE
4056 @cindex completion, of TODO keywords
4057 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4058 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4059 also use a numeric prefix argument to quickly select a specific state. For
4060 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4061 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4062 define many keywords, you can use in-buffer completion
4063 (@pxref{Completion}) or even a special one-key selection scheme
4064 (@pxref{Fast access to TODO states}) to insert these words into the
4065 buffer. Changing a TODO state can be logged with a timestamp, see
4066 @ref{Tracking TODO state changes}, for more information.
4069 @subsection TODO keywords as types
4071 @cindex names as TODO keywords
4072 @cindex types as TODO keywords
4074 The second possibility is to use TODO keywords to indicate different
4075 @emph{types} of action items. For example, you might want to indicate
4076 that items are for ``work'' or ``home''. Or, when you work with several
4077 people on a single project, you might want to assign action items
4078 directly to persons, by using their names as TODO keywords. This would
4079 be set up like this:
4082 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4085 In this case, different keywords do not indicate a sequence, but rather
4086 different types. So the normal work flow would be to assign a task to a
4087 person, and later to mark it DONE@. Org mode supports this style by adapting
4088 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4089 @kbd{t} command in the timeline and agenda buffers.}. When used several
4090 times in succession, it will still cycle through all names, in order to first
4091 select the right type for a task. But when you return to the item after some
4092 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4093 to DONE@. Use prefix arguments or completion to quickly select a specific
4094 name. You can also review the items of a specific TODO type in a sparse tree
4095 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4096 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4097 from all agenda files into a single buffer, you would use the numeric prefix
4098 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4100 @node Multiple sets in one file
4101 @subsection Multiple keyword sets in one file
4102 @cindex TODO keyword sets
4104 Sometimes you may want to use different sets of TODO keywords in
4105 parallel. For example, you may want to have the basic
4106 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4107 separate state indicating that an item has been canceled (so it is not
4108 DONE, but also does not require action). Your setup would then look
4112 (setq org-todo-keywords
4113 '((sequence "TODO" "|" "DONE")
4114 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4115 (sequence "|" "CANCELED")))
4118 The keywords should all be different, this helps Org mode to keep track
4119 of which subsequence should be used for a given entry. In this setup,
4120 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4121 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4122 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4123 select the correct sequence. Besides the obvious ways like typing a
4124 keyword or using completion, you may also apply the following commands:
4127 @kindex C-S-@key{right}
4128 @kindex C-S-@key{left}
4129 @kindex C-u C-u C-c C-t
4130 @item C-u C-u C-c C-t
4131 @itemx C-S-@key{right}
4132 @itemx C-S-@key{left}
4133 These keys jump from one TODO subset to the next. In the above example,
4134 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4135 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4136 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4137 @code{shift-selection-mode} (@pxref{Conflicts}).
4138 @kindex S-@key{right}
4139 @kindex S-@key{left}
4142 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4143 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4144 from @code{DONE} to @code{REPORT} in the example above. See also
4145 @ref{Conflicts}, for a discussion of the interaction with
4146 @code{shift-selection-mode}.
4149 @node Fast access to TODO states
4150 @subsection Fast access to TODO states
4152 If you would like to quickly change an entry to an arbitrary TODO state
4153 instead of cycling through the states, you can set up keys for single-letter
4154 access to the states. This is done by adding the selection character after
4155 each keyword, in parentheses@footnote{All characters are allowed except
4156 @code{@@^!}, which have a special meaning here.}. For example:
4159 (setq org-todo-keywords
4160 '((sequence "TODO(t)" "|" "DONE(d)")
4161 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4162 (sequence "|" "CANCELED(c)")))
4165 @vindex org-fast-tag-selection-include-todo
4166 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4167 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4168 keyword from an entry.@footnote{Check also the option
4169 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4170 state through the tags interface (@pxref{Setting tags}), in case you like to
4171 mingle the two concepts. Note that this means you need to come up with
4172 unique keys across both sets of keywords.}
4174 @node Per-file keywords
4175 @subsection Setting up keywords for individual files
4176 @cindex keyword options
4177 @cindex per-file keywords
4182 It can be very useful to use different aspects of the TODO mechanism in
4183 different files. For file-local settings, you need to add special lines
4184 to the file which set the keywords and interpretation for that file
4185 only. For example, to set one of the two examples discussed above, you
4186 need one of the following lines, starting in column zero anywhere in the
4190 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4192 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4193 interpretation, but it means the same as @code{#+TODO}), or
4195 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4198 A setup for using several sets in parallel would be:
4202 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4206 @cindex completion, of option keywords
4208 @noindent To make sure you are using the correct keyword, type
4209 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4211 @cindex DONE, final TODO keyword
4212 Remember that the keywords after the vertical bar (or the last keyword
4213 if no bar is there) must always mean that the item is DONE (although you
4214 may use a different word). After changing one of these lines, use
4215 @kbd{C-c C-c} with the cursor still in the line to make the changes
4216 known to Org mode@footnote{Org mode parses these lines only when
4217 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4218 cursor in a line starting with @samp{#+} is simply restarting Org mode
4219 for the current buffer.}.
4221 @node Faces for TODO keywords
4222 @subsection Faces for TODO keywords
4223 @cindex faces, for TODO keywords
4225 @vindex org-todo @r{(face)}
4226 @vindex org-done @r{(face)}
4227 @vindex org-todo-keyword-faces
4228 Org mode highlights TODO keywords with special faces: @code{org-todo}
4229 for keywords indicating that an item still has to be acted upon, and
4230 @code{org-done} for keywords indicating that an item is finished. If
4231 you are using more than 2 different states, you might want to use
4232 special faces for some of them. This can be done using the option
4233 @code{org-todo-keyword-faces}. For example:
4237 (setq org-todo-keyword-faces
4238 '(("TODO" . org-warning) ("STARTED" . "yellow")
4239 ("CANCELED" . (:foreground "blue" :weight bold))))
4243 While using a list with face properties as shown for CANCELED @emph{should}
4244 work, this does not always seem to be the case. If necessary, define a
4245 special face and use that. A string is interpreted as a color. The option
4246 @code{org-faces-easy-properties} determines if that color is interpreted as a
4247 foreground or a background color.
4249 @node TODO dependencies
4250 @subsection TODO dependencies
4251 @cindex TODO dependencies
4252 @cindex dependencies, of TODO states
4254 @vindex org-enforce-todo-dependencies
4255 @cindex property, ORDERED
4256 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4257 dependencies. Usually, a parent TODO task should not be marked DONE until
4258 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4259 there is a logical sequence to a number of (sub)tasks, so that one task
4260 cannot be acted upon before all siblings above it are done. If you customize
4261 the option @code{org-enforce-todo-dependencies}, Org will block entries
4262 from changing state to DONE while they have children that are not DONE@.
4263 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4264 will be blocked until all earlier siblings are marked DONE@. Here is an
4268 * TODO Blocked until (two) is done
4277 ** TODO b, needs to wait for (a)
4278 ** TODO c, needs to wait for (a) and (b)
4282 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4283 @vindex org-track-ordered-property-with-tag
4284 @cindex property, ORDERED
4285 Toggle the @code{ORDERED} property of the current entry. A property is used
4286 for this behavior because this should be local to the current entry, not
4287 inherited like a tag. However, if you would like to @i{track} the value of
4288 this property with a tag for better visibility, customize the option
4289 @code{org-track-ordered-property-with-tag}.
4290 @orgkey{C-u C-u C-u C-c C-t}
4291 Change TODO state, circumventing any state blocking.
4294 @vindex org-agenda-dim-blocked-tasks
4295 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4296 that cannot be closed because of such dependencies will be shown in a dimmed
4297 font or even made invisible in agenda views (@pxref{Agenda views}).
4299 @cindex checkboxes and TODO dependencies
4300 @vindex org-enforce-todo-dependencies
4301 You can also block changes of TODO states by looking at checkboxes
4302 (@pxref{Checkboxes}). If you set the option
4303 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4304 checkboxes will be blocked from switching to DONE.
4306 If you need more complex dependency structures, for example dependencies
4307 between entries in different trees or files, check out the contributed
4308 module @file{org-depend.el}.
4311 @node Progress logging
4312 @section Progress logging
4313 @cindex progress logging
4314 @cindex logging, of progress
4316 Org mode can automatically record a timestamp and possibly a note when
4317 you mark a TODO item as DONE, or even each time you change the state of
4318 a TODO item. This system is highly configurable; settings can be on a
4319 per-keyword basis and can be localized to a file or even a subtree. For
4320 information on how to clock working time for a task, see @ref{Clocking
4324 * Closing items:: When was this entry marked DONE?
4325 * Tracking TODO state changes:: When did the status change?
4326 * Tracking your habits:: How consistent have you been?
4330 @subsection Closing items
4332 The most basic logging is to keep track of @emph{when} a certain TODO
4333 item was finished. This is achieved with@footnote{The corresponding
4334 in-buffer setting is: @code{#+STARTUP: logdone}}
4337 (setq org-log-done 'time)
4340 @vindex org-closed-keep-when-no-todo
4342 Then each time you turn an entry from a TODO (not-done) state into any of the
4343 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4344 the headline. If you turn the entry back into a TODO item through further
4345 state cycling, that line will be removed again. If you turn the entry back
4346 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4347 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4348 non-@code{nil}. If you want to record a note along with the timestamp,
4349 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4353 (setq org-log-done 'note)
4357 You will then be prompted for a note, and that note will be stored below
4358 the entry with a @samp{Closing Note} heading.
4360 In the timeline (@pxref{Timeline}) and in the agenda
4361 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4362 display the TODO items with a @samp{CLOSED} timestamp on each day,
4363 giving you an overview of what has been done.
4365 @node Tracking TODO state changes
4366 @subsection Tracking TODO state changes
4367 @cindex drawer, for state change recording
4369 @vindex org-log-states-order-reversed
4370 @vindex org-log-into-drawer
4371 @cindex property, LOG_INTO_DRAWER
4372 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4373 might want to keep track of when a state change occurred and maybe take a
4374 note about this change. You can either record just a timestamp, or a
4375 time-stamped note for a change. These records will be inserted after the
4376 headline as an itemized list, newest first@footnote{See the option
4377 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4378 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4379 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4380 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4381 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4382 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4383 overrule the setting of this variable for a subtree by setting a
4384 @code{LOG_INTO_DRAWER} property.
4386 Since it is normally too much to record a note for every state, Org mode
4387 expects configuration on a per-keyword basis for this. This is achieved by
4388 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4389 with timestamp) in parentheses after each keyword. For example, with the
4393 (setq org-todo-keywords
4394 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4397 To record a timestamp without a note for TODO keywords configured with
4398 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4401 @vindex org-log-done
4402 You not only define global TODO keywords and fast access keys, but also
4403 request that a time is recorded when the entry is set to
4404 DONE@footnote{It is possible that Org mode will record two timestamps
4405 when you are using both @code{org-log-done} and state change logging.
4406 However, it will never prompt for two notes---if you have configured
4407 both, the state change recording note will take precedence and cancel
4408 the @samp{Closing Note}.}, and that a note is recorded when switching to
4409 WAIT or CANCELED@. The setting for WAIT is even more special: the
4410 @samp{!} after the slash means that in addition to the note taken when
4411 entering the state, a timestamp should be recorded when @i{leaving} the
4412 WAIT state, if and only if the @i{target} state does not configure
4413 logging for entering it. So it has no effect when switching from WAIT
4414 to DONE, because DONE is configured to record a timestamp only. But
4415 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4416 setting now triggers a timestamp even though TODO has no logging
4419 You can use the exact same syntax for setting logging preferences local
4422 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4425 @cindex property, LOGGING
4426 In order to define logging settings that are local to a subtree or a
4427 single item, define a LOGGING property in this entry. Any non-empty
4428 LOGGING property resets all logging settings to @code{nil}. You may then turn
4429 on logging for this specific tree using STARTUP keywords like
4430 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4431 settings like @code{TODO(!)}. For example
4434 * TODO Log each state with only a time
4436 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4438 * TODO Only log when switching to WAIT, and when repeating
4440 :LOGGING: WAIT(@@) logrepeat
4442 * TODO No logging at all
4448 @node Tracking your habits
4449 @subsection Tracking your habits
4452 Org has the ability to track the consistency of a special category of TODOs,
4453 called ``habits''. A habit has the following properties:
4457 You have enabled the @code{habits} module by customizing @code{org-modules}.
4459 The habit is a TODO item, with a TODO keyword representing an open state.
4461 The property @code{STYLE} is set to the value @code{habit}.
4463 The TODO has a scheduled date, usually with a @code{.+} style repeat
4464 interval. A @code{++} style may be appropriate for habits with time
4465 constraints, e.g., must be done on weekends, or a @code{+} style for an
4466 unusual habit that can have a backlog, e.g., weekly reports.
4468 The TODO may also have minimum and maximum ranges specified by using the
4469 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4470 three days, but at most every two days.
4472 You must also have state logging for the @code{DONE} state enabled
4473 (@pxref{Tracking TODO state changes}), in order for historical data to be
4474 represented in the consistency graph. If it is not enabled it is not an
4475 error, but the consistency graphs will be largely meaningless.
4478 To give you an idea of what the above rules look like in action, here's an
4479 actual habit with some history:
4483 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4484 - State "DONE" from "TODO" [2009-10-15 Thu]
4485 - State "DONE" from "TODO" [2009-10-12 Mon]
4486 - State "DONE" from "TODO" [2009-10-10 Sat]
4487 - State "DONE" from "TODO" [2009-10-04 Sun]
4488 - State "DONE" from "TODO" [2009-10-02 Fri]
4489 - State "DONE" from "TODO" [2009-09-29 Tue]
4490 - State "DONE" from "TODO" [2009-09-25 Fri]
4491 - State "DONE" from "TODO" [2009-09-19 Sat]
4492 - State "DONE" from "TODO" [2009-09-16 Wed]
4493 - State "DONE" from "TODO" [2009-09-12 Sat]
4496 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4500 What this habit says is: I want to shave at most every 2 days (given by the
4501 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4502 today is the 15th, then the habit first appears in the agenda on Oct 17,
4503 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4504 after four days have elapsed.
4506 What's really useful about habits is that they are displayed along with a
4507 consistency graph, to show how consistent you've been at getting that task
4508 done in the past. This graph shows every day that the task was done over the
4509 past three weeks, with colors for each day. The colors used are:
4513 If the task wasn't to be done yet on that day.
4515 If the task could have been done on that day.
4517 If the task was going to be overdue the next day.
4519 If the task was overdue on that day.
4522 In addition to coloring each day, the day is also marked with an asterisk if
4523 the task was actually done that day, and an exclamation mark to show where
4524 the current day falls in the graph.
4526 There are several configuration variables that can be used to change the way
4527 habits are displayed in the agenda.
4530 @item org-habit-graph-column
4531 The buffer column at which the consistency graph should be drawn. This will
4532 overwrite any text in that column, so it is a good idea to keep your habits'
4533 titles brief and to the point.
4534 @item org-habit-preceding-days
4535 The amount of history, in days before today, to appear in consistency graphs.
4536 @item org-habit-following-days
4537 The number of days after today that will appear in consistency graphs.
4538 @item org-habit-show-habits-only-for-today
4539 If non-@code{nil}, only show habits in today's agenda view. This is set to true by
4543 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4544 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4545 bring them back. They are also subject to tag filtering, if you have habits
4546 which should only be done in certain contexts, for example.
4552 If you use Org mode extensively, you may end up with enough TODO items that
4553 it starts to make sense to prioritize them. Prioritizing can be done by
4554 placing a @emph{priority cookie} into the headline of a TODO item, like this
4557 *** TODO [#A] Write letter to Sam Fortune
4561 @vindex org-priority-faces
4562 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4563 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4564 treated just like priority @samp{B}. Priorities make a difference only for
4565 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4566 have no inherent meaning to Org mode. The cookies can be highlighted with
4567 special faces by customizing @code{org-priority-faces}.
4569 Priorities can be attached to any outline node; they do not need to be TODO
4575 @findex org-priority
4576 Set the priority of the current headline (@command{org-priority}). The
4577 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4578 When you press @key{SPC} instead, the priority cookie is removed from the
4579 headline. The priorities can also be changed ``remotely'' from the timeline
4580 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4582 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4583 @vindex org-priority-start-cycle-with-default
4584 Increase/decrease priority of current headline@footnote{See also the option
4585 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4586 also used to modify timestamps (@pxref{Creating timestamps}). See also
4587 @ref{Conflicts}, for a discussion of the interaction with
4588 @code{shift-selection-mode}.
4591 @vindex org-highest-priority
4592 @vindex org-lowest-priority
4593 @vindex org-default-priority
4594 You can change the range of allowed priorities by setting the options
4595 @code{org-highest-priority}, @code{org-lowest-priority}, and
4596 @code{org-default-priority}. For an individual buffer, you may set
4597 these values (highest, lowest, default) like this (please make sure that
4598 the highest priority is earlier in the alphabet than the lowest
4601 @cindex #+PRIORITIES
4606 @node Breaking down tasks
4607 @section Breaking tasks down into subtasks
4608 @cindex tasks, breaking down
4609 @cindex statistics, for TODO items
4611 @vindex org-agenda-todo-list-sublevels
4612 It is often advisable to break down large tasks into smaller, manageable
4613 subtasks. You can do this by creating an outline tree below a TODO item,
4614 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4615 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4616 the overview over the fraction of subtasks that are already completed, insert
4617 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4618 be updated each time the TODO status of a child changes, or when pressing
4619 @kbd{C-c C-c} on the cookie. For example:
4622 * Organize Party [33%]
4623 ** TODO Call people [1/2]
4627 ** DONE Talk to neighbor
4630 @cindex property, COOKIE_DATA
4631 If a heading has both checkboxes and TODO children below it, the meaning of
4632 the statistics cookie become ambiguous. Set the property
4633 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4636 @vindex org-hierarchical-todo-statistics
4637 If you would like to have the statistics cookie count any TODO entries in the
4638 subtree (not just direct children), configure
4639 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4640 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4644 * Parent capturing statistics [2/20]
4646 :COOKIE_DATA: todo recursive
4650 If you would like a TODO entry to automatically change to DONE
4651 when all children are done, you can use the following setup:
4654 (defun org-summary-todo (n-done n-not-done)
4655 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4656 (let (org-log-done org-log-states) ; turn off logging
4657 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4659 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4663 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4664 large number of subtasks (@pxref{Checkboxes}).
4671 @vindex org-list-automatic-rules
4672 Every item in a plain list@footnote{With the exception of description
4673 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4674 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4675 it with the string @samp{[ ]}. This feature is similar to TODO items
4676 (@pxref{TODO items}), but is more lightweight. Checkboxes are not included
4677 in the global TODO list, so they are often great to split a task into a
4678 number of simple steps. Or you can use them in a shopping list. To toggle a
4679 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4680 @file{org-mouse.el}).
4682 Here is an example of a checkbox list.
4685 * TODO Organize party [2/4]
4686 - [-] call people [1/3]
4691 - [ ] think about what music to play
4692 - [X] talk to the neighbors
4695 Checkboxes work hierarchically, so if a checkbox item has children that
4696 are checkboxes, toggling one of the children checkboxes will make the
4697 parent checkbox reflect if none, some, or all of the children are
4700 @cindex statistics, for checkboxes
4701 @cindex checkbox statistics
4702 @cindex property, COOKIE_DATA
4703 @vindex org-checkbox-hierarchical-statistics
4704 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4705 indicating how many checkboxes present in this entry have been checked off,
4706 and the total number of checkboxes present. This can give you an idea on how
4707 many checkboxes remain, even without opening a folded entry. The cookies can
4708 be placed into a headline or into (the first line of) a plain list item.
4709 Each cookie covers checkboxes of direct children structurally below the
4710 headline/item on which the cookie appears@footnote{Set the option
4711 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4712 count all checkboxes below the cookie, not just those belonging to direct
4713 children.}. You have to insert the cookie yourself by typing either
4714 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4715 result, as in the examples above. With @samp{[%]} you get information about
4716 the percentage of checkboxes checked (in the above example, this would be
4717 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4718 count either checkboxes below the heading or TODO states of children, and it
4719 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4720 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4722 @cindex blocking, of checkboxes
4723 @cindex checkbox blocking
4724 @cindex property, ORDERED
4725 If the current outline node has an @code{ORDERED} property, checkboxes must
4726 be checked off in sequence, and an error will be thrown if you try to check
4727 off a box while there are unchecked boxes above it.
4729 @noindent The following commands work with checkboxes:
4732 @orgcmd{C-c C-c,org-toggle-checkbox}
4733 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4734 With a single prefix argument, add an empty checkbox or remove the current
4735 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4736 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4737 considered to be an intermediate state.
4738 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4739 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4740 double prefix argument, set it to @samp{[-]}, which is considered to be an
4744 If there is an active region, toggle the first checkbox in the region
4745 and set all remaining boxes to the same status as the first. With a prefix
4746 arg, add or remove the checkbox for all items in the region.
4748 If the cursor is in a headline, toggle checkboxes in the region between
4749 this headline and the next (so @emph{not} the entire subtree).
4751 If there is no active region, just toggle the checkbox at point.
4753 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4754 Insert a new item with a checkbox. This works only if the cursor is already
4755 in a plain list item (@pxref{Plain lists}).
4756 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4757 @vindex org-track-ordered-property-with-tag
4758 @cindex property, ORDERED
4759 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4760 be checked off in sequence. A property is used for this behavior because
4761 this should be local to the current entry, not inherited like a tag.
4762 However, if you would like to @i{track} the value of this property with a tag
4763 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4764 @orgcmd{C-c #,org-update-statistics-cookies}
4765 Update the statistics cookie in the current outline entry. When called with
4766 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4767 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4768 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4769 changing TODO states. If you delete boxes/entries or add/change them by
4770 hand, use this command to get things back into sync.
4776 @cindex headline tagging
4777 @cindex matching, tags
4778 @cindex sparse tree, tag based
4780 An excellent way to implement labels and contexts for cross-correlating
4781 information is to assign @i{tags} to headlines. Org mode has extensive
4784 @vindex org-tag-faces
4785 Every headline can contain a list of tags; they occur at the end of the
4786 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4787 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4788 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4789 Tags will by default be in bold face with the same color as the headline.
4790 You may specify special faces for specific tags using the option
4791 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4792 (@pxref{Faces for TODO keywords}).
4795 * Tag inheritance:: Tags use the tree structure of the outline
4796 * Setting tags:: How to assign tags to a headline
4797 * Tag groups:: Use one tag to search for several tags
4798 * Tag searches:: Searching for combinations of tags
4801 @node Tag inheritance
4802 @section Tag inheritance
4803 @cindex tag inheritance
4804 @cindex inheritance, of tags
4805 @cindex sublevels, inclusion into tags match
4807 @i{Tags} make use of the hierarchical structure of outline trees. If a
4808 heading has a certain tag, all subheadings will inherit the tag as
4809 well. For example, in the list
4812 * Meeting with the French group :work:
4813 ** Summary by Frank :boss:notes:
4814 *** TODO Prepare slides for him :action:
4818 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4819 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4820 explicitly marked with those tags. You can also set tags that all entries in
4821 a file should inherit just as if these tags were defined in a hypothetical
4822 level zero that surrounds the entire file. Use a line like this@footnote{As
4823 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4824 changes in the line.}:
4828 #+FILETAGS: :Peter:Boss:Secret:
4832 @vindex org-use-tag-inheritance
4833 @vindex org-tags-exclude-from-inheritance
4834 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4835 To turn it off entirely, use @code{org-use-tag-inheritance}.
4837 @vindex org-tags-match-list-sublevels
4838 When a headline matches during a tags search while tag inheritance is turned
4839 on, all the sublevels in the same tree will (for a simple match form) match
4840 as well@footnote{This is only true if the search does not involve more
4841 complex tests including properties (@pxref{Property searches}).}. The list
4842 of matches may then become very long. If you only want to see the first tags
4843 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4846 @vindex org-agenda-use-tag-inheritance
4847 Tag inheritance is relevant when the agenda search tries to match a tag,
4848 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4849 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4850 have your tags correctly set in the agenda, so that tag filtering works fine,
4851 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4852 this: the default value includes all agenda types, but setting this to @code{nil}
4853 can really speed up agenda generation.
4856 @section Setting tags
4857 @cindex setting tags
4858 @cindex tags, setting
4861 Tags can simply be typed into the buffer at the end of a headline.
4862 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4863 also a special command for inserting tags:
4866 @orgcmd{C-c C-q,org-set-tags-command}
4867 @cindex completion, of tags
4868 @vindex org-tags-column
4869 Enter new tags for the current headline. Org mode will either offer
4870 completion or a special single-key interface for setting tags, see
4871 below. After pressing @key{RET}, the tags will be inserted and aligned
4872 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4873 tags in the current buffer will be aligned to that column, just to make
4874 things look nice. TAGS are automatically realigned after promotion,
4875 demotion, and TODO state changes (@pxref{TODO basics}).
4877 @orgcmd{C-c C-c,org-set-tags-command}
4878 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4881 @vindex org-tag-alist
4882 Org supports tag insertion based on a @emph{list of tags}. By
4883 default this list is constructed dynamically, containing all tags
4884 currently used in the buffer. You may also globally specify a hard list
4885 of tags with the variable @code{org-tag-alist}. Finally you can set
4886 the default tags for a given file with lines like
4890 #+TAGS: @@work @@home @@tennisclub
4891 #+TAGS: laptop car pc sailboat
4894 If you have globally defined your preferred set of tags using the
4895 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4896 in a specific file, add an empty TAGS option line to that file:
4902 @vindex org-tag-persistent-alist
4903 If you have a preferred set of tags that you would like to use in every file,
4904 in addition to those defined on a per-file basis by TAGS option lines, then
4905 you may specify a list of tags with the variable
4906 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4907 by adding a STARTUP option line to that file:
4913 By default Org mode uses the standard minibuffer completion facilities for
4914 entering tags. However, it also implements another, quicker, tag selection
4915 method called @emph{fast tag selection}. This allows you to select and
4916 deselect tags with just a single key press. For this to work well you should
4917 assign unique letters to most of your commonly used tags. You can do this
4918 globally by configuring the variable @code{org-tag-alist} in your
4919 @file{.emacs} file. For example, you may find the need to tag many items in
4920 different files with @samp{:@@home:}. In this case you can set something
4924 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4927 @noindent If the tag is only relevant to the file you are working on, then you
4928 can instead set the TAGS option line as:
4931 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4934 @noindent The tags interface will show the available tags in a splash
4935 window. If you want to start a new line after a specific tag, insert
4936 @samp{\n} into the tag list
4939 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4942 @noindent or write them in two lines:
4945 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4946 #+TAGS: laptop(l) pc(p)
4950 You can also group together tags that are mutually exclusive by using
4954 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4957 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4958 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4960 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4961 these lines to activate any changes.
4964 To set these mutually exclusive groups in the variable @code{org-tag-alist},
4965 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4966 of the braces. Similarly, you can use @code{:newline} to indicate a line
4967 break. The previous example would be set globally by the following
4971 (setq org-tag-alist '((:startgroup . nil)
4972 ("@@work" . ?w) ("@@home" . ?h)
4973 ("@@tennisclub" . ?t)
4975 ("laptop" . ?l) ("pc" . ?p)))
4978 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4979 automatically present you with a special interface, listing inherited tags,
4980 the tags of the current headline, and a list of all valid tags with
4981 corresponding keys@footnote{Keys will automatically be assigned to tags which
4982 have no configured keys.}. In this interface, you can use the following
4987 Pressing keys assigned to tags will add or remove them from the list of
4988 tags in the current line. Selecting a tag in a group of mutually
4989 exclusive tags will turn off any other tags from that group.
4992 Enter a tag in the minibuffer, even if the tag is not in the predefined
4993 list. You will be able to complete on all tags present in the buffer.
4994 You can also add several tags: just separate them with a comma.
4998 Clear all tags for this line.
5001 Accept the modified set.
5003 Abort without installing changes.
5005 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5007 Turn off groups of mutually exclusive tags. Use this to (as an
5008 exception) assign several tags from such a group.
5010 Toggle auto-exit after the next change (see below).
5011 If you are using expert mode, the first @kbd{C-c} will display the
5016 This method lets you assign tags to a headline with very few keys. With
5017 the above setup, you could clear the current tags and set @samp{@@home},
5018 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5019 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
5020 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5021 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
5022 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5023 @key{RET} @key{RET}}.
5025 @vindex org-fast-tag-selection-single-key
5026 If you find that most of the time you need only a single key press to
5027 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5028 Then you no longer have to press @key{RET} to exit fast tag selection---it
5029 will immediately exit after the first change. If you then occasionally
5030 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5031 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5032 instead of @kbd{C-c C-c}). If you set the variable to the value
5033 @code{expert}, the special window is not even shown for single-key tag
5034 selection, it comes up only when you press an extra @kbd{C-c}.
5040 @cindex tags, groups
5041 In a set of mutually exclusive tags, the first tag can be defined as a
5042 @emph{group tag}. When you search for a group tag, it will return matches
5043 for all members in the group. In an agenda view, filtering by a group tag
5044 will display headlines tagged with at least one of the members of the
5045 group. This makes tag searches and filters even more flexible.
5047 You can set group tags by inserting a colon between the group tag and other
5048 tags---beware that all whitespaces are mandatory so that Org can parse this
5052 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5055 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5056 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5058 You can also use the @code{:grouptags} keyword directly when setting
5059 @code{org-tag-alist}:
5062 (setq org-tag-alist '((:startgroup . nil)
5065 ("@@read_book" . nil)
5066 ("@@read_ebook" . nil)
5070 You cannot nest group tags or use a group tag as a tag in another group.
5073 @vindex org-group-tags
5074 If you want to ignore group tags temporarily, toggle group tags support
5075 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5076 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5079 @section Tag searches
5080 @cindex tag searches
5081 @cindex searching for tags
5083 Once a system of tags has been set up, it can be used to collect related
5084 information into special lists.
5087 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5088 Create a sparse tree with all headlines matching a tags/property/TODO search.
5089 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5090 @xref{Matching tags and properties}.
5091 @orgcmd{C-c a m,org-tags-view}
5092 Create a global list of tag matches from all agenda files. @xref{Matching
5093 tags and properties}.
5094 @orgcmd{C-c a M,org-tags-view}
5095 @vindex org-tags-match-list-sublevels
5096 Create a global list of tag matches from all agenda files, but check
5097 only TODO items and force checking subitems (see the option
5098 @code{org-tags-match-list-sublevels}).
5101 These commands all prompt for a match string which allows basic Boolean logic
5102 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5103 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5104 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5105 string is rich and allows also matching against TODO keywords, entry levels
5106 and properties. For a complete description with many examples, see
5107 @ref{Matching tags and properties}.
5110 @node Properties and columns
5111 @chapter Properties and columns
5114 A property is a key-value pair associated with an entry. Properties can be
5115 set so they are associated with a single entry, with every entry in a tree,
5116 or with every entry in an Org mode file.
5118 There are two main applications for properties in Org mode. First,
5119 properties are like tags, but with a value. Imagine maintaining a file where
5120 you document bugs and plan releases for a piece of software. Instead of
5121 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5122 property, say @code{:Release:}, that in different subtrees has different
5123 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5124 implement (very basic) database capabilities in an Org buffer. Imagine
5125 keeping track of your music CDs, where properties could be things such as the
5126 album, artist, date of release, number of tracks, and so on.
5128 Properties can be conveniently edited and viewed in column view
5129 (@pxref{Column view}).
5132 * Property syntax:: How properties are spelled out
5133 * Special properties:: Access to other Org mode features
5134 * Property searches:: Matching property values
5135 * Property inheritance:: Passing values down the tree
5136 * Column view:: Tabular viewing and editing
5137 * Property API:: Properties for Lisp programmers
5140 @node Property syntax
5141 @section Property syntax
5142 @cindex property syntax
5143 @cindex drawer, for properties
5145 Properties are key-value pairs. When they are associated with a single entry
5146 or with a tree they need to be inserted into a special
5147 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
5148 is specified on a single line, with the key (surrounded by colons)
5149 first, and the value after it. Here is an example:
5154 *** Goldberg Variations
5156 :Title: Goldberg Variations
5157 :Composer: J.S. Bach
5159 :Publisher: Deutsche Grammophon
5164 Depending on the value of @code{org-use-property-inheritance}, a property set
5165 this way will either be associated with a single entry, or the subtree
5166 defined by the entry, see @ref{Property inheritance}.
5168 You may define the allowed values for a particular property @samp{:Xyz:}
5169 by setting a property @samp{:Xyz_ALL:}. This special property is
5170 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5171 the entire tree. When allowed values are defined, setting the
5172 corresponding property becomes easier and is less prone to typing
5173 errors. For the example with the CD collection, we can predefine
5174 publishers and the number of disks in a box like this:
5179 :NDisks_ALL: 1 2 3 4
5180 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5184 If you want to set properties that can be inherited by any entry in a
5185 file, use a line like
5186 @cindex property, _ALL
5189 #+PROPERTY: NDisks_ALL 1 2 3 4
5192 Contrary to properties set from a special drawer, you have to refresh the
5193 buffer with @kbd{C-c C-c} to activate this change.
5195 If you want to add to the value of an existing property, append a @code{+} to
5196 the property name. The following results in the property @code{var} having
5197 the value ``foo=1 bar=2''.
5200 #+PROPERTY: var foo=1
5201 #+PROPERTY: var+ bar=2
5204 It is also possible to add to the values of inherited properties. The
5205 following results in the @code{genres} property having the value ``Classic
5206 Baroque'' under the @code{Goldberg Variations} subtree.
5214 *** Goldberg Variations
5216 :Title: Goldberg Variations
5217 :Composer: J.S. Bach
5219 :Publisher: Deutsche Grammophon
5224 Note that a property can only have one entry per Drawer.
5226 @vindex org-global-properties
5227 Property values set with the global variable
5228 @code{org-global-properties} can be inherited by all entries in all
5232 The following commands help to work with properties:
5235 @orgcmd{M-@key{TAB},pcomplete}
5236 After an initial colon in a line, complete property keys. All keys used
5237 in the current file will be offered as possible completions.
5238 @orgcmd{C-c C-x p,org-set-property}
5239 Set a property. This prompts for a property name and a value. If
5240 necessary, the property drawer is created as well.
5241 @item C-u M-x org-insert-drawer RET
5242 @cindex org-insert-drawer
5243 Insert a property drawer into the current entry. The drawer will be
5244 inserted early in the entry, but after the lines with planning
5245 information like deadlines.
5246 @orgcmd{C-c C-c,org-property-action}
5247 With the cursor in a property drawer, this executes property commands.
5248 @orgcmd{C-c C-c s,org-set-property}
5249 Set a property in the current entry. Both the property and the value
5250 can be inserted using completion.
5251 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5252 Switch property at point to the next/previous allowed value.
5253 @orgcmd{C-c C-c d,org-delete-property}
5254 Remove a property from the current entry.
5255 @orgcmd{C-c C-c D,org-delete-property-globally}
5256 Globally remove a property, from all entries in the current file.
5257 @orgcmd{C-c C-c c,org-compute-property-at-point}
5258 Compute the property at point, using the operator and scope from the
5259 nearest column format definition.
5262 @node Special properties
5263 @section Special properties
5264 @cindex properties, special
5266 Special properties provide an alternative access method to Org mode features,
5267 like the TODO state or the priority of an entry, discussed in the previous
5268 chapters. This interface exists so that you can include these states in a
5269 column view (@pxref{Column view}), or to use them in queries. The following
5270 property names are special and (except for @code{:CATEGORY:}) should not be
5271 used as keys in the properties drawer:
5273 @cindex property, special, ID
5274 @cindex property, special, TODO
5275 @cindex property, special, TAGS
5276 @cindex property, special, ALLTAGS
5277 @cindex property, special, CATEGORY
5278 @cindex property, special, PRIORITY
5279 @cindex property, special, DEADLINE
5280 @cindex property, special, SCHEDULED
5281 @cindex property, special, CLOSED
5282 @cindex property, special, TIMESTAMP
5283 @cindex property, special, TIMESTAMP_IA
5284 @cindex property, special, CLOCKSUM
5285 @cindex property, special, CLOCKSUM_T
5286 @cindex property, special, BLOCKED
5287 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5288 @cindex property, special, ITEM
5289 @cindex property, special, FILE
5291 ID @r{A globally unique ID used for synchronization during}
5292 @r{iCalendar or MobileOrg export.}
5293 TODO @r{The TODO keyword of the entry.}
5294 TAGS @r{The tags defined directly in the headline.}
5295 ALLTAGS @r{All tags, including inherited ones.}
5296 CATEGORY @r{The category of an entry.}
5297 PRIORITY @r{The priority of the entry, a string with a single letter.}
5298 DEADLINE @r{The deadline time string, without the angular brackets.}
5299 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5300 CLOSED @r{When was this entry closed?}
5301 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5302 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5303 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5304 @r{must be run first to compute the values in the current buffer.}
5305 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5306 @r{@code{org-clock-sum-today} must be run first to compute the}
5307 @r{values in the current buffer.}
5308 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5309 ITEM @r{The headline of the entry.}
5310 FILE @r{The filename the entry is located in.}
5313 @node Property searches
5314 @section Property searches
5315 @cindex properties, searching
5316 @cindex searching, of properties
5318 To create sparse trees and special lists with selection based on properties,
5319 the same commands are used as for tag searches (@pxref{Tag searches}).
5322 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5323 Create a sparse tree with all matching entries. With a
5324 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5325 @orgcmd{C-c a m,org-tags-view}
5326 Create a global list of tag/property matches from all agenda files.
5327 @xref{Matching tags and properties}.
5328 @orgcmd{C-c a M,org-tags-view}
5329 @vindex org-tags-match-list-sublevels
5330 Create a global list of tag matches from all agenda files, but check
5331 only TODO items and force checking of subitems (see the option
5332 @code{org-tags-match-list-sublevels}).
5335 The syntax for the search string is described in @ref{Matching tags and
5338 There is also a special command for creating sparse trees based on a
5343 Create a sparse tree based on the value of a property. This first
5344 prompts for the name of a property, and then for a value. A sparse tree
5345 is created with all entries that define this property with the given
5346 value. If you enclose the value in curly braces, it is interpreted as
5347 a regular expression and matched against the property values.
5350 @node Property inheritance
5351 @section Property Inheritance
5352 @cindex properties, inheritance
5353 @cindex inheritance, of properties
5355 @vindex org-use-property-inheritance
5356 The outline structure of Org mode documents lends itself to an
5357 inheritance model of properties: if the parent in a tree has a certain
5358 property, the children can inherit this property. Org mode does not
5359 turn this on by default, because it can slow down property searches
5360 significantly and is often not needed. However, if you find inheritance
5361 useful, you can turn it on by setting the variable
5362 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5363 all properties inherited from the parent, to a list of properties
5364 that should be inherited, or to a regular expression that matches
5365 inherited properties. If a property has the value @code{nil}, this is
5366 interpreted as an explicit undefine of the property, so that inheritance
5367 search will stop at this value and return @code{nil}.
5369 Org mode has a few properties for which inheritance is hard-coded, at
5370 least for the special applications for which they are used:
5372 @cindex property, COLUMNS
5375 The @code{:COLUMNS:} property defines the format of column view
5376 (@pxref{Column view}). It is inherited in the sense that the level
5377 where a @code{:COLUMNS:} property is defined is used as the starting
5378 point for a column view table, independently of the location in the
5379 subtree from where columns view is turned on.
5381 @cindex property, CATEGORY
5382 For agenda view, a category set through a @code{:CATEGORY:} property
5383 applies to the entire subtree.
5385 @cindex property, ARCHIVE
5386 For archiving, the @code{:ARCHIVE:} property may define the archive
5387 location for the entire subtree (@pxref{Moving subtrees}).
5389 @cindex property, LOGGING
5390 The LOGGING property may define logging settings for an entry or a
5391 subtree (@pxref{Tracking TODO state changes}).
5395 @section Column view
5397 A great way to view and edit properties in an outline tree is
5398 @emph{column view}. In column view, each outline node is turned into a
5399 table row. Columns in this table provide access to properties of the
5400 entries. Org mode implements columns by overlaying a tabular structure
5401 over the headline of each item. While the headlines have been turned
5402 into a table row, you can still change the visibility of the outline
5403 tree. For example, you get a compact table by switching to CONTENTS
5404 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5405 is active), but you can still open, read, and edit the entry below each
5406 headline. Or, you can switch to column view after executing a sparse
5407 tree command and in this way get a table only for the selected items.
5408 Column view also works in agenda buffers (@pxref{Agenda views}) where
5409 queries have collected selected items, possibly from a number of files.
5412 * Defining columns:: The COLUMNS format property
5413 * Using column view:: How to create and use column view
5414 * Capturing column view:: A dynamic block for column view
5417 @node Defining columns
5418 @subsection Defining columns
5419 @cindex column view, for properties
5420 @cindex properties, column view
5422 Setting up a column view first requires defining the columns. This is
5423 done by defining a column format line.
5426 * Scope of column definitions:: Where defined, where valid?
5427 * Column attributes:: Appearance and content of a column
5430 @node Scope of column definitions
5431 @subsubsection Scope of column definitions
5433 To define a column format for an entire file, use a line like
5437 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5440 To specify a format that only applies to a specific tree, add a
5441 @code{:COLUMNS:} property to the top node of that tree, for example:
5444 ** Top node for columns view
5446 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5450 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5451 for the entry itself, and for the entire subtree below it. Since the
5452 column definition is part of the hierarchical structure of the document,
5453 you can define columns on level 1 that are general enough for all
5454 sublevels, and more specific columns further down, when you edit a
5455 deeper part of the tree.
5457 @node Column attributes
5458 @subsubsection Column attributes
5459 A column definition sets the attributes of a column. The general
5460 definition looks like this:
5463 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5467 Except for the percent sign and the property name, all items are
5468 optional. The individual parts have the following meaning:
5471 @var{width} @r{An integer specifying the width of the column in characters.}
5472 @r{If omitted, the width will be determined automatically.}
5473 @var{property} @r{The property that should be edited in this column.}
5474 @r{Special properties representing meta data are allowed here}
5475 @r{as well (@pxref{Special properties})}
5476 @var{title} @r{The header text for the column. If omitted, the property}
5478 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5479 @r{parent nodes are computed from the children.}
5480 @r{Supported summary types are:}
5481 @{+@} @r{Sum numbers in this column.}
5482 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5483 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5484 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5485 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5486 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5487 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5488 @{min@} @r{Smallest number in column.}
5489 @{max@} @r{Largest number.}
5490 @{mean@} @r{Arithmetic mean of numbers.}
5491 @{:min@} @r{Smallest time value in column.}
5492 @{:max@} @r{Largest time value.}
5493 @{:mean@} @r{Arithmetic mean of time values.}
5494 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5495 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5496 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5497 @{est+@} @r{Add low-high estimates.}
5501 Be aware that you can only have one summary type for any property you
5502 include. Subsequent columns referencing the same property will all display the
5503 same summary information.
5505 The @code{est+} summary type requires further explanation. It is used for
5506 combining estimates, expressed as low-high ranges. For example, instead
5507 of estimating a particular task will take 5 days, you might estimate it as
5508 5--6 days if you're fairly confident you know how much work is required, or
5509 1--10 days if you don't really know what needs to be done. Both ranges
5510 average at 5.5 days, but the first represents a more predictable delivery.
5512 When combining a set of such estimates, simply adding the lows and highs
5513 produces an unrealistically wide result. Instead, @code{est+} adds the
5514 statistical mean and variance of the sub-tasks, generating a final estimate
5515 from the sum. For example, suppose you had ten tasks, each of which was
5516 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5517 of 5 to 20 days, representing what to expect if everything goes either
5518 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5519 full job more realistically, at 10--15 days.
5521 Numbers are right-aligned when a format specifier with an explicit width like
5522 @code{%5d} or @code{%5.1f} is used.
5524 Here is an example for a complete columns definition, along with allowed
5528 :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.}
5529 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5530 :Owner_ALL: Tammy Mark Karl Lisa Don
5531 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5532 :Approved_ALL: "[ ]" "[X]"
5536 The first column, @samp{%25ITEM}, means the first 25 characters of the
5537 item itself, i.e., of the headline. You probably always should start the
5538 column definition with the @samp{ITEM} specifier. The other specifiers
5539 create columns @samp{Owner} with a list of names as allowed values, for
5540 @samp{Status} with four different possible values, and for a checkbox
5541 field @samp{Approved}. When no width is given after the @samp{%}
5542 character, the column will be exactly as wide as it needs to be in order
5543 to fully display all values. The @samp{Approved} column does have a
5544 modified title (@samp{Approved?}, with a question mark). Summaries will
5545 be created for the @samp{Time_Estimate} column by adding time duration
5546 expressions like HH:MM, and for the @samp{Approved} column, by providing
5547 an @samp{[X]} status if all children have been checked. The
5548 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5549 sums of CLOCK intervals in the subtree, either for all clocks or just for
5552 @node Using column view
5553 @subsection Using column view
5556 @tsubheading{Turning column view on and off}
5557 @orgcmd{C-c C-x C-c,org-columns}
5558 @vindex org-columns-default-format
5559 Turn on column view. If the cursor is before the first headline in the file,
5560 column view is turned on for the entire file, using the @code{#+COLUMNS}
5561 definition. If the cursor is somewhere inside the outline, this command
5562 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5563 defines a format. When one is found, the column view table is established
5564 for the tree starting at the entry that contains the @code{:COLUMNS:}
5565 property. If no such property is found, the format is taken from the
5566 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5567 and column view is established for the current entry and its subtree.
5568 @orgcmd{r,org-columns-redo}
5569 Recreate the column view, to include recent changes made in the buffer.
5570 @orgcmd{g,org-columns-redo}
5572 @orgcmd{q,org-columns-quit}
5574 @tsubheading{Editing values}
5575 @item @key{left} @key{right} @key{up} @key{down}
5576 Move through the column view from field to field.
5577 @kindex S-@key{left}
5578 @kindex S-@key{right}
5579 @item S-@key{left}/@key{right}
5580 Switch to the next/previous allowed value of the field. For this, you
5581 have to have specified allowed values for a property.
5583 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5584 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5585 Same as @kbd{S-@key{left}/@key{right}}
5586 @orgcmd{e,org-columns-edit-value}
5587 Edit the property at point. For the special properties, this will
5588 invoke the same interface that you normally use to change that
5589 property. For example, when editing a TAGS property, the tag completion
5590 or fast selection interface will pop up.
5591 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5592 When there is a checkbox at point, toggle it.
5593 @orgcmd{v,org-columns-show-value}
5594 View the full value of this property. This is useful if the width of
5595 the column is smaller than that of the value.
5596 @orgcmd{a,org-columns-edit-allowed}
5597 Edit the list of allowed values for this property. If the list is found
5598 in the hierarchy, the modified value is stored there. If no list is
5599 found, the new value is stored in the first entry that is part of the
5600 current column view.
5601 @tsubheading{Modifying the table structure}
5602 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5603 Make the column narrower/wider by one character.
5604 @orgcmd{S-M-@key{right},org-columns-new}
5605 Insert a new column, to the left of the current column.
5606 @orgcmd{S-M-@key{left},org-columns-delete}
5607 Delete the current column.
5610 @node Capturing column view
5611 @subsection Capturing column view
5613 Since column view is just an overlay over a buffer, it cannot be
5614 exported or printed directly. If you want to capture a column view, use
5615 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5616 of this block looks like this:
5618 @cindex #+BEGIN, columnview
5621 #+BEGIN: columnview :hlines 1 :id "label"
5626 @noindent This dynamic block has the following parameters:
5630 This is the most important parameter. Column view is a feature that is
5631 often localized to a certain (sub)tree, and the capture block might be
5632 at a different location in the file. To identify the tree whose view to
5633 capture, you can use 4 values:
5634 @cindex property, ID
5636 local @r{use the tree in which the capture block is located}
5637 global @r{make a global view, including all headings in the file}
5638 "file:@var{path-to-file}"
5639 @r{run column view at the top of this file}
5640 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5641 @r{property with the value @i{label}. You can use}
5642 @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5643 @r{the current entry and copy it to the kill-ring.}
5646 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5647 an hline before each headline with level @code{<= @var{N}}.
5649 When set to @code{t}, force column groups to get vertical lines.
5651 When set to a number, don't capture entries below this level.
5652 @item :skip-empty-rows
5653 When set to @code{t}, skip rows where the only non-empty specifier of the
5654 column view is @code{ITEM}.
5659 The following commands insert or update the dynamic block:
5662 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5663 Insert a dynamic block capturing a column view. You will be prompted
5664 for the scope or ID of the view.
5665 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5666 Update dynamic block at point. The cursor needs to be in the
5667 @code{#+BEGIN} line of the dynamic block.
5668 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5669 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5670 you have several clock table blocks, column-capturing blocks or other dynamic
5674 You can add formulas to the column view table and you may add plotting
5675 instructions in front of the table---these will survive an update of the
5676 block. If there is a @code{#+TBLFM:} after the table, the table will
5677 actually be recalculated automatically after an update.
5679 An alternative way to capture and process property values into a table is
5680 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5681 package@footnote{Contributed packages are not part of Emacs, but are
5682 distributed with the main distribution of Org (visit
5683 @uref{http://orgmode.org}).}. It provides a general API to collect
5684 properties from entries in a certain scope, and arbitrary Lisp expressions to
5685 process these values before inserting them into a table or a dynamic block.
5688 @section The Property API
5689 @cindex properties, API
5690 @cindex API, for properties
5692 There is a full API for accessing and changing properties. This API can
5693 be used by Emacs Lisp programs to work with properties and to implement
5694 features based on them. For more information see @ref{Using the
5697 @node Dates and times
5698 @chapter Dates and times
5704 To assist project planning, TODO items can be labeled with a date and/or
5705 a time. The specially formatted string carrying the date and time
5706 information is called a @emph{timestamp} in Org mode. This may be a
5707 little confusing because timestamp is often used to indicate when
5708 something was created or last changed. However, in Org mode this term
5709 is used in a much wider sense.
5712 * Timestamps:: Assigning a time to a tree entry
5713 * Creating timestamps:: Commands which insert timestamps
5714 * Deadlines and scheduling:: Planning your work
5715 * Clocking work time:: Tracking how long you spend on a task
5716 * Effort estimates:: Planning work effort in advance
5717 * Relative timer:: Notes with a running timer
5718 * Countdown timer:: Starting a countdown timer for a task
5723 @section Timestamps, deadlines, and scheduling
5725 @cindex ranges, time
5730 A timestamp is a specification of a date (possibly with a time or a range of
5731 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5732 simplest form, the day name is optional when you type the date yourself.
5733 However, any dates inserted or modified by Org will add that day name, for
5734 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5735 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5736 date/time format. To use an alternative format, see @ref{Custom time
5737 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5738 tree entry. Its presence causes entries to be shown on specific dates in the
5739 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5742 @item Plain timestamp; Event; Appointment
5745 A simple timestamp just assigns a date/time to an item. This is just
5746 like writing down an appointment or event in a paper agenda. In the
5747 timeline and agenda displays, the headline of an entry associated with a
5748 plain timestamp will be shown exactly on that date.
5751 * Meet Peter at the movies
5752 <2006-11-01 Wed 19:15>
5753 * Discussion on climate change
5754 <2006-11-02 Thu 20:00-22:00>
5757 @item Timestamp with repeater interval
5758 @cindex timestamp, with repeater interval
5759 A timestamp may contain a @emph{repeater interval}, indicating that it
5760 applies not only on the given date, but again and again after a certain
5761 interval of N days (d), weeks (w), months (m), or years (y). The
5762 following will show up in the agenda every Wednesday:
5765 * Pick up Sam at school
5766 <2007-05-16 Wed 12:30 +1w>
5769 @item Diary-style sexp entries
5770 For more complex date specifications, Org mode supports using the special
5771 sexp diary entries implemented in the Emacs calendar/diary
5772 package@footnote{When working with the standard diary sexp functions, you
5773 need to be very careful with the order of the arguments. That order depends
5774 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5775 versions, @code{european-calendar-style}). For example, to specify a date
5776 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5777 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5778 the settings. This has been the source of much confusion. Org mode users
5779 can resort to special versions of these functions like @code{org-date} or
5780 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5781 functions, but with stable ISO order of arguments (year, month, day) wherever
5782 applicable, independent of the value of @code{calendar-date-style}.}. For
5783 example with optional time
5786 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5787 <%%(diary-float t 4 2)>
5790 @item Time/Date range
5793 Two timestamps connected by @samp{--} denote a range. The headline
5794 will be shown on the first and last day of the range, and on any dates
5795 that are displayed and fall in the range. Here is an example:
5798 ** Meeting in Amsterdam
5799 <2004-08-23 Mon>--<2004-08-26 Thu>
5802 @item Inactive timestamp
5803 @cindex timestamp, inactive
5804 @cindex inactive timestamp
5805 Just like a plain timestamp, but with square brackets instead of
5806 angular ones. These timestamps are inactive in the sense that they do
5807 @emph{not} trigger an entry to show up in the agenda.
5810 * Gillian comes late for the fifth time
5816 @node Creating timestamps
5817 @section Creating timestamps
5818 @cindex creating timestamps
5819 @cindex timestamps, creating
5821 For Org mode to recognize timestamps, they need to be in the specific
5822 format. All commands listed below produce timestamps in the correct
5826 @orgcmd{C-c .,org-time-stamp}
5827 Prompt for a date and insert a corresponding timestamp. When the cursor is
5828 at an existing timestamp in the buffer, the command is used to modify this
5829 timestamp instead of inserting a new one. When this command is used twice in
5830 succession, a time range is inserted.
5832 @orgcmd{C-c !,org-time-stamp-inactive}
5833 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5840 @vindex org-time-stamp-rounding-minutes
5841 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5842 contains date and time. The default time can be rounded to multiples of 5
5843 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5846 Normalize timestamp, insert/fix day name if missing or wrong.
5848 @orgcmd{C-c <,org-date-from-calendar}
5849 Insert a timestamp corresponding to the cursor date in the Calendar.
5851 @orgcmd{C-c >,org-goto-calendar}
5852 Access the Emacs calendar for the current date. If there is a
5853 timestamp in the current line, go to the corresponding date
5856 @orgcmd{C-c C-o,org-open-at-point}
5857 Access the agenda for the date given by the timestamp or -range at
5858 point (@pxref{Weekly/daily agenda}).
5860 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5861 Change date at cursor by one day. These key bindings conflict with
5862 shift-selection and related modes (@pxref{Conflicts}).
5864 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5865 Change the item under the cursor in a timestamp. The cursor can be on a
5866 year, month, day, hour or minute. When the timestamp contains a time range
5867 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5868 shifting the time block with constant length. To change the length, modify
5869 the second time. Note that if the cursor is in a headline and not at a
5870 timestamp, these same keys modify the priority of an item.
5871 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5872 related modes (@pxref{Conflicts}).
5874 @orgcmd{C-c C-y,org-evaluate-time-range}
5875 @cindex evaluate time range
5876 Evaluate a time range by computing the difference between start and end.
5877 With a prefix argument, insert result after the time range (in a table: into
5878 the following column).
5883 * The date/time prompt:: How Org mode helps you entering date and time
5884 * Custom time format:: Making dates look different
5887 @node The date/time prompt
5888 @subsection The date/time prompt
5889 @cindex date, reading in minibuffer
5890 @cindex time, reading in minibuffer
5892 @vindex org-read-date-prefer-future
5893 When Org mode prompts for a date/time, the default is shown in default
5894 date/time format, and the prompt therefore seems to ask for a specific
5895 format. But it will in fact accept date/time information in a variety of
5896 formats. Generally, the information should start at the beginning of the
5897 string. Org mode will find whatever information is in
5898 there and derive anything you have not specified from the @emph{default date
5899 and time}. The default is usually the current date and time, but when
5900 modifying an existing timestamp, or when entering the second stamp of a
5901 range, it is taken from the stamp in the buffer. When filling in
5902 information, Org mode assumes that most of the time you will want to enter a
5903 date in the future: if you omit the month/year and the given day/month is
5904 @i{before} today, it will assume that you mean a future date@footnote{See the
5905 variable @code{org-read-date-prefer-future}. You may set that variable to
5906 the symbol @code{time} to even make a time before now shift the date to
5907 tomorrow.}. If the date has been automatically shifted into the future, the
5908 time prompt will show this with @samp{(=>F).}
5910 For example, let's assume that today is @b{June 13, 2006}. Here is how
5911 various inputs will be interpreted, the items filled in by Org mode are
5915 3-2-5 @result{} 2003-02-05
5916 2/5/3 @result{} 2003-02-05
5917 14 @result{} @b{2006}-@b{06}-14
5918 12 @result{} @b{2006}-@b{07}-12
5919 2/5 @result{} @b{2007}-02-05
5920 Fri @result{} nearest Friday after the default date
5921 sep 15 @result{} @b{2006}-09-15
5922 feb 15 @result{} @b{2007}-02-15
5923 sep 12 9 @result{} 2009-09-12
5924 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5925 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5926 w4 @result{} ISO week for of the current year @b{2006}
5927 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5928 2012-w04-5 @result{} Same as above
5931 Furthermore you can specify a relative date by giving, as the @emph{first}
5932 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5933 indicate change in hours, days, weeks, months, or years. With a single plus
5934 or minus, the date is always relative to today. With a double plus or minus,
5935 it is relative to the default date. If instead of a single letter, you use
5936 the abbreviation of day name, the date will be the Nth such day, e.g.:
5941 +4d @result{} four days from today
5942 +4 @result{} same as above
5943 +2w @result{} two weeks from today
5944 ++5 @result{} five days from default date
5945 +2tue @result{} second Tuesday from now
5946 -wed @result{} last Wednesday
5949 @vindex parse-time-months
5950 @vindex parse-time-weekdays
5951 The function understands English month and weekday abbreviations. If
5952 you want to use unabbreviated names and/or other languages, configure
5953 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5955 @vindex org-read-date-force-compatible-dates
5956 Not all dates can be represented in a given Emacs implementation. By default
5957 Org mode forces dates into the compatibility range 1970--2037 which works on
5958 all Emacs implementations. If you want to use dates outside of this range,
5959 read the docstring of the variable
5960 @code{org-read-date-force-compatible-dates}.
5962 You can specify a time range by giving start and end times or by giving a
5963 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5964 separator in the former case and use '+' as the separator in the latter
5968 11am-1:15pm @result{} 11:00-13:15
5969 11am--1:15pm @result{} same as above
5970 11am+2:15 @result{} same as above
5973 @cindex calendar, for selecting date
5974 @vindex org-popup-calendar-for-date-prompt
5975 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5976 you don't need/want the calendar, configure the variable
5977 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5978 prompt, either by clicking on a date in the calendar, or by pressing
5979 @key{RET}, the date selected in the calendar will be combined with the
5980 information entered at the prompt. You can control the calendar fully
5981 from the minibuffer:
5988 @kindex S-@key{right}
5989 @kindex S-@key{left}
5990 @kindex S-@key{down}
5992 @kindex M-S-@key{right}
5993 @kindex M-S-@key{left}
5996 @key{RET} @r{Choose date at cursor in calendar.}
5997 mouse-1 @r{Select date by clicking on it.}
5998 S-@key{right}/@key{left} @r{One day forward/backward.}
5999 S-@key{down}/@key{up} @r{One week forward/backward.}
6000 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6001 > / < @r{Scroll calendar forward/backward by one month.}
6002 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
6005 @vindex org-read-date-display-live
6006 The actions of the date/time prompt may seem complex, but I assure you they
6007 will grow on you, and you will start getting annoyed by pretty much any other
6008 way of entering a date/time out there. To help you understand what is going
6009 on, the current interpretation of your input will be displayed live in the
6010 minibuffer@footnote{If you find this distracting, turn the display off with
6011 @code{org-read-date-display-live}.}.
6013 @node Custom time format
6014 @subsection Custom time format
6015 @cindex custom date/time format
6016 @cindex time format, custom
6017 @cindex date format, custom
6019 @vindex org-display-custom-times
6020 @vindex org-time-stamp-custom-formats
6021 Org mode uses the standard ISO notation for dates and times as it is
6022 defined in ISO 8601. If you cannot get used to this and require another
6023 representation of date and time to keep you happy, you can get it by
6024 customizing the options @code{org-display-custom-times} and
6025 @code{org-time-stamp-custom-formats}.
6028 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6029 Toggle the display of custom formats for dates and times.
6033 Org mode needs the default format for scanning, so the custom date/time
6034 format does not @emph{replace} the default format---instead it is put
6035 @emph{over} the default format using text properties. This has the
6036 following consequences:
6039 You cannot place the cursor onto a timestamp anymore, only before or
6042 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6043 each component of a timestamp. If the cursor is at the beginning of
6044 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6045 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6046 time will be changed by one minute.
6048 If the timestamp contains a range of clock times or a repeater, these
6049 will not be overlaid, but remain in the buffer as they were.
6051 When you delete a timestamp character-by-character, it will only
6052 disappear from the buffer after @emph{all} (invisible) characters
6053 belonging to the ISO timestamp have been removed.
6055 If the custom timestamp format is longer than the default and you are
6056 using dates in tables, table alignment will be messed up. If the custom
6057 format is shorter, things do work as expected.
6061 @node Deadlines and scheduling
6062 @section Deadlines and scheduling
6064 A timestamp may be preceded by special keywords to facilitate planning:
6068 @cindex DEADLINE keyword
6070 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6071 to be finished on that date.
6073 @vindex org-deadline-warning-days
6074 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6075 On the deadline date, the task will be listed in the agenda. In
6076 addition, the agenda for @emph{today} will carry a warning about the
6077 approaching or missed deadline, starting
6078 @code{org-deadline-warning-days} before the due date, and continuing
6079 until the entry is marked DONE@. An example:
6082 *** TODO write article about the Earth for the Guide
6083 DEADLINE: <2004-02-29 Sun>
6084 The editor in charge is [[bbdb:Ford Prefect]]
6087 You can specify a different lead time for warnings for a specific
6088 deadline using the following syntax. Here is an example with a warning
6089 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6090 deactivated if the task gets scheduled and you set
6091 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6094 @cindex SCHEDULED keyword
6096 Meaning: you are planning to start working on that task on the given
6099 @vindex org-agenda-skip-scheduled-if-done
6100 The headline will be listed under the given date@footnote{It will still
6101 be listed on that date after it has been marked DONE@. If you don't like
6102 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6103 addition, a reminder that the scheduled date has passed will be present
6104 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6105 the task will automatically be forwarded until completed.
6108 *** TODO Call Trillian for a date on New Years Eve.
6109 SCHEDULED: <2004-12-25 Sat>
6112 @vindex org-scheduled-delay-days
6113 @vindex org-agenda-skip-scheduled-delay-if-deadline
6114 If you want to @emph{delay} the display of this task in the agenda, use
6115 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6116 25th but will appear two days later. In case the task contains a repeater,
6117 the delay is considered to affect all occurrences; if you want the delay to
6118 only affect the first scheduled occurrence of the task, use @code{--2d}
6119 instead. See @code{org-scheduled-delay-days} and
6120 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6121 control this globally or per agenda.
6124 @b{Important:} Scheduling an item in Org mode should @i{not} be
6125 understood in the same way that we understand @i{scheduling a meeting}.
6126 Setting a date for a meeting is just a simple appointment, you should
6127 mark this entry with a simple plain timestamp, to get this item shown
6128 on the date where it applies. This is a frequent misunderstanding by
6129 Org users. In Org mode, @i{scheduling} means setting a date when you
6130 want to start working on an action item.
6133 You may use timestamps with repeaters in scheduling and deadline
6134 entries. Org mode will issue early and late warnings based on the
6135 assumption that the timestamp represents the @i{nearest instance} of
6136 the repeater. However, the use of diary sexp entries like
6138 @code{<%%(diary-float t 42)>}
6140 in scheduling and deadline timestamps is limited. Org mode does not
6141 know enough about the internals of each sexp function to issue early and
6142 late warnings. However, it will show the item on each day where the
6146 * Inserting deadline/schedule:: Planning items
6147 * Repeated tasks:: Items that show up again and again
6150 @node Inserting deadline/schedule
6151 @subsection Inserting deadlines or schedules
6153 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6154 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6155 any text between this line and the headline.} a deadline or to schedule
6160 @orgcmd{C-c C-d,org-deadline}
6161 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6162 in the line directly following the headline. Any CLOSED timestamp will be
6163 removed. When called with a prefix arg, an existing deadline will be removed
6164 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6165 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6166 and @code{nologredeadline}}, a note will be taken when changing an existing
6169 @orgcmd{C-c C-s,org-schedule}
6170 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6171 happen in the line directly following the headline. Any CLOSED timestamp
6172 will be removed. When called with a prefix argument, remove the scheduling
6173 date from the entry. Depending on the variable
6174 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6175 keywords @code{logreschedule}, @code{lognotereschedule}, and
6176 @code{nologreschedule}}, a note will be taken when changing an existing
6179 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
6182 Mark the current entry for agenda action. After you have marked the entry
6183 like this, you can open the agenda or the calendar to find an appropriate
6184 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
6185 schedule the marked item.
6187 @orgcmd{C-c / d,org-check-deadlines}
6188 @cindex sparse tree, for deadlines
6189 @vindex org-deadline-warning-days
6190 Create a sparse tree with all deadlines that are either past-due, or
6191 which will become due within @code{org-deadline-warning-days}.
6192 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6193 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6194 all deadlines due tomorrow.
6196 @orgcmd{C-c / b,org-check-before-date}
6197 Sparse tree for deadlines and scheduled items before a given date.
6199 @orgcmd{C-c / a,org-check-after-date}
6200 Sparse tree for deadlines and scheduled items after a given date.
6203 Note that @code{org-schedule} and @code{org-deadline} supports
6204 setting the date by indicating a relative time: e.g., +1d will set
6205 the date to the next day after today, and --1w will set the date
6206 to the previous week before any current timestamp.
6208 @node Repeated tasks
6209 @subsection Repeated tasks
6210 @cindex tasks, repeated
6211 @cindex repeated tasks
6213 Some tasks need to be repeated again and again. Org mode helps to
6214 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6215 or plain timestamp. In the following example
6217 ** TODO Pay the rent
6218 DEADLINE: <2005-10-01 Sat +1m>
6221 the @code{+1m} is a repeater; the intended interpretation is that the task
6222 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6223 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6224 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6225 and a special warning period in a deadline entry, the repeater should come
6226 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6228 @vindex org-todo-repeat-to-state
6229 Deadlines and scheduled items produce entries in the agenda when they are
6230 over-due, so it is important to be able to mark such an entry as completed
6231 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6232 keyword DONE, it will no longer produce entries in the agenda. The problem
6233 with this is, however, that then also the @emph{next} instance of the
6234 repeated entry will not be active. Org mode deals with this in the following
6235 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6236 shift the base date of the repeating timestamp by the repeater interval, and
6237 immediately set the entry state back to TODO@footnote{In fact, the target
6238 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6239 the variable @code{org-todo-repeat-to-state}. If neither of these is
6240 specified, the target state defaults to the first state of the TODO state
6241 sequence.}. In the example above, setting the state to DONE would actually
6242 switch the date like this:
6245 ** TODO Pay the rent
6246 DEADLINE: <2005-11-01 Tue +1m>
6249 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6250 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6252 @vindex org-log-repeat
6253 A timestamp@footnote{You can change this using the option
6254 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6255 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6256 will also be prompted for a note.} will be added under the deadline, to keep
6257 a record that you actually acted on the previous instance of this deadline.
6259 As a consequence of shifting the base date, this entry will no longer be
6260 visible in the agenda when checking past dates, but all future instances
6263 With the @samp{+1m} cookie, the date shift will always be exactly one
6264 month. So if you have not paid the rent for three months, marking this
6265 entry DONE will still keep it as an overdue deadline. Depending on the
6266 task, this may not be the best way to handle it. For example, if you
6267 forgot to call your father for 3 weeks, it does not make sense to call
6268 him 3 times in a single day to make up for it. Finally, there are tasks
6269 like changing batteries which should always repeat a certain time
6270 @i{after} the last time you did it. For these tasks, Org mode has
6271 special repeaters @samp{++} and @samp{.+}. For example:
6275 DEADLINE: <2008-02-10 Sun ++1w>
6276 Marking this DONE will shift the date by at least one week,
6277 but also by as many weeks as it takes to get this date into
6278 the future. However, it stays on a Sunday, even if you called
6279 and marked it done on Saturday.
6280 ** TODO Check the batteries in the smoke detectors
6281 DEADLINE: <2005-11-01 Tue .+1m>
6282 Marking this DONE will shift the date to one month after
6286 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6287 You may have both scheduling and deadline information for a specific task.
6288 If the repeater is set for the scheduling information only, you probably want
6289 the repeater to be ignored after the deadline. If so, set the variable
6290 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6291 @code{repeated-after-deadline}. If you want both scheduling and deadline
6292 information to repeat after the same interval, set the same repeater for both
6295 An alternative to using a repeater is to create a number of copies of a task
6296 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6297 created for this purpose, it is described in @ref{Structure editing}.
6300 @node Clocking work time
6301 @section Clocking work time
6302 @cindex clocking time
6303 @cindex time clocking
6305 Org mode allows you to clock the time you spend on specific tasks in a
6306 project. When you start working on an item, you can start the clock. When
6307 you stop working on that task, or when you mark the task done, the clock is
6308 stopped and the corresponding time interval is recorded. It also computes
6309 the total time spent on each subtree@footnote{Clocking only works if all
6310 headings are indented with less than 30 stars. This is a hardcoded
6311 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6312 history or tasks recently clocked, so that you can jump quickly between a
6313 number of tasks absorbing your time.
6315 To save the clock history across Emacs sessions, use
6317 (setq org-clock-persist 'history)
6318 (org-clock-persistence-insinuate)
6320 When you clock into a new task after resuming Emacs, the incomplete
6321 clock@footnote{To resume the clock under the assumption that you have worked
6322 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6323 will be found (@pxref{Resolving idle time}) and you will be prompted about
6327 * Clocking commands:: Starting and stopping a clock
6328 * The clock table:: Detailed reports
6329 * Resolving idle time:: Resolving time when you've been idle
6332 @node Clocking commands
6333 @subsection Clocking commands
6336 @orgcmd{C-c C-x C-i,org-clock-in}
6337 @vindex org-clock-into-drawer
6338 @vindex org-clock-continuously
6339 @cindex property, LOG_INTO_DRAWER
6340 Start the clock on the current item (clock-in). This inserts the CLOCK
6341 keyword together with a timestamp. If this is not the first clocking of
6342 this item, the multiple CLOCK lines will be wrapped into a
6343 @code{:LOGBOOK:} drawer (see also the variable
6344 @code{org-clock-into-drawer}). You can also overrule
6345 the setting of this variable for a subtree by setting a
6346 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6347 When called with a @kbd{C-u} prefix argument,
6348 select the task from a list of recently clocked tasks. With two @kbd{C-u
6349 C-u} prefixes, clock into the task at point and mark it as the default task;
6350 the default task will then always be available with letter @kbd{d} when
6351 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6352 continuous clocking by starting the clock when the last clock stopped.@*
6353 @cindex property: CLOCK_MODELINE_TOTAL
6354 @cindex property: LAST_REPEAT
6355 @vindex org-clock-modeline-total
6356 While the clock is running, the current clocking time is shown in the mode
6357 line, along with the title of the task. The clock time shown will be all
6358 time ever clocked for this task and its children. If the task has an effort
6359 estimate (@pxref{Effort estimates}), the mode line displays the current
6360 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6361 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6362 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6363 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6364 will be shown. More control over what time is shown can be exercised with
6365 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6366 @code{current} to show only the current clocking instance, @code{today} to
6367 show all time clocked on this tasks today (see also the variable
6368 @code{org-extend-today-until}), @code{all} to include all time, or
6369 @code{auto} which is the default@footnote{See also the variable
6370 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6371 mode line entry will pop up a menu with clocking options.
6373 @orgcmd{C-c C-x C-o,org-clock-out}
6374 @vindex org-log-note-clock-out
6375 Stop the clock (clock-out). This inserts another timestamp at the same
6376 location where the clock was last started. It also directly computes
6377 the resulting time and inserts it after the time range as @samp{=>
6378 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6379 possibility to record an additional note together with the clock-out
6380 timestamp@footnote{The corresponding in-buffer setting is:
6381 @code{#+STARTUP: lognoteclock-out}}.
6382 @orgcmd{C-c C-x C-x,org-clock-in-last}
6383 @vindex org-clock-continuously
6384 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6385 select the task from the clock history. With two @kbd{C-u} prefixes,
6386 force continuous clocking by starting the clock when the last clock
6388 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6389 Update the effort estimate for the current clock task.
6392 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6393 Recompute the time interval after changing one of the timestamps. This
6394 is only necessary if you edit the timestamps directly. If you change
6395 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6396 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6397 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6398 clock duration keeps the same.
6399 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6400 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6401 the one of the previous (or the next clock) timestamp by the same duration.
6402 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6403 by five minutes, then the clocked-in timestamp of the next clock will be
6404 increased by five minutes.
6405 @orgcmd{C-c C-t,org-todo}
6406 Changing the TODO state of an item to DONE automatically stops the clock
6407 if it is running in this same item.
6408 @orgcmd{C-c C-x C-q,org-clock-cancel}
6409 Cancel the current clock. This is useful if a clock was started by
6410 mistake, or if you ended up working on something else.
6411 @orgcmd{C-c C-x C-j,org-clock-goto}
6412 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6413 prefix arg, select the target task from a list of recently clocked tasks.
6414 @orgcmd{C-c C-x C-d,org-clock-display}
6415 @vindex org-remove-highlights-with-change
6416 Display time summaries for each subtree in the current buffer. This puts
6417 overlays at the end of each headline, showing the total time recorded under
6418 that heading, including the time of any subheadings. You can use visibility
6419 cycling to study the tree, but the overlays disappear when you change the
6420 buffer (see variable @code{org-remove-highlights-with-change}) or press
6424 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6425 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6426 worked on or closed during a day.
6428 @strong{Important:} note that both @code{org-clock-out} and
6429 @code{org-clock-in-last} can have a global keybinding and will not
6430 modify the window disposition.
6432 @node The clock table
6433 @subsection The clock table
6434 @cindex clocktable, dynamic block
6435 @cindex report, of clocked time
6437 Org mode can produce quite complex reports based on the time clocking
6438 information. Such a report is called a @emph{clock table}, because it is
6439 formatted as one or several Org tables.
6442 @orgcmd{C-c C-x C-r,org-clock-report}
6443 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6444 report as an Org mode table into the current file. When the cursor is
6445 at an existing clock table, just update it. When called with a prefix
6446 argument, jump to the first clock report in the current document and
6447 update it. The clock table always includes also trees with
6448 @code{:ARCHIVE:} tag.
6449 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6450 Update dynamic block at point. The cursor needs to be in the
6451 @code{#+BEGIN} line of the dynamic block.
6452 @orgkey{C-u C-c C-x C-u}
6453 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6454 you have several clock table blocks in a buffer.
6455 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6456 Shift the current @code{:block} interval and update the table. The cursor
6457 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6458 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6462 Here is an example of the frame for a clock table as it is inserted into the
6463 buffer with the @kbd{C-c C-x C-r} command:
6465 @cindex #+BEGIN, clocktable
6467 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6471 @vindex org-clocktable-defaults
6472 The @samp{BEGIN} line specifies a number of options to define the scope,
6473 structure, and formatting of the report. Defaults for all these options can
6474 be configured in the variable @code{org-clocktable-defaults}.
6476 @noindent First there are options that determine which clock entries are to
6479 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6480 @r{Clocks at deeper levels will be summed into the upper level.}
6481 :scope @r{The scope to consider. This can be any of the following:}
6482 nil @r{the current buffer or narrowed region}
6483 file @r{the full current buffer}
6484 subtree @r{the subtree where the clocktable is located}
6485 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6486 tree @r{the surrounding level 1 tree}
6487 agenda @r{all agenda files}
6488 ("file"..) @r{scan these files}
6489 file-with-archives @r{current file and its archives}
6490 agenda-with-archives @r{all agenda files, including archives}
6491 :block @r{The time block to consider. This block is specified either}
6492 @r{absolutely, or relative to the current time and may be any of}
6494 2007-12-31 @r{New year eve 2007}
6495 2007-12 @r{December 2007}
6496 2007-W50 @r{ISO-week 50 in 2007}
6497 2007-Q2 @r{2nd quarter in 2007}
6498 2007 @r{the year 2007}
6499 today, yesterday, today-@var{N} @r{a relative day}
6500 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6501 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6502 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6503 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6504 :tstart @r{A time string specifying when to start considering times.}
6505 @r{Relative times like @code{"<-2w>"} can also be used. See}
6506 @r{@ref{Matching tags and properties} for relative time syntax.}
6507 :tend @r{A time string specifying when to stop considering times.}
6508 @r{Relative times like @code{"<now>"} can also be used. See}
6509 @r{@ref{Matching tags and properties} for relative time syntax.}
6510 :wstart @r{The starting day of the week. The default is 1 for monday.}
6511 :mstart @r{The starting day of the month. The default 1 is for the first}
6512 @r{day of the month.}
6513 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6514 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6515 :stepskip0 @r{Do not show steps that have zero time.}
6516 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6517 :tags @r{A tags match to select entries that should contribute. See}
6518 @r{@ref{Matching tags and properties} for the match syntax.}
6521 Then there are options which determine the formatting of the table. These
6522 options are interpreted by the function @code{org-clocktable-write-default},
6523 but you can specify your own function using the @code{:formatter} parameter.
6525 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6526 :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".}
6527 :link @r{Link the item headlines in the table to their origins.}
6528 :narrow @r{An integer to limit the width of the headline column in}
6529 @r{the org table. If you write it like @samp{50!}, then the}
6530 @r{headline will also be shortened in export.}
6531 :indent @r{Indent each headline field according to its level.}
6532 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6533 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6534 :level @r{Should a level number column be included?}
6535 :sort @r{A cons cell like containing the column to sort and a sorting type.}
6536 @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6537 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6538 @r{All are overwritten except if there is an explicit @code{:narrow}}
6539 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6540 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6541 :properties @r{List of properties that should be shown in the table. Each}
6542 @r{property will get its own column.}
6543 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6544 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6545 @r{As a special case, @samp{:formula %} adds a column with % time.}
6546 @r{If you do not specify a formula here, any existing formula}
6547 @r{below the clock table will survive updates and be evaluated.}
6548 :formatter @r{A function to format clock data and insert it into the buffer.}
6550 To get a clock summary of the current level 1 tree, for the current
6551 day, you could write
6553 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6557 and to use a specific time range you could write@footnote{Note that all
6558 parameters must be specified in a single line---the line is broken here
6559 only to fit it into the manual.}
6561 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6562 :tend "<2006-08-10 Thu 12:00>"
6565 A range starting a week ago and ending right now could be written as
6567 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6570 A summary of the current subtree with % times would be
6572 #+BEGIN: clocktable :scope subtree :link t :formula %
6575 A horizontally compact representation of everything clocked during last week
6578 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6582 @node Resolving idle time
6583 @subsection Resolving idle time and continuous clocking
6585 @subsubheading Resolving idle time
6586 @cindex resolve idle time
6587 @vindex org-clock-x11idle-program-name
6589 @cindex idle, resolve, dangling
6590 If you clock in on a work item, and then walk away from your
6591 computer---perhaps to take a phone call---you often need to ``resolve'' the
6592 time you were away by either subtracting it from the current clock, or
6593 applying it to another one.
6595 @vindex org-clock-idle-time
6596 By customizing the variable @code{org-clock-idle-time} to some integer, such
6597 as 10 or 15, Emacs can alert you when you get back to your computer after
6598 being idle for that many minutes@footnote{On computers using Mac OS X,
6599 idleness is based on actual user idleness, not just Emacs' idle time. For
6600 X11, you can install a utility program @file{x11idle.c}, available in the
6601 @code{contrib/scripts} directory of the Org git distribution, or install the
6602 @file{xprintidle} package and set it to the variable
6603 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6604 same general treatment of idleness. On other systems, idle time refers to
6605 Emacs idle time only.}, and ask what you want to do with the idle time.
6606 There will be a question waiting for you when you get back, indicating how
6607 much idle time has passed (constantly updated with the current amount), as
6608 well as a set of choices to correct the discrepancy:
6612 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6613 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6614 effectively changing nothing, or enter a number to keep that many minutes.
6616 If you use the shift key and press @kbd{K}, it will keep however many minutes
6617 you request and then immediately clock out of that task. If you keep all of
6618 the minutes, this is the same as just clocking out of the current task.
6620 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6621 the clock, and then check back in from the moment you returned.
6623 To keep none of the minutes and just clock out at the start of the away time,
6624 use the shift key and press @kbd{S}. Remember that using shift will always
6625 leave you clocked out, no matter which option you choose.
6627 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6628 canceling you subtract the away time, and the resulting clock amount is less
6629 than a minute, the clock will still be canceled rather than clutter up the
6630 log with an empty entry.
6633 What if you subtracted those away minutes from the current clock, and now
6634 want to apply them to a new clock? Simply clock in to any task immediately
6635 after the subtraction. Org will notice that you have subtracted time ``on
6636 the books'', so to speak, and will ask if you want to apply those minutes to
6637 the next task you clock in on.
6639 There is one other instance when this clock resolution magic occurs. Say you
6640 were clocked in and hacking away, and suddenly your cat chased a mouse who
6641 scared a hamster that crashed into your UPS's power button! You suddenly
6642 lose all your buffers, but thanks to auto-save you still have your recent Org
6643 mode changes, including your last clock in.
6645 If you restart Emacs and clock into any task, Org will notice that you have a
6646 dangling clock which was never clocked out from your last session. Using
6647 that clock's starting time as the beginning of the unaccounted-for period,
6648 Org will ask how you want to resolve that time. The logic and behavior is
6649 identical to dealing with away time due to idleness; it is just happening due
6650 to a recovery event rather than a set amount of idle time.
6652 You can also check all the files visited by your Org agenda for dangling
6653 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6655 @subsubheading Continuous clocking
6656 @cindex continuous clocking
6657 @vindex org-clock-continuously
6659 You may want to start clocking from the time when you clocked out the
6660 previous task. To enable this systematically, set @code{org-clock-continuously}
6661 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6662 last clocked entry for this session, and start the new clock from there.
6664 If you only want this from time to time, use three universal prefix arguments
6665 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6667 @node Effort estimates
6668 @section Effort estimates
6669 @cindex effort estimates
6671 @cindex property, Effort
6672 @vindex org-effort-property
6673 If you want to plan your work in a very detailed way, or if you need to
6674 produce offers with quotations of the estimated work effort, you may want to
6675 assign effort estimates to entries. If you are also clocking your work, you
6676 may later want to compare the planned effort with the actual working time, a
6677 great way to improve planning estimates. Effort estimates are stored in a
6678 special property @samp{Effort}@footnote{You may change the property being
6679 used with the variable @code{org-effort-property}.}. You can set the effort
6680 for an entry with the following commands:
6683 @orgcmd{C-c C-x e,org-set-effort}
6684 Set the effort estimate for the current entry. With a numeric prefix
6685 argument, set it to the Nth allowed value (see below). This command is also
6686 accessible from the agenda with the @kbd{e} key.
6687 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6688 Modify the effort estimate of the item currently being clocked.
6691 Clearly the best way to work with effort estimates is through column view
6692 (@pxref{Column view}). You should start by setting up discrete values for
6693 effort estimates, and a @code{COLUMNS} format that displays these values
6694 together with clock sums (if you want to clock your time). For a specific
6698 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6699 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6703 @vindex org-global-properties
6704 @vindex org-columns-default-format
6705 or, even better, you can set up these values globally by customizing the
6706 variables @code{org-global-properties} and @code{org-columns-default-format}.
6707 In particular if you want to use this setup also in the agenda, a global
6708 setup may be advised.
6710 The way to assign estimates to individual items is then to switch to column
6711 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6712 value. The values you enter will immediately be summed up in the hierarchy.
6713 In the column next to it, any clocked time will be displayed.
6715 @vindex org-agenda-columns-add-appointments-to-effort-sum
6716 If you switch to column view in the daily/weekly agenda, the effort column
6717 will summarize the estimated work effort for each day@footnote{Please note
6718 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6719 column view}).}, and you can use this to find space in your schedule. To get
6720 an overview of the entire part of the day that is committed, you can set the
6721 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6722 appointments on a day that take place over a specified time interval will
6723 then also be added to the load estimate of the day.
6725 Effort estimates can be used in secondary agenda filtering that is triggered
6726 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6727 these estimates defined consistently, two or three key presses will narrow
6728 down the list to stuff that fits into an available time slot.
6730 @node Relative timer
6731 @section Taking notes with a relative timer
6732 @cindex relative timer
6734 When taking notes during, for example, a meeting or a video viewing, it can
6735 be useful to have access to times relative to a starting time. Org provides
6736 such a relative timer and make it easy to create timed notes.
6739 @orgcmd{C-c C-x .,org-timer}
6740 Insert a relative time into the buffer. The first time you use this, the
6741 timer will be started. When called with a prefix argument, the timer is
6743 @orgcmd{C-c C-x -,org-timer-item}
6744 Insert a description list item with the current relative time. With a prefix
6745 argument, first reset the timer to 0.
6746 @orgcmd{M-@key{RET},org-insert-heading}
6747 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6749 @c for key sequences with a comma, command name macros fail :(
6752 Pause the timer, or continue it if it is already paused
6753 (@command{org-timer-pause-or-continue}).
6754 @c removed the sentence because it is redundant to the following item
6755 @kindex C-u C-c C-x ,
6757 Stop the timer. After this, you can only start a new timer, not continue the
6758 old one. This command also removes the timer from the mode line.
6759 @orgcmd{C-c C-x 0,org-timer-start}
6760 Reset the timer without inserting anything into the buffer. By default, the
6761 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6762 specific starting offset. The user is prompted for the offset, with a
6763 default taken from a timer string at point, if any, So this can be used to
6764 restart taking notes after a break in the process. When called with a double
6765 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6766 by a certain amount. This can be used to fix timer strings if the timer was
6767 not started at exactly the right moment.
6770 @node Countdown timer
6771 @section Countdown timer
6772 @cindex Countdown timer
6776 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6777 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6779 @code{org-timer-set-timer} prompts the user for a duration and displays a
6780 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6781 default countdown value. Giving a prefix numeric argument overrides this
6784 @node Capture - Refile - Archive
6785 @chapter Capture - Refile - Archive
6788 An important part of any organization system is the ability to quickly
6789 capture new ideas and tasks, and to associate reference material with them.
6790 Org does this using a process called @i{capture}. It also can store files
6791 related to a task (@i{attachments}) in a special directory. Once in the
6792 system, tasks and projects need to be moved around. Moving completed project
6793 trees to an archive file keeps the system compact and fast.
6796 * Capture:: Capturing new stuff
6797 * Attachments:: Add files to tasks
6798 * RSS feeds:: Getting input from RSS feeds
6799 * Protocols:: External (e.g., Browser) access to Emacs and Org
6800 * Refile and copy:: Moving/copying a tree from one place to another
6801 * Archiving:: What to do with finished projects
6808 Capture lets you quickly store notes with little interruption of your work
6809 flow. Org's method for capturing new items is heavily inspired by John
6810 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6811 used a special setup for @file{remember.el}, then replaced it with
6812 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6813 been completely replaced by @file{org-capture.el}.
6815 If your configuration depends on @file{org-remember.el}, you need to update
6816 it and use the setup described below. To convert your
6817 @code{org-remember-templates}, run the command
6819 @kbd{M-x org-capture-import-remember-templates RET}
6821 @noindent and then customize the new variable with @kbd{M-x
6822 customize-variable org-capture-templates}, check the result, and save the
6826 * Setting up capture:: Where notes will be stored
6827 * Using capture:: Commands to invoke and terminate capture
6828 * Capture templates:: Define the outline of different note types
6831 @node Setting up capture
6832 @subsection Setting up capture
6834 The following customization sets a default target file for notes, and defines
6835 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6836 suggestion.} for capturing new material.
6838 @vindex org-default-notes-file
6841 (setq org-default-notes-file (concat org-directory "/notes.org"))
6842 (define-key global-map "\C-cc" 'org-capture)
6847 @subsection Using capture
6850 @orgcmd{C-c c,org-capture}
6851 Call the command @code{org-capture}. Note that this keybinding is global and
6852 not active by default: you need to install it. If you have templates
6854 defined @pxref{Capture templates}, it will offer these templates for
6855 selection or use a new Org outline node as the default template. It will
6856 insert the template into the target file and switch to an indirect buffer
6857 narrowed to this new node. You may then insert the information you want.
6859 @orgcmd{C-c C-c,org-capture-finalize}
6860 Once you have finished entering information into the capture buffer, @kbd{C-c
6861 C-c} will return you to the window configuration before the capture process,
6862 so that you can resume your work without further distraction. When called
6863 with a prefix arg, finalize and then jump to the captured item.
6865 @orgcmd{C-c C-w,org-capture-refile}
6866 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6867 a different place. Please realize that this is a normal refiling command
6868 that will be executed---so the cursor position at the moment you run this
6869 command is important. If you have inserted a tree with a parent and
6870 children, first move the cursor back to the parent. Any prefix argument
6871 given to this command will be passed on to the @code{org-refile} command.
6873 @orgcmd{C-c C-k,org-capture-kill}
6874 Abort the capture process and return to the previous state.
6878 You can also call @code{org-capture} in a special way from the agenda, using
6879 the @kbd{k c} key combination. With this access, any timestamps inserted by
6880 the selected capture template will default to the cursor date in the agenda,
6881 rather than to the current date.
6883 To find the locations of the last stored capture, use @code{org-capture} with
6888 Visit the target location of a capture template. You get to select the
6889 template in the usual way.
6890 @orgkey{C-u C-u C-c c}
6891 Visit the last stored capture item in its buffer.
6894 @vindex org-capture-bookmark
6895 @cindex org-capture-last-stored
6896 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6897 automatically be created unless you set @code{org-capture-bookmark} to
6900 To insert the capture at point in an Org buffer, call @code{org-capture} with
6901 a @code{C-0} prefix argument.
6903 @node Capture templates
6904 @subsection Capture templates
6905 @cindex templates, for Capture
6907 You can use templates for different types of capture items, and
6908 for different target locations. The easiest way to create such templates is
6909 through the customize interface.
6913 Customize the variable @code{org-capture-templates}.
6916 Before we give the formal description of template definitions, let's look at
6917 an example. Say you would like to use one template to create general TODO
6918 entries, and you want to put these entries under the heading @samp{Tasks} in
6919 your file @file{~/org/gtd.org}. Also, a date tree in the file
6920 @file{journal.org} should capture journal entries. A possible configuration
6925 (setq org-capture-templates
6926 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6927 "* TODO %?\n %i\n %a")
6928 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6929 "* %?\nEntered on %U\n %i\n %a")))
6933 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6937 [[file:@var{link to where you initiated capture}]]
6941 During expansion of the template, @code{%a} has been replaced by a link to
6942 the location from where you called the capture command. This can be
6943 extremely useful for deriving tasks from emails, for example. You fill in
6944 the task definition, press @kbd{C-c C-c} and Org returns you to the same
6945 place where you started the capture process.
6947 To define special keys to capture to a particular template without going
6948 through the interactive template selection, you can create your key binding
6952 (define-key global-map "\C-cx"
6953 (lambda () (interactive) (org-capture nil "x")))
6957 * Template elements:: What is needed for a complete template entry
6958 * Template expansion:: Filling in information about time and context
6959 * Templates in contexts:: Only show a template in a specific context
6962 @node Template elements
6963 @subsubsection Template elements
6965 Now lets look at the elements of a template definition. Each entry in
6966 @code{org-capture-templates} is a list with the following items:
6970 The keys that will select the template, as a string, characters
6971 only, for example @code{"a"} for a template to be selected with a
6972 single key, or @code{"bt"} for selection with two keys. When using
6973 several keys, keys using the same prefix key must be sequential
6974 in the list and preceded by a 2-element entry explaining the
6975 prefix key, for example
6977 ("b" "Templates for marking stuff to buy")
6979 @noindent If you do not define a template for the @kbd{C} key, this key will
6980 be used to open the customize buffer for this complex variable.
6983 A short string describing the template, which will be shown during
6987 The type of entry, a symbol. Valid values are:
6991 An Org mode node, with a headline. Will be filed as the child of the target
6992 entry or as a top-level entry. The target file should be an Org mode file.
6994 A plain list item, placed in the first plain list at the target
6995 location. Again the target file should be an Org file.
6997 A checkbox item. This only differs from the plain list item by the
7000 a new line in the first table at the target location. Where exactly the
7001 line will be inserted depends on the properties @code{:prepend} and
7002 @code{:table-line-pos} (see below).
7004 Text to be inserted as it is.
7008 @vindex org-default-notes-file
7009 Specification of where the captured item should be placed. In Org mode
7010 files, targets usually define a node. Entries will become children of this
7011 node. Other types will be added to the table or list in the body of this
7012 node. Most target specifications contain a file name. If that file name is
7013 the empty string, it defaults to @code{org-default-notes-file}. A file can
7014 also be given as a variable, function, or Emacs Lisp form.
7019 @item (file "path/to/file")
7020 Text will be placed at the beginning or end of that file.
7022 @item (id "id of existing org entry")
7023 Filing as child of this entry, or in the body of the entry.
7025 @item (file+headline "path/to/file" "node headline")
7026 Fast configuration if the target heading is unique in the file.
7028 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7029 For non-unique headings, the full path is safer.
7031 @item (file+regexp "path/to/file" "regexp to find location")
7032 Use a regular expression to position the cursor.
7034 @item (file+datetree "path/to/file")
7035 Will create a heading in a date tree for today's date@footnote{Datetree
7036 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7037 and @code{* 2013} in your file, the capture will refile the note to the first
7040 @item (file+datetree+prompt "path/to/file")
7041 Will create a heading in a date tree, but will prompt for the date.
7043 @item (file+function "path/to/file" function-finding-location)
7044 A function to find the right location in the file.
7047 File to the entry that is currently being clocked.
7049 @item (function function-finding-location)
7050 Most general way, write your own function to find both
7055 The template for creating the capture item. If you leave this empty, an
7056 appropriate default template will be used. Otherwise this is a string with
7057 escape codes, which will be replaced depending on time and context of the
7058 capture call. The string with escapes may be loaded from a template file,
7059 using the special syntax @code{(file "path/to/template")}. See below for
7063 The rest of the entry is a property list of additional options.
7064 Recognized properties are:
7068 Normally new captured information will be appended at
7069 the target location (last child, last table line, last list item...).
7070 Setting this property will change that.
7072 @item :immediate-finish
7073 When set, do not offer to edit the information, just
7074 file it away immediately. This makes sense if the template only needs
7075 information that can be added automatically.
7078 Set this to the number of lines to insert
7079 before and after the new item. Default 0, only common other value is 1.
7082 Start the clock in this item.
7085 Keep the clock running when filing the captured entry.
7088 If starting the capture interrupted a clock, restart that clock when finished
7089 with the capture. Note that @code{:clock-keep} has precedence over
7090 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7091 run and the previous one will not be resumed.
7094 Do not narrow the target buffer, simply show the full buffer. Default is to
7095 narrow it so that you only see the new material.
7097 @item :table-line-pos
7098 Specification of the location in the table where the new line should be
7099 inserted. It can be a string, a variable holding a string or a function
7100 returning a string. The string should look like @code{"II-3"} meaning that
7101 the new line should become the third line before the second horizontal
7105 If the target file was not yet visited when capture was invoked, kill the
7106 buffer again after capture is completed.
7110 @node Template expansion
7111 @subsubsection Template expansion
7113 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7114 these sequences literally, escape the @kbd{%} with a backslash.} allow
7115 dynamic insertion of content. The templates are expanded in the order given here:
7118 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7119 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7120 @r{For convenience, %:keyword (see below) placeholders}
7121 @r{within the expression will be expanded prior to this.}
7122 @r{The sexp must return a string.}
7123 %<...> @r{The result of format-time-string on the ... format specification.}
7124 %t @r{Timestamp, date only.}
7125 %T @r{Timestamp, with date and time.}
7126 %u, %U @r{Like the above, but inactive timestamps.}
7127 %i @r{Initial content, the region when capture is called while the}
7128 @r{region is active.}
7129 @r{The entire text will be indented like @code{%i} itself.}
7130 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7131 %A @r{Like @code{%a}, but prompt for the description part.}
7132 %l @r{Like %a, but only insert the literal link.}
7133 %c @r{Current kill ring head.}
7134 %x @r{Content of the X clipboard.}
7135 %k @r{Title of the currently clocked task.}
7136 %K @r{Link to the currently clocked task.}
7137 %n @r{User name (taken from @code{user-full-name}).}
7138 %f @r{File visited by current buffer when org-capture was called.}
7139 %F @r{Full path of the file or directory visited by current buffer.}
7140 %:keyword @r{Specific information for certain link types, see below.}
7141 %^g @r{Prompt for tags, with completion on tags in target file.}
7142 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7143 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7144 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7145 %^C @r{Interactive selection of which kill or clip to use.}
7146 %^L @r{Like @code{%^C}, but insert as link.}
7147 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7148 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7149 @r{You may specify a default value and a completion table with}
7150 @r{%^@{prompt|default|completion2|completion3...@}.}
7151 @r{The arrow keys access a prompt-specific history.}
7152 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7153 @r{a number, starting from 1.}
7154 %? @r{After completing the template, position cursor here.}
7158 For specific link types, the following keywords will be
7159 defined@footnote{If you define your own link types (@pxref{Adding
7160 hyperlink types}), any property you store with
7161 @code{org-store-link-props} can be accessed in capture templates in a
7164 @vindex org-from-is-user-regexp
7166 Link type | Available keywords
7167 ---------------------------------+----------------------------------------------
7168 bbdb | %:name %:company
7169 irc | %:server %:port %:nick
7170 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
7171 | %:from %:fromname %:fromaddress
7172 | %:to %:toname %:toaddress
7173 | %:date @r{(message date header field)}
7174 | %:date-timestamp @r{(date as active timestamp)}
7175 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7176 | %: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}.}}
7177 gnus | %:group, @r{for messages also all email fields}
7179 info | %:file %:node
7184 To place the cursor after template expansion use:
7187 %? @r{After completing the template, position cursor here.}
7190 @node Templates in contexts
7191 @subsubsection Templates in contexts
7193 @vindex org-capture-templates-contexts
7194 To control whether a capture template should be accessible from a specific
7195 context, you can customize @code{org-capture-templates-contexts}. Let's say
7196 for example that you have a capture template @code{"p"} for storing Gnus
7197 emails containing patches. Then you would configure this option like this:
7200 (setq org-capture-templates-contexts
7201 '(("p" (in-mode . "message-mode"))))
7204 You can also tell that the command key @code{"p"} should refer to another
7205 template. In that case, add this command key like this:
7208 (setq org-capture-templates-contexts
7209 '(("p" "q" (in-mode . "message-mode"))))
7212 See the docstring of the variable for more information.
7215 @section Attachments
7218 @vindex org-attach-directory
7219 It is often useful to associate reference material with an outline node/task.
7220 Small chunks of plain text can simply be stored in the subtree of a project.
7221 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7222 files that live elsewhere on your computer or in the cloud, like emails or
7223 source code files belonging to a project. Another method is @i{attachments},
7224 which are files located in a directory belonging to an outline node. Org
7225 uses directories named by the unique ID of each entry. These directories are
7226 located in the @file{data} directory which lives in the same directory where
7227 your Org file lives@footnote{If you move entries or Org files from one
7228 directory to another, you may want to configure @code{org-attach-directory}
7229 to contain an absolute path.}. If you initialize this directory with
7230 @code{git init}, Org will automatically commit changes when it sees them.
7231 The attachment system has been contributed to Org by John Wiegley.
7233 In cases where it seems better to do so, you can also attach a directory of your
7234 choice to an entry. You can also make children inherit the attachment
7235 directory from a parent, so that an entire subtree uses the same attached
7238 @noindent The following commands deal with attachments:
7241 @orgcmd{C-c C-a,org-attach}
7242 The dispatcher for commands related to the attachment system. After these
7243 keys, a list of commands is displayed and you must press an additional key
7244 to select a command:
7247 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7248 @vindex org-attach-method
7249 Select a file and move it into the task's attachment directory. The file
7250 will be copied, moved, or linked, depending on @code{org-attach-method}.
7251 Note that hard links are not supported on all systems.
7257 Attach a file using the copy/move/link method.
7258 Note that hard links are not supported on all systems.
7260 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7261 Create a new attachment as an Emacs buffer.
7263 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7264 Synchronize the current task with its attachment directory, in case you added
7265 attachments yourself.
7267 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7268 @vindex org-file-apps
7269 Open current task's attachment. If there is more than one, prompt for a
7270 file name first. Opening will follow the rules set by @code{org-file-apps}.
7271 For more details, see the information on following hyperlinks
7272 (@pxref{Handling links}).
7274 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7275 Also open the attachment, but force opening the file in Emacs.
7277 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7278 Open the current task's attachment directory.
7280 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7281 Also open the directory, but force using @command{dired} in Emacs.
7283 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7284 Select and delete a single attachment.
7286 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7287 Delete all of a task's attachments. A safer way is to open the directory in
7288 @command{dired} and delete from there.
7290 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7291 @cindex property, ATTACH_DIR
7292 Set a specific directory as the entry's attachment directory. This works by
7293 putting the directory path into the @code{ATTACH_DIR} property.
7295 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7296 @cindex property, ATTACH_DIR_INHERIT
7297 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7298 same directory for attachments as the parent does.
7307 Org can add and change entries based on information found in RSS feeds and
7308 Atom feeds. You could use this to make a task out of each new podcast in a
7309 podcast feed. Or you could use a phone-based note-creating service on the
7310 web to import tasks into Org. To access feeds, configure the variable
7311 @code{org-feed-alist}. The docstring of this variable has detailed
7312 information. Here is just an example:
7316 (setq org-feed-alist
7318 "http://rss.slashdot.org/Slashdot/slashdot"
7319 "~/txt/org/feeds.org" "Slashdot Entries")))
7324 will configure that new items from the feed provided by
7325 @code{rss.slashdot.org} will result in new entries in the file
7326 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7327 the following command is used:
7330 @orgcmd{C-c C-x g,org-feed-update-all}
7332 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7334 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7335 Prompt for a feed name and go to the inbox configured for this feed.
7338 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7339 it will store information about the status of items in the feed, to avoid
7340 adding the same item several times.
7342 For more information, including how to read atom feeds, see
7343 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7346 @section Protocols for external access
7347 @cindex protocols, for external access
7350 You can set up Org for handling protocol calls from outside applications that
7351 are passed to Emacs through the @file{emacsserver}. For example, you can
7352 configure bookmarks in your web browser to send a link to the current page to
7353 Org and create a note from it using capture (@pxref{Capture}). Or you
7354 could create a bookmark that will tell Emacs to open the local source file of
7355 a remote website you are looking at with the browser. See
7356 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7357 documentation and setup instructions.
7359 @node Refile and copy
7360 @section Refile and copy
7361 @cindex refiling notes
7362 @cindex copying notes
7364 When reviewing the captured data, you may want to refile or to copy some of
7365 the entries into a different list, for example into a project. Cutting,
7366 finding the right location, and then pasting the note is cumbersome. To
7367 simplify this process, you can use the following special command:
7370 @orgcmd{C-c M-w,org-copy}
7372 Copying works like refiling, except that the original note is not deleted.
7373 @orgcmd{C-c C-w,org-refile}
7375 @vindex org-reverse-note-order
7376 @vindex org-refile-targets
7377 @vindex org-refile-use-outline-path
7378 @vindex org-outline-path-complete-in-steps
7379 @vindex org-refile-allow-creating-parent-nodes
7380 @vindex org-log-refile
7381 @vindex org-refile-use-cache
7382 @vindex org-refile-keep
7383 Refile the entry or region at point. This command offers possible locations
7384 for refiling the entry and lets you select one with completion. The item (or
7385 all items in the region) is filed below the target heading as a subitem.
7386 Depending on @code{org-reverse-note-order}, it will be either the first or
7388 By default, all level 1 headlines in the current buffer are considered to be
7389 targets, but you can have more complex definitions across a number of files.
7390 See the variable @code{org-refile-targets} for details. If you would like to
7391 select a location via a file-path-like completion along the outline path, see
7392 the variables @code{org-refile-use-outline-path} and
7393 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7394 create new nodes as new parents for refiling on the fly, check the
7395 variable @code{org-refile-allow-creating-parent-nodes}.
7396 When the variable @code{org-log-refile}@footnote{with corresponding
7397 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7398 and @code{nologrefile}} is set, a timestamp or a note will be
7399 recorded when an entry has been refiled.
7400 @orgkey{C-u C-c C-w}
7401 Use the refile interface to jump to a heading.
7402 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7403 Jump to the location where @code{org-refile} last moved a tree to.
7405 Refile as the child of the item currently being clocked.
7407 Refile and keep the entry in place. Also see @code{org-refile-keep} to make
7408 this the default behavior, and beware that this may result in duplicated
7409 @code{ID} properties.
7410 @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}
7411 Clear the target cache. Caching of refile targets can be turned on by
7412 setting @code{org-refile-use-cache}. To make the command see new possible
7413 targets, you have to clear the cache with this command.
7420 When a project represented by a (sub)tree is finished, you may want
7421 to move the tree out of the way and to stop it from contributing to the
7422 agenda. Archiving is important to keep your working files compact and global
7423 searches like the construction of agenda views fast.
7426 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7427 @vindex org-archive-default-command
7428 Archive the current entry using the command specified in the variable
7429 @code{org-archive-default-command}.
7433 * Moving subtrees:: Moving a tree to an archive file
7434 * Internal archiving:: Switch off a tree but keep it in the file
7437 @node Moving subtrees
7438 @subsection Moving a tree to the archive file
7439 @cindex external archiving
7441 The most common archiving action is to move a project tree to another file,
7445 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7446 @vindex org-archive-location
7447 Archive the subtree starting at the cursor position to the location
7448 given by @code{org-archive-location}.
7449 @orgkey{C-u C-c C-x C-s}
7450 Check if any direct children of the current headline could be moved to
7451 the archive. To do this, each subtree is checked for open TODO entries.
7452 If none are found, the command offers to move it to the archive
7453 location. If the cursor is @emph{not} on a headline when this command
7454 is invoked, the level 1 trees will be checked.
7457 @cindex archive locations
7458 The default archive location is a file in the same directory as the
7459 current file, with the name derived by appending @file{_archive} to the
7460 current file name. You can also choose what heading to file archived
7461 items under, with the possibility to add them to a datetree in a file.
7462 For information and examples on how to specify the file and the heading,
7463 see the documentation string of the variable
7464 @code{org-archive-location}.
7466 There is also an in-buffer option for setting this variable, for
7467 example@footnote{For backward compatibility, the following also works:
7468 If there are several such lines in a file, each specifies the archive
7469 location for the text below it. The first such line also applies to any
7470 text before its definition. However, using this method is
7471 @emph{strongly} deprecated as it is incompatible with the outline
7472 structure of the document. The correct method for setting multiple
7473 archive locations in a buffer is using properties.}:
7477 #+ARCHIVE: %s_done::
7480 @cindex property, ARCHIVE
7482 If you would like to have a special ARCHIVE location for a single entry
7483 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7484 location as the value (@pxref{Properties and columns}).
7486 @vindex org-archive-save-context-info
7487 When a subtree is moved, it receives a number of special properties that
7488 record context information like the file from where the entry came, its
7489 outline path the archiving time etc. Configure the variable
7490 @code{org-archive-save-context-info} to adjust the amount of information
7494 @node Internal archiving
7495 @subsection Internal archiving
7497 If you want to just switch off (for agenda views) certain subtrees without
7498 moving them to a different file, you can use the @code{ARCHIVE tag}.
7500 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7501 its location in the outline tree, but behaves in the following way:
7504 @vindex org-cycle-open-archived-trees
7505 It does not open when you attempt to do so with a visibility cycling
7506 command (@pxref{Visibility cycling}). You can force cycling archived
7507 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7508 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7509 @code{show-all} will open archived subtrees.
7511 @vindex org-sparse-tree-open-archived-trees
7512 During sparse tree construction (@pxref{Sparse trees}), matches in
7513 archived subtrees are not exposed, unless you configure the option
7514 @code{org-sparse-tree-open-archived-trees}.
7516 @vindex org-agenda-skip-archived-trees
7517 During agenda view construction (@pxref{Agenda views}), the content of
7518 archived trees is ignored unless you configure the option
7519 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7520 be included. In the agenda you can press @kbd{v a} to get archives
7521 temporarily included.
7523 @vindex org-export-with-archived-trees
7524 Archived trees are not exported (@pxref{Exporting}), only the headline
7525 is. Configure the details using the variable
7526 @code{org-export-with-archived-trees}.
7528 @vindex org-columns-skip-archived-trees
7529 Archived trees are excluded from column view unless the variable
7530 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7533 The following commands help manage the ARCHIVE tag:
7536 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7537 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7538 the headline changes to a shadowed face, and the subtree below it is
7540 @orgkey{C-u C-c C-x a}
7541 Check if any direct children of the current headline should be archived.
7542 To do this, each subtree is checked for open TODO entries. If none are
7543 found, the command offers to set the ARCHIVE tag for the child. If the
7544 cursor is @emph{not} on a headline when this command is invoked, the
7545 level 1 trees will be checked.
7546 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7547 Cycle a tree even if it is tagged with ARCHIVE.
7548 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7549 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7550 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7551 entry becomes a child of that sibling and in this way retains a lot of its
7552 original context, including inherited tags and approximate position in the
7558 @chapter Agenda views
7559 @cindex agenda views
7561 Due to the way Org works, TODO items, time-stamped items, and
7562 tagged headlines can be scattered throughout a file or even a number of
7563 files. To get an overview of open action items, or of events that are
7564 important for a particular date, this information must be collected,
7565 sorted and displayed in an organized way.
7567 Org can select items based on various criteria and display them
7568 in a separate buffer. Seven different view types are provided:
7572 an @emph{agenda} that is like a calendar and shows information
7575 a @emph{TODO list} that covers all unfinished
7578 a @emph{match view}, showings headlines based on the tags, properties, and
7579 TODO state associated with them,
7581 a @emph{timeline view} that shows all events in a single Org file,
7582 in time-sorted view,
7584 a @emph{text search view} that shows all entries from multiple files
7585 that contain specified keywords,
7587 a @emph{stuck projects view} showing projects that currently don't move
7590 @emph{custom views} that are special searches and combinations of different
7595 The extracted information is displayed in a special @emph{agenda
7596 buffer}. This buffer is read-only, but provides commands to visit the
7597 corresponding locations in the original Org files, and even to
7598 edit these files remotely.
7600 @vindex org-agenda-window-setup
7601 @vindex org-agenda-restore-windows-after-quit
7602 Two variables control how the agenda buffer is displayed and whether the
7603 window configuration is restored when the agenda exits:
7604 @code{org-agenda-window-setup} and
7605 @code{org-agenda-restore-windows-after-quit}.
7608 * Agenda files:: Files being searched for agenda information
7609 * Agenda dispatcher:: Keyboard access to agenda views
7610 * Built-in agenda views:: What is available out of the box?
7611 * Presentation and sorting:: How agenda items are prepared for display
7612 * Agenda commands:: Remote editing of Org trees
7613 * Custom agenda views:: Defining special searches and views
7614 * Exporting agenda views:: Writing a view to a file
7615 * Agenda column view:: Using column view for collected entries
7619 @section Agenda files
7620 @cindex agenda files
7621 @cindex files for agenda
7623 @vindex org-agenda-files
7624 The information to be shown is normally collected from all @emph{agenda
7625 files}, the files listed in the variable
7626 @code{org-agenda-files}@footnote{If the value of that variable is not a
7627 list, but a single file name, then the list of agenda files will be
7628 maintained in that external file.}. If a directory is part of this list,
7629 all files with the extension @file{.org} in this directory will be part
7632 Thus, even if you only work with a single Org file, that file should
7633 be put into the list@footnote{When using the dispatcher, pressing
7634 @kbd{<} before selecting a command will actually limit the command to
7635 the current file, and ignore @code{org-agenda-files} until the next
7636 dispatcher command.}. You can customize @code{org-agenda-files}, but
7637 the easiest way to maintain it is through the following commands
7639 @cindex files, adding to agenda list
7641 @orgcmd{C-c [,org-agenda-file-to-front}
7642 Add current file to the list of agenda files. The file is added to
7643 the front of the list. If it was already in the list, it is moved to
7644 the front. With a prefix argument, file is added/moved to the end.
7645 @orgcmd{C-c ],org-remove-file}
7646 Remove current file from the list of agenda files.
7648 @cindex cycling, of agenda files
7649 @orgcmd{C-',org-cycle-agenda-files}
7651 Cycle through agenda file list, visiting one file after the other.
7652 @kindex M-x org-iswitchb
7653 @item M-x org-iswitchb RET
7654 Command to use an @code{iswitchb}-like interface to switch to and between Org
7659 The Org menu contains the current list of files and can be used
7660 to visit any of them.
7662 If you would like to focus the agenda temporarily on a file not in
7663 this list, or on just one file in the list, or even on only a subtree in a
7664 file, then this can be done in different ways. For a single agenda command,
7665 you may press @kbd{<} once or several times in the dispatcher
7666 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7667 extended period, use the following commands:
7670 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7671 Permanently restrict the agenda to the current subtree. When with a
7672 prefix argument, or with the cursor before the first headline in a file,
7673 the agenda scope is set to the entire file. This restriction remains in
7674 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7675 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7676 agenda view, the new restriction takes effect immediately.
7677 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7678 Remove the permanent restriction created by @kbd{C-c C-x <}.
7682 When working with @file{speedbar.el}, you can use the following commands in
7686 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7687 Permanently restrict the agenda to the item---either an Org file or a subtree
7688 in such a file---at the cursor in the Speedbar frame.
7689 If there is a window displaying an agenda view, the new restriction takes
7691 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7692 Lift the restriction.
7695 @node Agenda dispatcher
7696 @section The agenda dispatcher
7697 @cindex agenda dispatcher
7698 @cindex dispatching agenda commands
7699 The views are created through a dispatcher, which should be bound to a
7700 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7701 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7702 is accessed and list keyboard access to commands accordingly. After
7703 pressing @kbd{C-c a}, an additional letter is required to execute a
7704 command. The dispatcher offers the following default commands:
7708 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7710 Create a list of all TODO items (@pxref{Global TODO list}).
7712 Create a list of headlines matching a TAGS expression (@pxref{Matching
7713 tags and properties}).
7715 Create the timeline view for the current buffer (@pxref{Timeline}).
7717 Create a list of entries selected by a boolean expression of keywords
7718 and/or regular expressions that must or must not occur in the entry.
7720 @vindex org-agenda-text-search-extra-files
7721 Search for a regular expression in all agenda files and additionally in
7722 the files listed in @code{org-agenda-text-search-extra-files}. This
7723 uses the Emacs command @code{multi-occur}. A prefix argument can be
7724 used to specify the number of context lines for each match, default is
7727 Create a list of stuck projects (@pxref{Stuck projects}).
7729 Restrict an agenda command to the current buffer@footnote{For backward
7730 compatibility, you can also press @kbd{1} to restrict to the current
7731 buffer.}. After pressing @kbd{<}, you still need to press the character
7732 selecting the command.
7734 If there is an active region, restrict the following agenda command to
7735 the region. Otherwise, restrict it to the current subtree@footnote{For
7736 backward compatibility, you can also press @kbd{0} to restrict to the
7737 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7738 character selecting the command.
7741 @cindex agenda, sticky
7742 @vindex org-agenda-sticky
7743 Toggle sticky agenda views. By default, Org maintains only a single agenda
7744 buffer and rebuilds it each time you change the view, to make sure everything
7745 is always up to date. If you often switch between agenda views and the build
7746 time bothers you, you can turn on sticky agenda buffers or make this the
7747 default by customizing the variable @code{org-agenda-sticky}. With sticky
7748 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7749 it will only switch to the selected one, and you need to update the agenda by
7750 hand with @kbd{r} or @kbd{g} when needed. You can toggle sticky agenda view
7751 any time with @code{org-toggle-sticky-agenda}.
7754 You can also define custom commands that will be accessible through the
7755 dispatcher, just like the default commands. This includes the
7756 possibility to create extended agenda buffers that contain several
7757 blocks together, for example the weekly agenda, the global TODO list and
7758 a number of special tags matches. @xref{Custom agenda views}.
7760 @node Built-in agenda views
7761 @section The built-in agenda views
7763 In this section we describe the built-in views.
7766 * Weekly/daily agenda:: The calendar page with current tasks
7767 * Global TODO list:: All unfinished action items
7768 * Matching tags and properties:: Structured information with fine-tuned search
7769 * Timeline:: Time-sorted view for single file
7770 * Search view:: Find entries by searching for text
7771 * Stuck projects:: Find projects you need to review
7774 @node Weekly/daily agenda
7775 @subsection The weekly/daily agenda
7777 @cindex weekly agenda
7778 @cindex daily agenda
7780 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7781 paper agenda, showing all the tasks for the current week or day.
7784 @cindex org-agenda, command
7785 @orgcmd{C-c a a,org-agenda-list}
7786 Compile an agenda for the current week from a list of Org files. The agenda
7787 shows the entries for each day. With a numeric prefix@footnote{For backward
7788 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7789 listed before the agenda. This feature is deprecated, use the dedicated TODO
7790 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7791 C-c a a}) you may set the number of days to be displayed.
7794 @vindex org-agenda-span
7795 @vindex org-agenda-ndays
7796 @vindex org-agenda-start-day
7797 @vindex org-agenda-start-on-weekday
7798 The default number of days displayed in the agenda is set by the variable
7799 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7800 variable can be set to any number of days you want to see by default in the
7801 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7802 @code{year}. For weekly agendas, the default is to start on the previous
7803 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7804 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7805 start the agenda ten days from today in the future.
7807 Remote editing from the agenda buffer means, for example, that you can
7808 change the dates of deadlines and appointments from the agenda buffer.
7809 The commands available in the Agenda buffer are listed in @ref{Agenda
7812 @subsubheading Calendar/Diary integration
7813 @cindex calendar integration
7814 @cindex diary integration
7816 Emacs contains the calendar and diary by Edward M. Reingold. The
7817 calendar displays a three-month calendar with holidays from different
7818 countries and cultures. The diary allows you to keep track of
7819 anniversaries, lunar phases, sunrise/set, recurrent appointments
7820 (weekly, monthly) and more. In this way, it is quite complementary to
7821 Org. It can be very useful to combine output from Org with
7824 In order to include entries from the Emacs diary into Org mode's
7825 agenda, you only need to customize the variable
7828 (setq org-agenda-include-diary t)
7831 @noindent After that, everything will happen automatically. All diary
7832 entries including holidays, anniversaries, etc., will be included in the
7833 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7834 @key{RET} can be used from the agenda buffer to jump to the diary
7835 file in order to edit existing diary entries. The @kbd{i} command to
7836 insert new entries for the current date works in the agenda buffer, as
7837 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7838 Sunrise/Sunset times, show lunar phases and to convert to other
7839 calendars, respectively. @kbd{c} can be used to switch back and forth
7840 between calendar and agenda.
7842 If you are using the diary only for sexp entries and holidays, it is
7843 faster to not use the above setting, but instead to copy or even move
7844 the entries into an Org file. Org mode evaluates diary-style sexp
7845 entries, and does it faster because there is no overhead for first
7846 creating the diary display. Note that the sexp entries must start at
7847 the left margin, no whitespace is allowed before them. For example,
7848 the following segment of an Org file will be processed and entries
7849 will be made in the agenda:
7852 * Birthdays and similar stuff
7854 %%(org-calendar-holiday) ; special function for holiday names
7856 %%(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
7857 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7860 @subsubheading Anniversaries from BBDB
7861 @cindex BBDB, anniversaries
7862 @cindex anniversaries, from BBDB
7864 If you are using the Big Brothers Database to store your contacts, you will
7865 very likely prefer to store anniversaries in BBDB rather than in a
7866 separate Org or diary file. Org supports this and will show BBDB
7867 anniversaries as part of the agenda. All you need to do is to add the
7868 following to one of your agenda files:
7875 %%(org-bbdb-anniversaries)
7878 You can then go ahead and define anniversaries for a BBDB record. Basically,
7879 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7880 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7881 followed by a space and the class of the anniversary (@samp{birthday} or
7882 @samp{wedding}, or a format string). If you omit the class, it will default to
7883 @samp{birthday}. Here are a few examples, the header for the file
7884 @file{org-bbdb.el} contains more detailed information.
7890 2008-04-14 %s released version 6.01 of org mode, %d years ago
7893 After a change to BBDB, or for the first agenda display during an Emacs
7894 session, the agenda display will suffer a short delay as Org updates its
7895 hash with anniversaries. However, from then on things will be very fast---much
7896 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7897 in an Org or Diary file.
7899 @subsubheading Appointment reminders
7900 @cindex @file{appt.el}
7901 @cindex appointment reminders
7905 Org can interact with Emacs appointments notification facility. To add the
7906 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7907 This command lets you filter through the list of your appointments and add
7908 only those belonging to a specific category or matching a regular expression.
7909 It also reads a @code{APPT_WARNTIME} property which will then override the
7910 value of @code{appt-message-warning-time} for this appointment. See the
7911 docstring for details.
7913 @node Global TODO list
7914 @subsection The global TODO list
7915 @cindex global TODO list
7916 @cindex TODO list, global
7918 The global TODO list contains all unfinished TODO items formatted and
7919 collected into a single place.
7922 @orgcmd{C-c a t,org-todo-list}
7923 Show the global TODO list. This collects the TODO items from all agenda
7924 files (@pxref{Agenda views}) into a single buffer. By default, this lists
7925 items with a state the is not a DONE state. The buffer is in
7926 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7927 entries directly from that buffer (@pxref{Agenda commands}).
7928 @orgcmd{C-c a T,org-todo-list}
7929 @cindex TODO keyword matching
7930 @vindex org-todo-keywords
7931 Like the above, but allows selection of a specific TODO keyword. You can
7932 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7933 prompted for a keyword, and you may also specify several keywords by
7934 separating them with @samp{|} as the boolean OR operator. With a numeric
7935 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7937 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7938 a prefix argument to this command to change the selected TODO keyword,
7939 for example @kbd{3 r}. If you often need a search for a specific
7940 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7941 Matching specific TODO keywords can also be done as part of a tags
7942 search (@pxref{Tag searches}).
7945 Remote editing of TODO items means that you can change the state of a
7946 TODO entry with a single key press. The commands available in the
7947 TODO list are described in @ref{Agenda commands}.
7949 @cindex sublevels, inclusion into TODO list
7950 Normally the global TODO list simply shows all headlines with TODO
7951 keywords. This list can become very long. There are two ways to keep
7955 @vindex org-agenda-todo-ignore-scheduled
7956 @vindex org-agenda-todo-ignore-deadlines
7957 @vindex org-agenda-todo-ignore-timestamp
7958 @vindex org-agenda-todo-ignore-with-date
7959 Some people view a TODO item that has been @emph{scheduled} for execution or
7960 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7961 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7962 @code{org-agenda-todo-ignore-deadlines},
7963 @code{org-agenda-todo-ignore-timestamp} and/or
7964 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7967 @vindex org-agenda-todo-list-sublevels
7968 TODO items may have sublevels to break up the task into subtasks. In
7969 such cases it may be enough to list only the highest level TODO headline
7970 and omit the sublevels from the global list. Configure the variable
7971 @code{org-agenda-todo-list-sublevels} to get this behavior.
7974 @node Matching tags and properties
7975 @subsection Matching tags and properties
7976 @cindex matching, of tags
7977 @cindex matching, of properties
7981 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7982 or have properties (@pxref{Properties and columns}), you can select headlines
7983 based on this metadata and collect them into an agenda buffer. The match
7984 syntax described here also applies when creating sparse trees with @kbd{C-c /
7988 @orgcmd{C-c a m,org-tags-view}
7989 Produce a list of all headlines that match a given set of tags. The
7990 command prompts for a selection criterion, which is a boolean logic
7991 expression with tags, like @samp{+work+urgent-withboss} or
7992 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7993 define a custom command for it (@pxref{Agenda dispatcher}).
7994 @orgcmd{C-c a M,org-tags-view}
7995 @vindex org-tags-match-list-sublevels
7996 @vindex org-agenda-tags-todo-honor-ignore-options
7997 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7998 not-DONE state and force checking subitems (see variable
7999 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
8000 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
8001 specific TODO keywords together with a tags match is also possible, see
8005 The commands available in the tags list are described in @ref{Agenda
8008 @subsubheading Match syntax
8010 @cindex Boolean logic, for tag/property searches
8011 A search string can use Boolean operators @samp{&} for @code{AND} and
8012 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8013 Parentheses are not implemented. Each element in the search is either a
8014 tag, a regular expression matching tags, or an expression like
8015 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8016 property value. Each element may be preceded by @samp{-}, to select
8017 against it, and @samp{+} is syntactic sugar for positive selection. The
8018 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8019 present. Here are some examples, using only tags.
8023 Select headlines tagged @samp{:work:}.
8025 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8027 Select headlines tagged @samp{:work:}, but discard those also tagged
8030 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8031 @item work|laptop+night
8032 Like before, but require the @samp{:laptop:} lines to be tagged also
8036 @cindex regular expressions, with tags search
8037 Instead of a tag, you may also specify a regular expression enclosed in curly
8038 braces. For example,
8039 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8040 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8042 @cindex group tags, as regular expressions
8043 Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g.,
8044 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8045 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8046 and searching for @samp{-work} will search for all headlines but those with
8047 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8049 @cindex TODO keyword matching, with tags search
8050 @cindex level, require for tags/property match
8051 @cindex category, require for tags/property match
8052 @vindex org-odd-levels-only
8053 You may also test for properties (@pxref{Properties and columns}) at the same
8054 time as matching tags. The properties may be real properties, or special
8055 properties that represent other metadata (@pxref{Special properties}). For
8056 example, the ``property'' @code{TODO} represents the TODO keyword of the
8057 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8058 the entry. The ITEM special property cannot currently be used in tags/property
8059 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8060 ,skipping entries based on regexp}.}.
8062 In addition to the @pxref{Special properties}, one other ``property'' can
8063 also be used. @code{LEVEL} represents the level of an entry. So a search
8064 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8065 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8066 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8067 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8069 Here are more examples:
8072 @item work+TODO="WAITING"
8073 Select @samp{:work:}-tagged TODO lines with the specific TODO
8074 keyword @samp{WAITING}.
8075 @item work+TODO="WAITING"|home+TODO="WAITING"
8076 Waiting tasks both at work and at home.
8079 When matching properties, a number of different operators can be used to test
8080 the value of a property. Here is a complex example:
8083 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8084 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8088 The type of comparison will depend on how the comparison value is written:
8091 If the comparison value is a plain number, a numerical comparison is done,
8092 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8093 @samp{>=}, and @samp{<>}.
8095 If the comparison value is enclosed in double-quotes,
8096 a string comparison is done, and the same operators are allowed.
8098 If the comparison value is enclosed in double-quotes @emph{and} angular
8099 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8100 assumed to be date/time specifications in the standard Org way, and the
8101 comparison will be done accordingly. Special values that will be recognized
8102 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8103 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8104 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8105 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8106 respectively, can be used.
8108 If the comparison value is enclosed
8109 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8110 regexp matches the property value, and @samp{<>} meaning that it does not
8114 So the search string in the example finds entries tagged @samp{:work:} but
8115 not @samp{:boss:}, which also have a priority value @samp{A}, a
8116 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8117 property that is numerically smaller than 2, a @samp{:With:} property that is
8118 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8119 on or after October 11, 2008.
8121 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
8122 other properties will slow down the search. However, once you have paid the
8123 price by accessing one property, testing additional properties is cheap
8126 You can configure Org mode to use property inheritance during a search, but
8127 beware that this can slow down searches considerably. See @ref{Property
8128 inheritance}, for details.
8130 For backward compatibility, and also for typing speed, there is also a
8131 different way to test TODO states in a search. For this, terminate the
8132 tags/property part of the search string (which may include several terms
8133 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8134 expression just for TODO keywords. The syntax is then similar to that for
8135 tags, but should be applied with care: for example, a positive selection on
8136 several TODO keywords cannot meaningfully be combined with boolean AND@.
8137 However, @emph{negative selection} combined with AND can be meaningful. To
8138 make sure that only lines are checked that actually have any TODO keyword
8139 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8140 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8141 not match TODO keywords in a DONE state. Examples:
8145 Same as @samp{work+TODO="WAITING"}
8146 @item work/!-WAITING-NEXT
8147 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8149 @item work/!+WAITING|+NEXT
8150 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8155 @subsection Timeline for a single file
8156 @cindex timeline, single file
8157 @cindex time-sorted view
8159 The timeline summarizes all time-stamped items from a single Org mode
8160 file in a @emph{time-sorted view}. The main purpose of this command is
8161 to give an overview over events in a project.
8164 @orgcmd{C-c a L,org-timeline}
8165 Show a time-sorted view of the Org file, with all time-stamped items.
8166 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8167 (scheduled or not) are also listed under the current date.
8171 The commands available in the timeline buffer are listed in
8172 @ref{Agenda commands}.
8175 @subsection Search view
8178 @cindex searching, for text
8180 This agenda view is a general text search facility for Org mode entries.
8181 It is particularly useful to find notes.
8184 @orgcmd{C-c a s,org-search-view}
8185 This is a special search that lets you select entries by matching a substring
8186 or specific words using a boolean logic.
8188 For example, the search string @samp{computer equipment} will find entries
8189 that contain @samp{computer equipment} as a substring. If the two words are
8190 separated by more space or a line break, the search will still match.
8191 Search view can also search for specific keywords in the entry, using Boolean
8192 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8193 will search for note entries that contain the keywords @code{computer}
8194 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8195 not matched by the regular expression @code{8\.11[bg]}, meaning to
8196 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8197 word search, other @samp{+} characters are optional. For more details, see
8198 the docstring of the command @code{org-search-view}.
8200 @vindex org-agenda-text-search-extra-files
8201 Note that in addition to the agenda files, this command will also search
8202 the files listed in @code{org-agenda-text-search-extra-files}.
8204 @node Stuck projects
8205 @subsection Stuck projects
8206 @pindex GTD, Getting Things Done
8208 If you are following a system like David Allen's GTD to organize your
8209 work, one of the ``duties'' you have is a regular review to make sure
8210 that all projects move along. A @emph{stuck} project is a project that
8211 has no defined next actions, so it will never show up in the TODO lists
8212 Org mode produces. During the review, you need to identify such
8213 projects and define next actions for them.
8216 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8217 List projects that are stuck.
8220 @vindex org-stuck-projects
8221 Customize the variable @code{org-stuck-projects} to define what a stuck
8222 project is and how to find it.
8225 You almost certainly will have to configure this view before it will
8226 work for you. The built-in default assumes that all your projects are
8227 level-2 headlines, and that a project is not stuck if it has at least
8228 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8230 Let's assume that you, in your own way of using Org mode, identify
8231 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8232 indicate a project that should not be considered yet. Let's further
8233 assume that the TODO keyword DONE marks finished projects, and that NEXT
8234 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8235 is a next action even without the NEXT tag. Finally, if the project
8236 contains the special word IGNORE anywhere, it should not be listed
8237 either. In this case you would start by identifying eligible projects
8238 with a tags/todo match@footnote{@xref{Tag searches}.}
8239 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8240 IGNORE in the subtree to identify projects that are not stuck. The
8241 correct customization for this is
8244 (setq org-stuck-projects
8245 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8249 Note that if a project is identified as non-stuck, the subtree of this entry
8250 will still be searched for stuck projects.
8252 @node Presentation and sorting
8253 @section Presentation and sorting
8254 @cindex presentation, of agenda items
8256 @vindex org-agenda-prefix-format
8257 @vindex org-agenda-tags-column
8258 Before displaying items in an agenda view, Org mode visually prepares the
8259 items and sorts them. Each item occupies a single line. The line starts
8260 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8261 of the item and other important information. You can customize in which
8262 column tags will be displayed through @code{org-agenda-tags-column}. You can
8263 also customize the prefix using the option @code{org-agenda-prefix-format}.
8264 This prefix is followed by a cleaned-up version of the outline headline
8265 associated with the item.
8268 * Categories:: Not all tasks are equal
8269 * Time-of-day specifications:: How the agenda knows the time
8270 * Sorting agenda items:: The order of things
8271 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8275 @subsection Categories
8279 The category is a broad label assigned to each agenda item. By default,
8280 the category is simply derived from the file name, but you can also
8281 specify it with a special line in the buffer, like this@footnote{For
8282 backward compatibility, the following also works: if there are several
8283 such lines in a file, each specifies the category for the text below it.
8284 The first category also applies to any text before the first CATEGORY
8285 line. However, using this method is @emph{strongly} deprecated as it is
8286 incompatible with the outline structure of the document. The correct
8287 method for setting multiple categories in a buffer is using a
8295 @cindex property, CATEGORY
8296 If you would like to have a special CATEGORY for a single entry or a
8297 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8298 special category you want to apply as the value.
8301 The display in the agenda buffer looks best if the category is not
8302 longer than 10 characters.
8305 You can set up icons for category by customizing the
8306 @code{org-agenda-category-icon-alist} variable.
8308 @node Time-of-day specifications
8309 @subsection Time-of-day specifications
8310 @cindex time-of-day specification
8312 Org mode checks each agenda item for a time-of-day specification. The
8313 time can be part of the timestamp that triggered inclusion into the
8314 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8315 ranges can be specified with two timestamps, like
8317 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8319 In the headline of the entry itself, a time(range) may also appear as
8320 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8321 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8322 specifications in diary entries are recognized as well.
8324 For agenda display, Org mode extracts the time and displays it in a
8325 standard 24 hour format as part of the prefix. The example times in
8326 the previous paragraphs would end up in the agenda like this:
8329 8:30-13:00 Arthur Dent lies in front of the bulldozer
8330 12:45...... Ford Prefect arrives and takes Arthur to the pub
8331 19:00...... The Vogon reads his poem
8332 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8336 If the agenda is in single-day mode, or for the display of today, the
8337 timed entries are embedded in a time grid, like
8340 8:00...... ------------------
8341 8:30-13:00 Arthur Dent lies in front of the bulldozer
8342 10:00...... ------------------
8343 12:00...... ------------------
8344 12:45...... Ford Prefect arrives and takes Arthur to the pub
8345 14:00...... ------------------
8346 16:00...... ------------------
8347 18:00...... ------------------
8348 19:00...... The Vogon reads his poem
8349 20:00...... ------------------
8350 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8353 @vindex org-agenda-use-time-grid
8354 @vindex org-agenda-time-grid
8355 The time grid can be turned on and off with the variable
8356 @code{org-agenda-use-time-grid}, and can be configured with
8357 @code{org-agenda-time-grid}.
8359 @node Sorting agenda items
8360 @subsection Sorting agenda items
8361 @cindex sorting, of agenda items
8362 @cindex priorities, of agenda items
8363 Before being inserted into a view, the items are sorted. How this is
8364 done depends on the type of view.
8367 @vindex org-agenda-files
8368 For the daily/weekly agenda, the items for each day are sorted. The
8369 default order is to first collect all items containing an explicit
8370 time-of-day specification. These entries will be shown at the beginning
8371 of the list, as a @emph{schedule} for the day. After that, items remain
8372 grouped in categories, in the sequence given by @code{org-agenda-files}.
8373 Within each category, items are sorted by priority (@pxref{Priorities}),
8374 which is composed of the base priority (2000 for priority @samp{A}, 1000
8375 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8376 overdue scheduled or deadline items.
8378 For the TODO list, items remain in the order of categories, but within
8379 each category, sorting takes place according to priority
8380 (@pxref{Priorities}). The priority used for sorting derives from the
8381 priority cookie, with additions depending on how close an item is to its due
8384 For tags matches, items are not sorted at all, but just appear in the
8385 sequence in which they are found in the agenda files.
8388 @vindex org-agenda-sorting-strategy
8389 Sorting can be customized using the variable
8390 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8391 the estimated effort of an entry (@pxref{Effort estimates}).
8393 @node Filtering/limiting agenda items
8394 @subsection Filtering/limiting agenda items
8396 Agenda built-in or customized commands are statically defined. Agenda
8397 filters and limits provide two ways of dynamically narrowing down the list of
8398 agenda entries: @emph{filters} and @emph{limits}. Filters only act on the
8399 display of the items, while limits take effect before the list of agenda
8400 entries is built. Filters are more often used interactively, while limits are
8401 mostly useful when defined as local variables within custom agenda commands.
8403 @subsubheading Filtering in the agenda
8404 @cindex filtering, by tag, category, top headline and effort, in agenda
8405 @cindex tag filtering, in agenda
8406 @cindex category filtering, in agenda
8407 @cindex top headline filtering, in agenda
8408 @cindex effort filtering, in agenda
8409 @cindex query editing, in agenda
8412 @orgcmd{/,org-agenda-filter-by-tag}
8413 @vindex org-agenda-tag-filter-preset
8414 Filter the agenda view with respect to a tag and/or effort estimates. The
8415 difference between this and a custom agenda command is that filtering is very
8416 fast, so that you can switch quickly between different filters without having
8417 to recreate the agenda.@footnote{Custom commands can preset a filter by
8418 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8419 filter will then be applied to the view and persist as a basic filter through
8420 refreshes and more secondary filtering. The filter is a global property of
8421 the entire agenda view---in a block agenda, you should only set this in the
8422 global options section, not in the section of an individual block.}
8424 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8425 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8426 tag (including any tags that do not have a selection character). The command
8427 then hides all entries that do not contain or inherit this tag. When called
8428 with prefix arg, remove the entries that @emph{do} have the tag. A second
8429 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8430 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8431 will be narrowed by requiring or forbidding the selected additional tag.
8432 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8433 immediately use the @kbd{\} command.
8435 @vindex org-sort-agenda-noeffort-is-high
8436 In order to filter for effort estimates, you should set up allowed
8437 efforts globally, for example
8439 (setq org-global-properties
8440 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8442 You can then filter for an effort by first typing an operator, one of
8443 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8444 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8445 The filter will then restrict to entries with effort smaller-or-equal, equal,
8446 or larger-or-equal than the selected value. If the digits 0--9 are not used
8447 as fast access keys to tags, you can also simply press the index digit
8448 directly without an operator. In this case, @kbd{<} will be assumed. For
8449 application of the operator, entries without a defined effort will be treated
8450 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8451 for tasks without effort definition, press @kbd{?} as the operator.
8453 Org also supports automatic, context-aware tag filtering. If the variable
8454 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8455 that function can decide which tags should be excluded from the agenda
8456 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8457 as a sub-option key and runs the auto exclusion logic. For example, let's
8458 say you use a @code{Net} tag to identify tasks which need network access, an
8459 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8460 calls. You could auto-exclude these tags based on the availability of the
8461 Internet, and outside of business hours, with something like this:
8465 (defun org-my-auto-exclude-function (tag)
8467 ((string= tag "Net")
8468 (/= 0 (call-process "/sbin/ping" nil nil nil
8469 "-c1" "-q" "-t1" "mail.gnu.org")))
8470 ((or (string= tag "Errand") (string= tag "Call"))
8471 (let ((hour (nth 2 (decode-time))))
8472 (or (< hour 8) (> hour 21)))))
8475 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8479 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8480 Narrow the current agenda filter by an additional condition. When called with
8481 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8482 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8483 @kbd{-} as the first key after the @kbd{/} command.
8492 @item @r{in} search view
8493 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8494 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8495 add a positive search term prefixed by @samp{+}, indicating that this search
8496 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8497 negative search term which @i{must not} occur/match in the entry for it to be
8501 @orgcmd{<,org-agenda-filter-by-category}
8502 @vindex org-agenda-category-filter-preset
8504 Filter the current agenda view with respect to the category of the item at
8505 point. Pressing @code{<} another time will remove this filter. You can add
8506 a filter preset through the option @code{org-agenda-category-filter-preset}
8509 @orgcmd{^,org-agenda-filter-by-top-headline}
8510 Filter the current agenda view and only display the siblings and the parent
8511 headline of the one at point.
8513 @orgcmd{=,org-agenda-filter-by-regexp}
8514 @vindex org-agenda-regexp-filter-preset
8516 Filter the agenda view by a regular expression: only show agenda entries
8517 matching the regular expression the user entered. When called with a prefix
8518 argument, it will filter @emph{out} entries matching the regexp. With two
8519 universal prefix arguments, it will remove all the regexp filters, which can
8520 be accumulated. You can add a filter preset through the option
8521 @code{org-agenda-category-filter-preset} (see below.)
8523 @orgcmd{|,org-agenda-filter-remove-all}
8524 Remove all filters in the current agenda view.
8527 @subsubheading Setting limits for the agenda
8528 @cindex limits, in agenda
8529 @vindex org-agenda-max-entries
8530 @vindex org-agenda-max-effort
8531 @vindex org-agenda-max-todos
8532 @vindex org-agenda-max-tags
8534 Here is a list of options that you can set, either globally, or locally in
8535 your custom agenda views@pxref{Custom agenda views}.
8538 @item org-agenda-max-entries
8539 Limit the number of entries.
8540 @item org-agenda-max-effort
8541 Limit the duration of accumulated efforts (as minutes).
8542 @item org-agenda-max-todos
8543 Limit the number of entries with TODO keywords.
8544 @item org-agenda-max-tags
8545 Limit the number of tagged entries.
8548 When set to a positive integer, each option will exclude entries from other
8549 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8550 the agenda to 100 minutes of effort and exclude any entry that has no effort
8551 property. If you want to include entries with no effort property, use a
8552 negative value for @code{org-agenda-max-effort}.
8554 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8555 command. For example, this custom command will display the next five entries
8556 with a @code{NEXT} TODO keyword.
8559 (setq org-agenda-custom-commands
8561 ((org-agenda-max-entries 5)))))
8564 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8565 will again the next five entries again, including the first entry that was
8568 You can also dynamically set temporary limits@footnote{Those temporary limits
8569 are lost when rebuilding the agenda.}:
8572 @orgcmd{~,org-agenda-limit-interactively}
8573 This prompts for the type of limit to apply and its value.
8576 @node Agenda commands
8577 @section Commands in the agenda buffer
8578 @cindex commands, in agenda buffer
8580 Entries in the agenda buffer are linked back to the Org file or diary
8581 file where they originate. You are not allowed to edit the agenda
8582 buffer itself, but commands are provided to show and jump to the
8583 original entry location, and to edit the Org files ``remotely'' from
8584 the agenda buffer. In this way, all information is stored only once,
8585 removing the risk that your agenda and note files may diverge.
8587 Some commands can be executed with mouse clicks on agenda lines. For
8588 the other commands, the cursor needs to be in the desired line.
8591 @tsubheading{Motion}
8592 @cindex motion commands in agenda
8593 @orgcmd{n,org-agenda-next-line}
8594 Next line (same as @key{down} and @kbd{C-n}).
8595 @orgcmd{p,org-agenda-previous-line}
8596 Previous line (same as @key{up} and @kbd{C-p}).
8597 @tsubheading{View/Go to Org file}
8598 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8599 Display the original location of the item in another window.
8600 With prefix arg, make sure that the entire entry is made visible in the
8601 outline, not only the heading.
8603 @orgcmd{L,org-agenda-recenter}
8604 Display original location and recenter that window.
8606 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8607 Go to the original location of the item in another window.
8609 @orgcmd{@key{RET},org-agenda-switch-to}
8610 Go to the original location of the item and delete other windows.
8612 @orgcmd{F,org-agenda-follow-mode}
8613 @vindex org-agenda-start-with-follow-mode
8614 Toggle Follow mode. In Follow mode, as you move the cursor through
8615 the agenda buffer, the other window always shows the corresponding
8616 location in the Org file. The initial setting for this mode in new
8617 agenda buffers can be set with the variable
8618 @code{org-agenda-start-with-follow-mode}.
8620 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8621 Display the entire subtree of the current item in an indirect buffer. With a
8622 numeric prefix argument N, go up to level N and then take that tree. If N is
8623 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8624 previously used indirect buffer.
8626 @orgcmd{C-c C-o,org-agenda-open-link}
8627 Follow a link in the entry. This will offer a selection of any links in the
8628 text belonging to the referenced Org node. If there is only one link, it
8629 will be followed without a selection prompt.
8631 @tsubheading{Change display}
8632 @cindex display changing, in agenda
8635 Interactively select another agenda view and append it to the current view.
8639 Delete other windows.
8641 @orgcmdkskc{v d,d,org-agenda-day-view}
8642 @xorgcmdkskc{v w,w,org-agenda-week-view}
8643 @xorgcmd{v t,org-agenda-fortnight-view}
8644 @xorgcmd{v m,org-agenda-month-view}
8645 @xorgcmd{v y,org-agenda-year-view}
8646 @xorgcmd{v SPC,org-agenda-reset-view}
8647 @vindex org-agenda-span
8648 Switch to day/week/month/year view. When switching to day or week view, this
8649 setting becomes the default for subsequent agenda refreshes. Since month and
8650 year views are slow to create, they do not become the default. A numeric
8651 prefix argument may be used to jump directly to a specific day of the year,
8652 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8653 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8654 month view, a year may be encoded in the prefix argument as well. For
8655 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8656 specification has only one or two digits, it will be mapped to the interval
8657 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8658 @code{org-agenda-span}.
8660 @orgcmd{f,org-agenda-later}
8661 Go forward in time to display the following @code{org-agenda-current-span} days.
8662 For example, if the display covers a week, switch to the following week.
8663 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8665 @orgcmd{b,org-agenda-earlier}
8666 Go backward in time to display earlier dates.
8668 @orgcmd{.,org-agenda-goto-today}
8671 @orgcmd{j,org-agenda-goto-date}
8672 Prompt for a date and go there.
8674 @orgcmd{J,org-agenda-clock-goto}
8675 Go to the currently clocked-in task @i{in the agenda buffer}.
8677 @orgcmd{D,org-agenda-toggle-diary}
8678 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8680 @orgcmdkskc{v l,l,org-agenda-log-mode}
8682 @vindex org-log-done
8683 @vindex org-agenda-log-mode-items
8684 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8685 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8686 entries that have been clocked on that day. You can configure the entry
8687 types that should be included in log mode using the variable
8688 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8689 all possible logbook entries, including state changes. When called with two
8690 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8691 @kbd{v L} is equivalent to @kbd{C-u v l}.
8693 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8694 Include inactive timestamps into the current view. Only for weekly/daily
8695 agenda and timeline views.
8697 @orgcmd{v a,org-agenda-archives-mode}
8698 @xorgcmd{v A,org-agenda-archives-mode 'files}
8699 Toggle Archives mode. In Archives mode, trees that are marked
8700 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8701 capital @kbd{A}, even all archive files are included. To exit archives mode,
8702 press @kbd{v a} again.
8704 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8705 @vindex org-agenda-start-with-clockreport-mode
8706 @vindex org-clock-report-include-clocking-task
8707 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8708 always show a table with the clocked times for the time span and file scope
8709 covered by the current agenda view. The initial setting for this mode in new
8710 agenda buffers can be set with the variable
8711 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8712 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8713 contributions from entries that are hidden by agenda filtering@footnote{Only
8714 tags filtering will be respected here, effort filtering is ignored.}. See
8715 also the variable @code{org-clock-report-include-clocking-task}.
8718 @vindex org-agenda-clock-consistency-checks
8719 Show overlapping clock entries, clocking gaps, and other clocking problems in
8720 the current agenda range. You can then visit clocking lines and fix them
8721 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8722 information on how to customize the definition of what constituted a clocking
8723 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8726 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8727 @vindex org-agenda-start-with-entry-text-mode
8728 @vindex org-agenda-entry-text-maxlines
8729 Toggle entry text mode. In entry text mode, a number of lines from the Org
8730 outline node referenced by an agenda line will be displayed below the line.
8731 The maximum number of lines is given by the variable
8732 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8733 prefix argument will temporarily modify that number to the prefix value.
8735 @orgcmd{G,org-agenda-toggle-time-grid}
8736 @vindex org-agenda-use-time-grid
8737 @vindex org-agenda-time-grid
8738 Toggle the time grid on and off. See also the variables
8739 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8741 @orgcmd{r,org-agenda-redo}
8742 Recreate the agenda buffer, for example to reflect the changes after
8743 modification of the timestamps of items with @kbd{S-@key{left}} and
8744 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8745 argument is interpreted to create a selective list for a specific TODO
8747 @orgcmd{g,org-agenda-redo}
8750 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8751 Save all Org buffers in the current Emacs session, and also the locations of
8754 @orgcmd{C-c C-x C-c,org-agenda-columns}
8755 @vindex org-columns-default-format
8756 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8757 view format is taken from the entry at point, or (if there is no entry at
8758 point), from the first entry in the agenda view. So whatever the format for
8759 that entry would be in the original buffer (taken from a property, from a
8760 @code{#+COLUMNS} line, or from the default variable
8761 @code{org-columns-default-format}), will be used in the agenda.
8763 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8764 Remove the restriction lock on the agenda, if it is currently restricted to a
8765 file or subtree (@pxref{Agenda files}).
8767 @tsubheading{Secondary filtering and query editing}
8769 For a detailed description of these commands, see @pxref{Filtering/limiting
8772 @orgcmd{/,org-agenda-filter-by-tag}
8773 @vindex org-agenda-tag-filter-preset
8774 Filter the agenda view with respect to a tag and/or effort estimates.
8776 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8777 Narrow the current agenda filter by an additional condition.
8779 @orgcmd{<,org-agenda-filter-by-category}
8780 @vindex org-agenda-category-filter-preset
8782 Filter the current agenda view with respect to the category of the item at
8783 point. Pressing @code{<} another time will remove this filter.
8785 @orgcmd{^,org-agenda-filter-by-top-headline}
8786 Filter the current agenda view and only display the siblings and the parent
8787 headline of the one at point.
8789 @orgcmd{=,org-agenda-filter-by-regexp}
8790 @vindex org-agenda-regexp-filter-preset
8792 Filter the agenda view by a regular expression: only show agenda entries
8793 matching the regular expression the user entered. When called with a prefix
8794 argument, it will filter @emph{out} entries matching the regexp. With two
8795 universal prefix arguments, it will remove all the regexp filters, which can
8796 be accumulated. You can add a filter preset through the option
8797 @code{org-agenda-category-filter-preset} (see below.)
8799 @orgcmd{|,org-agenda-filter-remove-all}
8800 Remove all filters in the current agenda view.
8802 @tsubheading{Remote editing}
8803 @cindex remote editing, from agenda
8808 @cindex undoing remote-editing events
8809 @cindex remote editing, undo
8810 @orgcmd{C-_,org-agenda-undo}
8811 Undo a change due to a remote editing command. The change is undone
8812 both in the agenda buffer and in the remote buffer.
8814 @orgcmd{t,org-agenda-todo}
8815 Change the TODO state of the item, both in the agenda and in the
8818 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8819 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8820 Switch to the next/previous set of TODO keywords.
8822 @orgcmd{C-k,org-agenda-kill}
8823 @vindex org-agenda-confirm-kill
8824 Delete the current agenda item along with the entire subtree belonging
8825 to it in the original Org file. If the text to be deleted remotely
8826 is longer than one line, the kill needs to be confirmed by the user. See
8827 variable @code{org-agenda-confirm-kill}.
8829 @orgcmd{C-c C-w,org-agenda-refile}
8830 Refile the entry at point.
8832 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8833 @vindex org-archive-default-command
8834 Archive the subtree corresponding to the entry at point using the default
8835 archiving command set in @code{org-archive-default-command}. When using the
8836 @code{a} key, confirmation will be required.
8838 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8839 Toggle the ARCHIVE tag for the current headline.
8841 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8842 Move the subtree corresponding to the current entry to its @emph{archive
8845 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8846 Archive the subtree corresponding to the current headline. This means the
8847 entry will be moved to the configured archive location, most likely a
8850 @orgcmd{T,org-agenda-show-tags}
8851 @vindex org-agenda-show-inherited-tags
8852 Show all tags associated with the current item. This is useful if you have
8853 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8854 tags of a headline occasionally.
8856 @orgcmd{:,org-agenda-set-tags}
8857 Set tags for the current headline. If there is an active region in the
8858 agenda, change a tag for all headings in the region.
8862 Set the priority for the current item (@command{org-agenda-priority}).
8863 Org mode prompts for the priority character. If you reply with @key{SPC},
8864 the priority cookie is removed from the entry.
8866 @orgcmd{P,org-agenda-show-priority}
8867 Display weighted priority of current item.
8869 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8870 Increase the priority of the current item. The priority is changed in
8871 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8874 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8875 Decrease the priority of the current item.
8877 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8878 @vindex org-log-into-drawer
8879 Add a note to the entry. This note will be recorded, and then filed to the
8880 same location where state change notes are put. Depending on
8881 @code{org-log-into-drawer}, this may be inside a drawer.
8883 @orgcmd{C-c C-a,org-attach}
8884 Dispatcher for all command related to attachments.
8886 @orgcmd{C-c C-s,org-agenda-schedule}
8887 Schedule this item. With prefix arg remove the scheduling timestamp
8889 @orgcmd{C-c C-d,org-agenda-deadline}
8890 Set a deadline for this item. With prefix arg remove the deadline.
8892 @orgcmd{S-@key{right},org-agenda-do-date-later}
8893 Change the timestamp associated with the current line by one day into the
8894 future. If the date is in the past, the first call to this command will move
8896 With a numeric prefix argument, change it by that many days. For example,
8897 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8898 change the time by one hour. If you immediately repeat the command, it will
8899 continue to change hours even without the prefix arg. With a double @kbd{C-u
8900 C-u} prefix, do the same for changing minutes.@*
8901 The stamp is changed in the original Org file, but the change is not directly
8902 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8904 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8905 Change the timestamp associated with the current line by one day
8908 @orgcmd{>,org-agenda-date-prompt}
8909 Change the timestamp associated with the current line. The key @kbd{>} has
8910 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8912 @orgcmd{I,org-agenda-clock-in}
8913 Start the clock on the current item. If a clock is running already, it
8916 @orgcmd{O,org-agenda-clock-out}
8917 Stop the previously started clock.
8919 @orgcmd{X,org-agenda-clock-cancel}
8920 Cancel the currently running clock.
8922 @orgcmd{J,org-agenda-clock-goto}
8923 Jump to the running clock in another window.
8925 @orgcmd{k,org-agenda-capture}
8926 Like @code{org-capture}, but use the date at point as the default date for
8927 the capture template. See @code{org-capture-use-agenda-date} to make this
8928 the default behavior of @code{org-capture}.
8929 @cindex capturing, from agenda
8930 @vindex org-capture-use-agenda-date
8932 @tsubheading{Dragging agenda lines forward/backward}
8933 @cindex dragging, agenda lines
8935 @orgcmd{M-<up>,org-agenda-drag-line-backward}
8936 Drag the line at point backward one line@footnote{Moving agenda lines does
8937 not persist after an agenda refresh and does not modify the contributing
8938 @file{.org} files}. With a numeric prefix argument, drag backward by that
8941 @orgcmd{M-<down>,org-agenda-drag-line-forward}
8942 Drag the line at point forward one line. With a numeric prefix argument,
8943 drag forward by that many lines.
8945 @tsubheading{Bulk remote editing selected entries}
8946 @cindex remote editing, bulk, from agenda
8947 @vindex org-agenda-bulk-custom-functions
8949 @orgcmd{m,org-agenda-bulk-mark}
8950 Mark the entry at point for bulk action. With numeric prefix argument, mark
8951 that many successive entries.
8953 @orgcmd{*,org-agenda-bulk-mark-all}
8954 Mark all visible agenda entries for bulk action.
8956 @orgcmd{u,org-agenda-bulk-unmark}
8957 Unmark entry at point for bulk action.
8959 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8960 Unmark all marked entries for bulk action.
8962 @orgcmd{M-m,org-agenda-bulk-toggle}
8963 Toggle mark of the entry at point for bulk action.
8965 @orgcmd{M-*,org-agenda-bulk-toggle-all}
8966 Toggle marks of all visible entries for bulk action.
8968 @orgcmd{%,org-agenda-bulk-mark-regexp}
8969 Mark entries matching a regular expression for bulk action.
8971 @orgcmd{B,org-agenda-bulk-action}
8972 Bulk action: act on all marked entries in the agenda. This will prompt for
8973 another key to select the action to be applied. The prefix arg to @kbd{B}
8974 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8975 these special timestamps. By default, marks are removed after the bulk. If
8976 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8977 @code{t} or hit @kbd{p} at the prompt.
8981 Toggle persistent marks.
8983 Archive all selected entries.
8985 Archive entries by moving them to their respective archive siblings.
8987 Change TODO state. This prompts for a single TODO keyword and changes the
8988 state of all selected entries, bypassing blocking and suppressing logging
8989 notes (but not timestamps).
8991 Add a tag to all selected entries.
8993 Remove a tag from all selected entries.
8995 Schedule all items to a new date. To shift existing schedule dates by a
8996 fixed number of days, use something starting with double plus at the prompt,
8997 for example @samp{++8d} or @samp{++2w}.
8999 Set deadline to a specific date.
9001 Prompt for a single refile target and move all entries. The entries will no
9002 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9004 Reschedule randomly into the coming N days. N will be prompted for. With
9005 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9007 Apply a function@footnote{You can also create persistent custom functions
9008 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
9009 example, the function below sets the CATEGORY property of the entries to web.
9013 (defun set-category ()
9015 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9016 (org-agenda-error)))
9017 (buffer (marker-buffer marker)))
9018 (with-current-buffer buffer
9023 (org-back-to-heading t)
9024 (org-set-property "CATEGORY" "web"))))))
9029 @tsubheading{Calendar commands}
9030 @cindex calendar commands, from agenda
9032 @orgcmd{c,org-agenda-goto-calendar}
9033 Open the Emacs calendar and move to the date at the agenda cursor.
9035 @orgcmd{c,org-calendar-goto-agenda}
9036 When in the calendar, compute and show the Org mode agenda for the
9039 @cindex diary entries, creating from agenda
9040 @orgcmd{i,org-agenda-diary-entry}
9041 @vindex org-agenda-diary-file
9042 Insert a new entry into the diary, using the date at the cursor and (for
9043 block entries) the date at the mark. This will add to the Emacs diary
9044 file@footnote{This file is parsed for the agenda when
9045 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9046 command in the calendar. The diary file will pop up in another window, where
9047 you can add the entry.
9049 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9050 Org will create entries (in Org mode syntax) in that file instead. Most
9051 entries will be stored in a date-based outline tree that will later make it
9052 easy to archive appointments from previous months/years. The tree will be
9053 built under an entry with a @code{DATE_TREE} property, or else with years as
9054 top-level entries. Emacs will prompt you for the entry text---if you specify
9055 it, the entry will be created in @code{org-agenda-diary-file} without further
9056 interaction. If you directly press @key{RET} at the prompt without typing
9057 text, the target file will be shown in another window for you to finish the
9058 entry there. See also the @kbd{k r} command.
9060 @orgcmd{M,org-agenda-phases-of-moon}
9061 Show the phases of the moon for the three months around current date.
9063 @orgcmd{S,org-agenda-sunrise-sunset}
9064 Show sunrise and sunset times. The geographical location must be set
9065 with calendar variables, see the documentation for the Emacs calendar.
9067 @orgcmd{C,org-agenda-convert-date}
9068 Convert the date at cursor into many other cultural and historic
9071 @orgcmd{H,org-agenda-holidays}
9072 Show holidays for three months around the cursor date.
9074 @item M-x org-icalendar-combine-agenda-files RET
9075 Export a single iCalendar file containing entries from all agenda files.
9076 This is a globally available command, and also available in the agenda menu.
9078 @tsubheading{Exporting to a file}
9079 @orgcmd{C-x C-w,org-agenda-write}
9080 @cindex exporting agenda views
9081 @cindex agenda views, exporting
9082 @vindex org-agenda-exporter-settings
9083 Write the agenda view to a file. Depending on the extension of the selected
9084 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9085 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9086 (any other extension). When exporting to Org, only the body of original
9087 headlines are exported, not subtrees or inherited tags. When called with a
9088 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9089 variable @code{org-agenda-exporter-settings} to set options for
9090 @file{ps-print} and for @file{htmlize} to be used during export.
9092 @tsubheading{Quit and Exit}
9093 @orgcmd{q,org-agenda-quit}
9094 Quit agenda, remove the agenda buffer.
9096 @cindex agenda files, removing buffers
9097 @orgcmd{x,org-agenda-exit}
9098 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9099 for the compilation of the agenda. Buffers created by the user to
9100 visit Org files will not be removed.
9104 @node Custom agenda views
9105 @section Custom agenda views
9106 @cindex custom agenda views
9107 @cindex agenda views, custom
9109 Custom agenda commands serve two purposes: to store and quickly access
9110 frequently used TODO and tags searches, and to create special composite
9111 agenda buffers. Custom agenda commands will be accessible through the
9112 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9115 * Storing searches:: Type once, use often
9116 * Block agenda:: All the stuff you need in a single buffer
9117 * Setting options:: Changing the rules
9120 @node Storing searches
9121 @subsection Storing searches
9123 The first application of custom searches is the definition of keyboard
9124 shortcuts for frequently used searches, either creating an agenda
9125 buffer, or a sparse tree (the latter covering of course only the current
9128 @vindex org-agenda-custom-commands
9129 @cindex agenda views, main example
9130 @cindex agenda, as an agenda views
9131 @cindex agenda*, as an agenda views
9132 @cindex tags, as an agenda view
9133 @cindex todo, as an agenda view
9139 Custom commands are configured in the variable
9140 @code{org-agenda-custom-commands}. You can customize this variable, for
9141 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9142 Lisp in @file{.emacs}. The following example contains all valid agenda
9147 (setq org-agenda-custom-commands
9150 ("w" todo "WAITING")
9151 ("W" todo-tree "WAITING")
9152 ("u" tags "+boss-urgent")
9153 ("v" tags-todo "+boss-urgent")
9154 ("U" tags-tree "+boss-urgent")
9155 ("f" occur-tree "\\<FIXME\\>")
9156 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9157 ("hl" tags "+home+Lisa")
9158 ("hp" tags "+home+Peter")
9159 ("hk" tags "+home+Kim")))
9164 The initial string in each entry defines the keys you have to press
9165 after the dispatcher command @kbd{C-c a} in order to access the command.
9166 Usually this will be just a single character, but if you have many
9167 similar commands, you can also define two-letter combinations where the
9168 first character is the same in several combinations and serves as a
9169 prefix key@footnote{You can provide a description for a prefix key by
9170 inserting a cons cell with the prefix and the description.}. The second
9171 parameter is the search type, followed by the string or regular
9172 expression to be used for the matching. The example above will
9177 as a global search for agenda entries planned@footnote{@emph{Planned} means
9178 here that these entries have some planning information attached to them, like
9179 a time-stamp, a scheduled or a deadline string. See
9180 @code{org-agenda-entry-types} on how to set what planning information will be
9181 taken into account.} this week/day.
9183 as a global search for agenda entries planned this week/day, but only those
9184 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9186 as a global search for TODO entries with @samp{WAITING} as the TODO
9189 as the same search, but only in the current buffer and displaying the
9190 results as a sparse tree
9192 as a global tags search for headlines marked @samp{:boss:} but not
9195 as the same search as @kbd{C-c a u}, but limiting the search to
9196 headlines that are also TODO items
9198 as the same search as @kbd{C-c a u}, but only in the current buffer and
9199 displaying the result as a sparse tree
9201 to create a sparse tree (again: current buffer only) with all entries
9202 containing the word @samp{FIXME}
9204 as a prefix command for a HOME tags search where you have to press an
9205 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9206 Peter, or Kim) as additional tag to match.
9209 Note that the @code{*-tree} agenda views need to be called from an
9210 Org buffer as they operate on the current buffer only.
9213 @subsection Block agenda
9214 @cindex block agenda
9215 @cindex agenda, with block views
9217 Another possibility is the construction of agenda views that comprise
9218 the results of @emph{several} commands, each of which creates a block in
9219 the agenda buffer. The available commands include @code{agenda} for the
9220 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9221 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9222 matching commands discussed above: @code{todo}, @code{tags}, and
9223 @code{tags-todo}. Here are two examples:
9227 (setq org-agenda-custom-commands
9228 '(("h" "Agenda and Home-related tasks"
9232 ("o" "Agenda and Office-related tasks"
9240 This will define @kbd{C-c a h} to create a multi-block view for stuff
9241 you need to attend to at home. The resulting agenda buffer will contain
9242 your agenda for the current week, all TODO items that carry the tag
9243 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9244 command @kbd{C-c a o} provides a similar view for office tasks.
9246 @node Setting options
9247 @subsection Setting options for custom commands
9248 @cindex options, for custom agenda views
9250 @vindex org-agenda-custom-commands
9251 Org mode contains a number of variables regulating agenda construction
9252 and display. The global variables define the behavior for all agenda
9253 commands, including the custom commands. However, if you want to change
9254 some settings just for a single custom view, you can do so. Setting
9255 options requires inserting a list of variable names and values at the
9256 right spot in @code{org-agenda-custom-commands}. For example:
9260 (setq org-agenda-custom-commands
9261 '(("w" todo "WAITING"
9262 ((org-agenda-sorting-strategy '(priority-down))
9263 (org-agenda-prefix-format " Mixed: ")))
9264 ("U" tags-tree "+boss-urgent"
9265 ((org-show-following-heading nil)
9266 (org-show-hierarchy-above nil)))
9268 ((org-agenda-files '("~org/notes.org"))
9269 (org-agenda-text-search-extra-files nil)))))
9274 Now the @kbd{C-c a w} command will sort the collected entries only by
9275 priority, and the prefix format is modified to just say @samp{ Mixed: }
9276 instead of giving the category of the entry. The sparse tags tree of
9277 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9278 headline hierarchy above the match, nor the headline following the match
9279 will be shown. The command @kbd{C-c a N} will do a text search limited
9280 to only a single file.
9282 @vindex org-agenda-custom-commands
9283 For command sets creating a block agenda,
9284 @code{org-agenda-custom-commands} has two separate spots for setting
9285 options. You can add options that should be valid for just a single
9286 command in the set, and options that should be valid for all commands in
9287 the set. The former are just added to the command entry; the latter
9288 must come after the list of command entries. Going back to the block
9289 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9290 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9291 the results for GARDEN tags query in the opposite order,
9292 @code{priority-up}. This would look like this:
9296 (setq org-agenda-custom-commands
9297 '(("h" "Agenda and Home-related tasks"
9301 ((org-agenda-sorting-strategy '(priority-up)))))
9302 ((org-agenda-sorting-strategy '(priority-down))))
9303 ("o" "Agenda and Office-related tasks"
9310 As you see, the values and parentheses setting is a little complex.
9311 When in doubt, use the customize interface to set this variable---it
9312 fully supports its structure. Just one caveat: when setting options in
9313 this interface, the @emph{values} are just Lisp expressions. So if the
9314 value is a string, you need to add the double-quotes around the value
9317 @vindex org-agenda-custom-commands-contexts
9318 To control whether an agenda command should be accessible from a specific
9319 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9320 say for example that you have an agenda command @code{"o"} displaying a view
9321 that you only need when reading emails. Then you would configure this option
9325 (setq org-agenda-custom-commands-contexts
9326 '(("o" (in-mode . "message-mode"))))
9329 You can also tell that the command key @code{"o"} should refer to another
9330 command key @code{"r"}. In that case, add this command key like this:
9333 (setq org-agenda-custom-commands-contexts
9334 '(("o" "r" (in-mode . "message-mode"))))
9337 See the docstring of the variable for more information.
9339 @node Exporting agenda views
9340 @section Exporting agenda views
9341 @cindex agenda views, exporting
9343 If you are away from your computer, it can be very useful to have a printed
9344 version of some agenda views to carry around. Org mode can export custom
9345 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9346 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9347 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9348 a PDF file will also create the postscript file.}, and iCalendar files. If
9349 you want to do this only occasionally, use the command
9352 @orgcmd{C-x C-w,org-agenda-write}
9353 @cindex exporting agenda views
9354 @cindex agenda views, exporting
9355 @vindex org-agenda-exporter-settings
9356 Write the agenda view to a file. Depending on the extension of the selected
9357 file name, the view will be exported as HTML (extension @file{.html} or
9358 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9359 @file{.ics}), or plain text (any other extension). Use the variable
9360 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9361 for @file{htmlize} to be used during export, for example
9363 @vindex org-agenda-add-entry-text-maxlines
9364 @vindex htmlize-output-type
9365 @vindex ps-number-of-columns
9366 @vindex ps-landscape-mode
9368 (setq org-agenda-exporter-settings
9369 '((ps-number-of-columns 2)
9370 (ps-landscape-mode t)
9371 (org-agenda-add-entry-text-maxlines 5)
9372 (htmlize-output-type 'css)))
9376 If you need to export certain agenda views frequently, you can associate
9377 any custom agenda command with a list of output file names
9378 @footnote{If you want to store standard views like the weekly agenda
9379 or the global TODO list as well, you need to define custom commands for
9380 them in order to be able to specify file names.}. Here is an example
9381 that first defines custom commands for the agenda and the global
9382 TODO list, together with a number of files to which to export them.
9383 Then we define two block agenda commands and specify file names for them
9384 as well. File names can be relative to the current working directory,
9389 (setq org-agenda-custom-commands
9390 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9391 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9392 ("h" "Agenda and Home-related tasks"
9397 ("~/views/home.html"))
9398 ("o" "Agenda and Office-related tasks"
9403 ("~/views/office.ps" "~/calendars/office.ics"))))
9407 The extension of the file name determines the type of export. If it is
9408 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9409 the buffer to HTML and save it to this file name. If the extension is
9410 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9411 Postscript output. If the extension is @file{.ics}, iCalendar export is
9412 run export over all files that were used to construct the agenda, and
9413 limit the export to entries listed in the agenda. Any other
9414 extension produces a plain ASCII file.
9416 The export files are @emph{not} created when you use one of those
9417 commands interactively because this might use too much overhead.
9418 Instead, there is a special command to produce @emph{all} specified
9422 @orgcmd{C-c a e,org-store-agenda-views}
9423 Export all agenda views that have export file names associated with
9427 You can use the options section of the custom agenda commands to also
9428 set options for the export commands. For example:
9431 (setq org-agenda-custom-commands
9433 ((ps-number-of-columns 2)
9434 (ps-landscape-mode t)
9435 (org-agenda-prefix-format " [ ] ")
9436 (org-agenda-with-colors nil)
9437 (org-agenda-remove-tags t))
9442 This command sets two options for the Postscript exporter, to make it
9443 print in two columns in landscape format---the resulting page can be cut
9444 in two and then used in a paper agenda. The remaining settings modify
9445 the agenda prefix to omit category and scheduling information, and
9446 instead include a checkbox to check off items. We also remove the tags
9447 to make the lines compact, and we don't want to use colors for the
9448 black-and-white printer. Settings specified in
9449 @code{org-agenda-exporter-settings} will also apply, but the settings
9450 in @code{org-agenda-custom-commands} take precedence.
9453 From the command line you may also use
9455 emacs -eval (org-batch-store-agenda-views) -kill
9458 or, if you need to modify some parameters@footnote{Quoting depends on the
9459 system you use, please check the FAQ for examples.}
9461 emacs -eval '(org-batch-store-agenda-views \
9462 org-agenda-span (quote month) \
9463 org-agenda-start-day "2007-11-01" \
9464 org-agenda-include-diary nil \
9465 org-agenda-files (quote ("~/org/project.org")))' \
9469 which will create the agenda views restricted to the file
9470 @file{~/org/project.org}, without diary entries and with a 30-day
9473 You can also extract agenda information in a way that allows further
9474 processing by other programs. See @ref{Extracting agenda information}, for
9478 @node Agenda column view
9479 @section Using column view in the agenda
9480 @cindex column view, in agenda
9481 @cindex agenda, column view
9483 Column view (@pxref{Column view}) is normally used to view and edit
9484 properties embedded in the hierarchical structure of an Org file. It can be
9485 quite useful to use column view also from the agenda, where entries are
9486 collected by certain criteria.
9489 @orgcmd{C-c C-x C-c,org-agenda-columns}
9490 Turn on column view in the agenda.
9493 To understand how to use this properly, it is important to realize that the
9494 entries in the agenda are no longer in their proper outline environment.
9495 This causes the following issues:
9499 @vindex org-columns-default-format
9500 @vindex org-overriding-columns-format
9501 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9502 entries in the agenda are collected from different files, and different files
9503 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9504 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9505 currently set, and if so, takes the format from there. Otherwise it takes
9506 the format associated with the first item in the agenda, or, if that item
9507 does not have a specific format (defined in a property, or in its file), it
9508 uses @code{org-columns-default-format}.
9510 @cindex property, special, CLOCKSUM
9511 If any of the columns has a summary type defined (@pxref{Column attributes}),
9512 turning on column view in the agenda will visit all relevant agenda files and
9513 make sure that the computations of this property are up to date. This is
9514 also true for the special @code{CLOCKSUM} property. Org will then sum the
9515 values displayed in the agenda. In the daily/weekly agenda, the sums will
9516 cover a single day; in all other views they cover the entire block. It is
9517 vital to realize that the agenda may show the same entry @emph{twice} (for
9518 example as scheduled and as a deadline), and it may show two entries from the
9519 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9520 cases, the summation in the agenda will lead to incorrect results because
9521 some values will count double.
9523 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9524 the entire clocked time for this item. So even in the daily/weekly agenda,
9525 the clocksum listed in column view may originate from times outside the
9526 current view. This has the advantage that you can compare these values with
9527 a column listing the planned total effort for a task---one of the major
9528 applications for column view in the agenda. If you want information about
9529 clocked time in the displayed period use clock table mode (press @kbd{R} in
9533 @cindex property, special, CLOCKSUM_T
9534 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9535 always today's clocked time for this item. So even in the weekly agenda,
9536 the clocksum listed in column view only originates from today. This lets
9537 you compare the time you spent on a task for today, with the time already
9538 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9543 @chapter Markup for rich export
9545 When exporting Org mode documents, the exporter tries to reflect the
9546 structure of the document as accurately as possible in the back-end. Since
9547 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9548 rules on how to prepare text for rich export. This section summarizes the
9549 markup rules used in an Org mode buffer.
9552 * Structural markup elements:: The basic structure as seen by the exporter
9553 * Images and tables:: Images, tables and caption mechanism
9554 * Literal examples:: Source code examples with special formatting
9555 * Include files:: Include additional files into a document
9556 * Index entries:: Making an index
9557 * Macro replacement:: Use macros to create templates
9558 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9559 * Special blocks:: Containers targeted at export back-ends
9562 @node Structural markup elements
9563 @section Structural markup elements
9566 * Document title:: Where the title is taken from
9567 * Headings and sections:: The document structure as seen by the exporter
9568 * Table of contents:: The if and where of the table of contents
9570 * Paragraphs:: Paragraphs
9571 * Footnote markup:: Footnotes
9572 * Emphasis and monospace:: Bold, italic, etc.
9573 * Horizontal rules:: Make a line
9574 * Comment lines:: What will *not* be exported
9577 @node Document title
9578 @subheading Document title
9579 @cindex document title, markup rules
9582 The title of the exported document is taken from the special line
9586 #+TITLE: This is the title of the document
9590 If this line does not exist, the title will be the name of the file
9591 associated with the buffer, without extension, or the buffer name.
9593 @cindex property, EXPORT_TITLE
9594 If you are exporting only a subtree, its heading will become the title of the
9595 document. If the subtree has a property @code{EXPORT_TITLE}, that will take
9598 @node Headings and sections
9599 @subheading Headings and sections
9600 @cindex headings and sections, markup rules
9602 @vindex org-export-headline-levels
9603 The outline structure of the document as described in @ref{Document
9604 structure}, forms the basis for defining sections of the exported document.
9605 However, since the outline structure is also used for (for example) lists of
9606 tasks, only the first three outline levels will be used as headings. Deeper
9607 levels will become itemized lists. You can change the location of this
9608 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9609 per-file basis with a line
9616 @node Table of contents
9617 @subheading Table of contents
9618 @cindex table of contents, markup rules
9621 @vindex org-export-with-toc
9622 The table of contents is normally inserted directly before the first headline
9623 of the file. The depth of the table is by default the same as the number of
9624 headline levels, but you can choose a smaller number, or turn off the table
9625 of contents entirely, by configuring the variable @code{org-export-with-toc},
9626 or on a per-file basis with a line like
9629 #+OPTIONS: toc:2 (only to two levels in TOC)
9630 #+OPTIONS: toc:nil (no default TOC at all)
9633 If you would like to move the table of contents to a different location, you
9634 should turn off the default table using @code{org-export-with-toc} or
9635 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9639 #+OPTIONS: toc:nil (no default TOC)
9641 #+TOC: headlines 2 (insert TOC here, with two headline levels)
9644 Multiple @code{#+TOC: headline} lines are allowed. The same @code{TOC}
9645 keyword can also generate a list of all tables (resp.@: all listings) with a
9646 caption in the buffer.
9649 #+TOC: listings (build a list of listings)
9650 #+TOC: tables (build a list of tables)
9653 @cindex property, ALT_TITLE
9654 The headline's title usually determines its corresponding entry in a table of
9655 contents. However, it is possible to specify an alternative title by
9656 setting @code{ALT_TITLE} property accordingly. It will then be used when
9661 @cindex lists, markup rules
9663 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9664 syntax for such lists. Most back-ends support unordered, ordered, and
9668 @subheading Paragraphs, line breaks, and quoting
9669 @cindex paragraphs, markup rules
9671 Paragraphs are separated by at least one empty line. If you need to enforce
9672 a line break within a paragraph, use @samp{\\} at the end of a line.
9674 To keep the line breaks in a region, but otherwise use normal formatting, you
9675 can use this construct, which can also be used to format poetry.
9677 @cindex #+BEGIN_VERSE
9680 Great clouds overhead
9681 Tiny black birds rise and fall
9688 When quoting a passage from another document, it is customary to format this
9689 as a paragraph that is indented on both the left and the right margin. You
9690 can include quotations in Org mode documents like this:
9692 @cindex #+BEGIN_QUOTE
9695 Everything should be made as simple as possible,
9696 but not any simpler -- Albert Einstein
9700 If you would like to center some text, do it like this:
9701 @cindex #+BEGIN_CENTER
9704 Everything should be made as simple as possible, \\
9710 @node Footnote markup
9711 @subheading Footnote markup
9712 @cindex footnotes, markup rules
9713 @cindex @file{footnote.el}
9715 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9716 by all back-ends. Org allows multiple references to the same note, and
9717 multiple footnotes side by side.
9719 @node Emphasis and monospace
9720 @subheading Emphasis and monospace
9722 @cindex underlined text, markup rules
9723 @cindex bold text, markup rules
9724 @cindex italic text, markup rules
9725 @cindex verbatim text, markup rules
9726 @cindex code text, markup rules
9727 @cindex strike-through text, markup rules
9728 @vindex org-fontify-emphasized-text
9729 @vindex org-emphasis-regexp-components
9730 @vindex org-emphasis-alist
9731 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9732 and @code{~code~}, and, if you must, @samp{+strike-through+}. Text
9733 in the code and verbatim string is not processed for Org mode specific
9734 syntax, it is exported verbatim.
9736 To turn off fontification for marked up text, you can set
9737 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9738 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9739 tune what characters are allowed before and after the markup characters, you
9740 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9741 the above variables will no take effect until you reload Org, for which you
9742 may need to restart Emacs.
9744 @node Horizontal rules
9745 @subheading Horizontal rules
9746 @cindex horizontal rules, markup rules
9747 A line consisting of only dashes, and at least 5 of them, will be exported as
9751 @subheading Comment lines
9752 @cindex comment lines
9753 @cindex exporting, not
9754 @cindex #+BEGIN_COMMENT
9756 Lines starting with zero or more whitespace characters followed by one
9757 @samp{#} and a whitespace are treated as comments and, as such, are not
9760 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9761 ... @samp{#+END_COMMENT} are not exported.
9763 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9764 other keyword or priority cookie, comments out the entire subtree. In this
9765 case, the subtree is not exported and no code block within it is executed
9766 either. The command below helps changing the comment status of a headline.
9771 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9775 @node Images and tables
9776 @section Images and Tables
9778 @cindex tables, markup rules
9781 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9782 the @file{table.el} package will be exported properly. For Org mode tables,
9783 the lines before the first horizontal separator line will become table header
9784 lines. You can use the following lines somewhere before the table to assign
9785 a caption and a label for cross references, and in the text you can refer to
9786 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9789 #+CAPTION: This is the caption for the next table (or link)
9790 #+NAME: tab:basic-data
9795 Optionally, the caption can take the form:
9797 #+CAPTION[Caption for list of tables]: Caption for table.
9800 @cindex inlined images, markup rules
9801 Some back-ends allow you to directly include images into the exported
9802 document. Org does this, if a link to an image files does not have
9803 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9804 define a caption for the image and maybe a label for internal cross
9805 references, make sure that the link is on a line by itself and precede it
9806 with @code{#+CAPTION} and @code{#+NAME} as follows:
9809 #+CAPTION: This is the caption for the next figure link (or table)
9810 #+NAME: fig:SED-HR4049
9815 Such images can be displayed within the buffer. @xref{Handling links,the
9816 discussion of image links}.
9818 Even though images and tables are prominent examples of captioned structures,
9819 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9820 equations, source code blocks). Depending on the export back-end, those may
9821 or may not be handled.
9823 @node Literal examples
9824 @section Literal examples
9825 @cindex literal examples, markup rules
9826 @cindex code line references, markup rules
9828 You can include literal examples that should not be subjected to
9829 markup. Such examples will be typeset in monospace, so this is well suited
9830 for source code and similar examples.
9831 @cindex #+BEGIN_EXAMPLE
9835 Some example from a text file.
9839 Note that such blocks may be @i{indented} in order to align nicely with
9840 indented text and in particular with plain list structure (@pxref{Plain
9841 lists}). For simplicity when using small examples, you can also start the
9842 example lines with a colon followed by a space. There may also be additional
9843 whitespace before the colon:
9847 : Some example from a text file.
9850 @cindex formatting source code, markup rules
9851 @vindex org-latex-listings
9852 If the example is source code from a programming language, or any other text
9853 that can be marked up by font-lock in Emacs, you can ask for the example to
9854 look like the fontified Emacs buffer@footnote{This works automatically for
9855 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9856 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9857 achieved using either the listings or the
9858 @url{http://code.google.com/p/minted, minted,} package. Refer to
9859 @code{org-latex-listings} documentation for details.}. This is done
9860 with the @samp{src} block, where you also need to specify the name of the
9861 major mode that should be used to fontify the example@footnote{Code in
9862 @samp{src} blocks may also be evaluated either interactively or on export.
9863 See @pxref{Working with source code} for more information on evaluating code
9864 blocks.}, see @ref{Easy templates} for shortcuts to easily insert code
9869 #+BEGIN_SRC emacs-lisp
9870 (defun org-xor (a b)
9876 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9877 switch to the end of the @code{BEGIN} line, to get the lines of the example
9878 numbered. If you use a @code{+n} switch, the numbering from the previous
9879 numbered snippet will be continued in the current one. In literal examples,
9880 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9881 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9882 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9883 link will remote-highlight the corresponding code line, which is kind of
9886 You can also add a @code{-r} switch which @i{removes} the labels from the
9887 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9888 labels in the source code while using line numbers for the links, which might
9889 be useful to explain those in an Org mode example code.}. With the @code{-n}
9890 switch, links to these references will be labeled by the line numbers from
9891 the code listing, otherwise links will use the labels with no parentheses.
9895 #+BEGIN_SRC emacs-lisp -n -r
9896 (save-excursion (ref:sc)
9897 (goto-char (point-min))) (ref:jump)
9899 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9903 @cindex indentation, in source blocks
9904 Finally, you can use @code{-i} to preserve the indentation of a specific code
9905 block (@pxref{Editing source code}).
9907 @vindex org-coderef-label-format
9908 If the syntax for the label format conflicts with the language syntax, use a
9909 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9910 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9912 HTML export also allows examples to be published as text areas (@pxref{Text
9913 areas in HTML export}).
9915 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9916 so often, shortcuts are provided using the Easy templates facility
9917 (@pxref{Easy templates}).
9922 Edit the source code example at point in its native mode. This works by
9923 switching to a temporary buffer with the source code. You need to exit by
9924 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9925 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9926 from being interpreted by Org as outline nodes or special syntax. These
9927 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9928 The edited version will then replace the old version in the Org buffer.
9929 Fixed-width regions (where each line starts with a colon followed by a space)
9930 will be edited using @code{artist-mode}@footnote{You may select
9931 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9932 to allow creating ASCII drawings easily. Using this command in an empty line
9933 will create a new fixed-width region.
9936 Calling @code{org-store-link} while editing a source code example in a
9937 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9938 that it is unique in the current buffer, and insert it with the proper
9939 formatting like @samp{(ref:label)} at the end of the current line. Then the
9940 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9945 @section Include files
9946 @cindex include files, markup rules
9948 During export, you can include the content of another file. For example, to
9949 include your @file{.emacs} file, you could use:
9953 #+INCLUDE: "~/.emacs" src emacs-lisp
9957 The optional second and third parameter are the markup (e.g., @samp{quote},
9958 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9959 language for formatting the contents.
9961 If no markup is given, the text will be assumed to be in Org mode format and
9962 will be processed normally. However, footnote labels (@pxref{Footnotes}) in
9963 the file will be made local to that file.
9965 Contents of the included file will belong to the same structure (headline,
9966 item) containing the @code{INCLUDE} keyword. In particular, headlines within
9967 the file will become children of the current section. That behavior can be
9968 changed by providing an additional keyword parameter, @code{:minlevel}. In
9969 that case, all headlines in the included file will be shifted so the one with
9970 the lowest level reaches that specified level. For example, to make a file
9971 become a sibling of the current top-level headline, use
9974 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
9977 You can also include a portion of a file by specifying a lines range using
9978 the @code{:lines} parameter. The line at the upper end of the range will not
9979 be included. The start and/or the end of the range may be omitted to use the
9983 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9984 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9985 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9991 Visit the include file at point.
9995 @section Index entries
9996 @cindex index entries, for publishing
9998 You can specify entries that will be used for generating an index during
9999 publishing. This is done by lines starting with @code{#+INDEX}. An entry
10000 the contains an exclamation mark will create a sub item. See @ref{Generating
10001 an index} for more information.
10006 #+INDEX: Application!CV
10012 @node Macro replacement
10013 @section Macro replacement
10014 @cindex macro replacement, during export
10017 You can define text snippets with
10020 #+MACRO: name replacement text $1, $2 are arguments
10023 @noindent which can be referenced
10024 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10025 commas within arguments have to be escaped with a backslash character.
10026 Conversely, backslash characters before a comma, and only them, need to be
10027 escaped with another backslash character.}.
10029 These references, called macros, can be inserted anywhere Org markup is
10030 recognized: paragraphs, headlines, verse and example blocks, tables cells,
10031 lists and comments. They cannot be used within ordinary keywords (starting
10032 with @code{#+:}) but are allowed in @code{#+CAPTION}, @code{#+TITLE},
10033 @code{#+AUTHOR} and @code{#+EMAIL}.
10035 In addition to user-defined macros, a set of already defined macros can be
10036 used: @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will
10037 reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
10038 similar lines. Also, @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10039 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
10040 and to the modification time of the file being exported, respectively.
10041 @var{FORMAT} should be a format string understood by
10042 @code{format-time-string}.
10044 The surrounding brackets can be made invisible by setting
10045 @code{org-hide-macro-markers} to @code{t}.
10047 Macro expansion takes place during export.
10050 @node Embedded @LaTeX{}
10051 @section Embedded @LaTeX{}
10052 @cindex @TeX{} interpretation
10053 @cindex @LaTeX{} interpretation
10055 Plain ASCII is normally sufficient for almost all note taking. Exceptions
10056 include scientific notes, which often require mathematical symbols and the
10057 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10058 Donald E. Knuth's @TeX{} system. Many of the features described here as
10059 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10060 distinction.} is widely used to typeset scientific documents. Org mode
10061 supports embedding @LaTeX{} code into its files, because many academics are
10062 used to writing and reading @LaTeX{} source code, and because it can be
10063 readily processed to produce pretty output for a number of export back-ends.
10066 * Special symbols:: Greek letters and other symbols
10067 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10068 * @LaTeX{} fragments:: Complex formulas made easy
10069 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10070 * CDLaTeX mode:: Speed up entering of formulas
10073 @node Special symbols
10074 @subsection Special symbols
10075 @cindex math symbols
10076 @cindex special symbols
10077 @cindex @TeX{} macros
10078 @cindex @LaTeX{} fragments, markup rules
10079 @cindex HTML entities
10080 @cindex @LaTeX{} entities
10082 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10083 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10084 for these symbols is available, just type @samp{\} and maybe a few letters,
10085 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10086 code, Org mode allows these symbols to be present without surrounding math
10087 delimiters, for example:
10090 Angles are written as Greek letters \alpha, \beta and \gamma.
10093 @vindex org-entities
10094 During export, these symbols will be transformed into the native format of
10095 the exporter back-end. Strings like @code{\alpha} will be exported as
10096 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
10097 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10098 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10099 like this: @samp{\Aacute@{@}stor}.
10101 A large number of entities is provided, with names taken from both HTML and
10102 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10103 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10104 @samp{...} are all converted into special commands creating hyphens of
10105 different lengths or a compact set of dots.
10107 If you would like to see entities displayed as UTF-8 characters, use the
10108 following command@footnote{You can turn this on by default by setting the
10109 variable @code{org-pretty-entities}, or on a per-file base with the
10110 @code{#+STARTUP} option @code{entitiespretty}.}:
10113 @cindex @code{entitiespretty}, STARTUP keyword
10116 Toggle display of entities as UTF-8 characters. This does not change the
10117 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10118 for display purposes only.
10121 @node Subscripts and superscripts
10122 @subsection Subscripts and superscripts
10124 @cindex superscript
10126 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10127 subscripts. Again, these can be used without embedding them in math-mode
10128 delimiters. To increase the readability of ASCII text, it is not necessary
10129 (but OK) to surround multi-character sub- and superscripts with curly braces.
10133 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10134 the sun is R_@{sun@} = 6.96 x 10^8 m.
10137 @vindex org-use-sub-superscripts
10138 If you write a text where the underscore is often used in a different
10139 context, Org's convention to always interpret these as subscripts can get in
10140 your way. Configure the variable @code{org-use-sub-superscripts} to change
10141 this convention. For example, when setting this variable to @code{@{@}},
10142 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10147 In addition to showing entities as UTF-8 characters, this command will also
10148 format sub- and superscripts in a WYSIWYM way.
10151 @node @LaTeX{} fragments
10152 @subsection @LaTeX{} fragments
10153 @cindex @LaTeX{} fragments
10155 @vindex org-format-latex-header
10156 Going beyond symbols and sub- and superscripts, a full formula language is
10157 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10158 to process these for several export back-ends. When exporting to @LaTeX{},
10159 the code is obviously left as it is. When exporting to HTML, Org can invoke
10160 the @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10161 HTML export}) to process and display the math@footnote{If you plan to use
10162 this regularly or on pages with significant page views, you should install
10163 @file{MathJax} on your own server in order to limit the load of our server.}.
10164 It can also process the mathematical expressions into images that can be
10165 displayed in a browser (see @pxref{Previewing @LaTeX{} fragments}).
10167 @LaTeX{} fragments don't need any special marking at all. The following
10168 snippets will be identified as @LaTeX{} source code:
10171 Environments of any kind@footnote{When @file{MathJax} is used, only the
10172 environments recognized by @file{MathJax} will be processed. When
10173 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10174 any @LaTeX{} environment will be handled.}. The only requirement is that the
10175 @code{\begin} and @code{\end} statements appear on a new line, at the
10176 beginning of the line or after whitespaces only.
10178 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10179 currency specifications, single @samp{$} characters are only recognized as
10180 math delimiters if the enclosed text contains at most two line breaks, is
10181 directly attached to the @samp{$} characters with no whitespace in between,
10182 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10183 For the other delimiters, there is no such restriction, so when in doubt, use
10184 @samp{\(...\)} as inline math delimiters.
10187 @noindent For example:
10194 If $a^2=b$ and \( b=2 \), then the solution must be
10195 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10200 @c @vindex org-format-latex-options
10201 @c If you need any of the delimiter ASCII sequences for other purposes, you
10202 @c can configure the option @code{org-format-latex-options} to deselect the
10203 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10205 @vindex org-export-with-latex
10206 @LaTeX{} processing can be configured with the variable
10207 @code{org-export-with-latex}. The default setting is @code{t} which means
10208 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10209 You can also set this variable on a per-file basis using one of these
10213 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10214 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10215 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10218 @node Previewing @LaTeX{} fragments
10219 @subsection Previewing @LaTeX{} fragments
10220 @cindex @LaTeX{} fragments, preview
10222 @vindex org-latex-create-formula-image-program
10223 If you have a working @LaTeX{} installation and either @file{dvipng} or
10224 @file{convert} installed@footnote{These are respectively available at
10225 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10226 suite. Choose the converter by setting the variable
10227 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10228 fragments can be processed to produce images of the typeset expressions to be
10229 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10230 or for inline previewing within Org mode.
10232 @vindex org-format-latex-options
10233 @vindex org-format-latex-header
10234 You can customize the variables @code{org-format-latex-options} and
10235 @code{org-format-latex-header} to influence some aspects of the preview. In
10236 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10237 property of the former can be used to adjust the size of the preview images.
10240 @kindex C-c C-x C-l
10242 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10243 over the source code. If there is no fragment at point, process all
10244 fragments in the current entry (between two headlines). When called
10245 with a prefix argument, process the entire subtree. When called with
10246 two prefix arguments, or when the cursor is before the first headline,
10247 process the entire buffer.
10250 Remove the overlay preview images.
10253 @vindex org-startup-with-latex-preview
10254 You can turn on the previewing of all @LaTeX{} fragments in a file with
10257 #+STARTUP: latexpreview
10260 To disable it, simply use
10263 #+STARTUP: nolatexpreview
10267 @subsection Using CD@LaTeX{} to enter math
10270 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10271 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10272 environments and math templates. Inside Org mode, you can make use of
10273 some of the features of CD@LaTeX{} mode. You need to install
10274 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10275 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10276 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10277 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10278 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10282 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10285 When this mode is enabled, the following features are present (for more
10286 details see the documentation of CD@LaTeX{} mode):
10290 Environment templates can be inserted with @kbd{C-c @{}.
10293 The @key{TAB} key will do template expansion if the cursor is inside a
10294 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10295 inside such a fragment, see the documentation of the function
10296 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10297 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10298 correctly inside the first brace. Another @key{TAB} will get you into
10299 the second brace. Even outside fragments, @key{TAB} will expand
10300 environment abbreviations at the beginning of a line. For example, if
10301 you write @samp{equ} at the beginning of a line and press @key{TAB},
10302 this abbreviation will be expanded to an @code{equation} environment.
10303 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10307 @vindex cdlatex-simplify-sub-super-scripts
10308 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10309 characters together with a pair of braces. If you use @key{TAB} to move
10310 out of the braces, and if the braces surround only a single character or
10311 macro, they are removed again (depending on the variable
10312 @code{cdlatex-simplify-sub-super-scripts}).
10315 Pressing the backquote @kbd{`} followed by a character inserts math
10316 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10317 after the backquote, a help window will pop up.
10320 Pressing the single-quote @kbd{'} followed by another character modifies
10321 the symbol before point with an accent or a font. If you wait more than
10322 1.5 seconds after the single-quote, a help window will pop up. Character
10323 modification will work only inside @LaTeX{} fragments; outside the quote
10327 @node Special blocks
10328 @section Special blocks
10329 @cindex Special blocks
10331 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10332 examples}). It is also possible to create blocks containing raw code
10333 targeted at a specific back-end (e.g., @samp{#+BEGIN_LATEX}).
10335 Any other block is a @emph{special block}.
10337 For example, @samp{#+BEGIN_ABSTRACT} and @samp{#+BEGIN_VIDEO} are special
10338 blocks. The first one is useful when exporting to @LaTeX{}, the second one
10339 when exporting to HTML5.
10341 Each export back-end decides if they should be exported, and how. When the
10342 block is ignored, its contents are still exported, as if the opening and
10343 closing block lines were not there. For example, when exporting a
10344 @samp{#+BEGIN_TEST} block, HTML back-end wraps its contents within a
10345 @samp{<div name="test">} tag.
10347 Refer to back-end specific documentation for more information.
10353 The Org mode export facilities can be used to export Org documents or parts
10354 of Org documents to a variety of other formats. In addition, these
10355 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10356 in foreign buffers so you can author tables and lists in Org syntax and
10357 convert them in place to the target language.
10359 ASCII export produces a readable and simple version of an Org file for
10360 printing and sharing notes. HTML export allows you to easily publish notes
10361 on the web, or to build full-fledged websites. @LaTeX{} export lets you use
10362 Org mode and its structured editing functions to create arbitrarily complex
10363 @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export
10364 allows seamless collaboration across organizational boundaries. Markdown
10365 export lets you seamlessly collaborate with other developers. Finally, iCal
10366 export can extract entries with deadlines or appointments to produce a file
10367 in the iCalendar format.
10370 * The export dispatcher:: The main exporter interface
10371 * Export back-ends:: Built-in export formats
10372 * Export settings:: Generic export settings
10373 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10374 * Beamer export:: Exporting as a Beamer presentation
10375 * HTML export:: Exporting to HTML
10376 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
10377 * Markdown export:: Exporting to Markdown
10378 * OpenDocument text export:: Exporting to OpenDocument Text
10379 * Org export:: Exporting to Org
10380 * iCalendar export:: Exporting to iCalendar
10381 * Other built-in back-ends:: Exporting to @code{Texinfo} or a man page
10382 * Export in foreign buffers:: Author tables and lists in Org syntax
10383 * Advanced configuration:: Fine-tuning the export output
10386 @node The export dispatcher
10387 @section The export dispatcher
10388 @vindex org-export-dispatch-use-expert-ui
10389 @cindex Export, dispatcher
10391 The main entry point for export related tasks is the dispatcher, a
10392 hierarchical menu from which it is possible to select an export format and
10393 toggle export options@footnote{It is also possible to use a less intrusive
10394 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10395 non-@code{nil} value. In that case, only a prompt is visible from the
10396 minibuffer. From there one can still switch back to regular menu by pressing
10397 @key{?}.} from which it is possible to select an export format and to toggle
10402 @orgcmd{C-c C-e,org-export-dispatch}
10404 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10405 prefix argument, repeat the last export command on the current buffer while
10406 preserving toggled options. If the current buffer hasn't changed and subtree
10407 export was activated, the command will affect that same subtree.
10411 Normally the entire buffer is exported, but if there is an active region
10412 only that part of the buffer will be exported.
10414 Several export options (@pxref{Export settings}) can be toggled from the
10415 export dispatcher with the following key combinations:
10419 @vindex org-export-async-init-file
10420 Toggle asynchronous export. Asynchronous export uses an external Emacs
10421 process that is configured with a specified initialization file.
10423 While exporting asynchronously, the output is not displayed, but stored in
10424 a place called ``the export stack''. This stack can be displayed by calling
10425 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10426 from the dispatcher menu.
10428 @vindex org-export-in-background
10429 To make this behavior the default, customize the variable
10430 @code{org-export-in-background}.
10433 Toggle body-only export. Its effect depends on the back-end used.
10434 Typically, if the back-end has a header section (like @code{<head>...</head>}
10435 in the HTML back-end), a body-only export will not include this header.
10438 @vindex org-export-initial-scope
10439 Toggle subtree export. The top heading becomes the document title.
10441 You can change the default state of this option by setting
10442 @code{org-export-initial-scope}.
10445 Toggle visible-only export. Only export the text that is currently
10446 visible, i.e. not hidden by outline visibility in the buffer.
10449 @node Export back-ends
10450 @section Export back-ends
10451 @cindex Export, back-ends
10453 An export back-end is a library that translates Org syntax into a foreign
10454 format. An export format is not available until the proper back-end has been
10457 @vindex org-export-backends
10458 By default, the following four back-ends are loaded: @code{ascii},
10459 @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
10460 (or remove some) by customizing @code{org-export-backends}.
10462 Built-in back-ends include:
10465 @item ascii (ASCII format)
10466 @item beamer (@LaTeX{} Beamer format)
10467 @item html (HTML format)
10468 @item icalendar (iCalendar format)
10469 @item latex (@LaTeX{} format)
10470 @item man (Man page format)
10471 @item md (Markdown format)
10472 @item odt (OpenDocument Text format)
10473 @item org (Org format)
10474 @item texinfo (Texinfo format)
10477 Other back-ends might be found in the @code{contrib/} directory
10478 (@pxref{Installation}).
10480 @node Export settings
10481 @section Export settings
10482 @cindex Export, settings
10485 Export options can be set: globally with variables; for an individual file by
10486 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10487 settings}), by setting individual keywords, or by specifying them in a
10488 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10489 properties (@pxref{Properties and columns}). Options set at a specific level
10490 override options set at a more general level.
10492 @cindex #+SETUPFILE
10493 In-buffer settings may appear anywhere in the file, either directly or
10494 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10495 Option keyword sets tailored to a particular back-end can be inserted from
10496 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10497 template} command by pressing @key{#}. To insert keywords individually,
10498 a good way to make sure the keyword is correct is to type @code{#+} and then
10499 to use @kbd{M-<TAB>} for completion.
10501 The export keywords available for every back-end, and their equivalent global
10502 variables, include:
10507 @vindex user-full-name
10508 The document author (@code{user-full-name}).
10512 @vindex org-export-creator-string
10513 Entity responsible for output generation (@code{org-export-creator-string}).
10517 @vindex org-export-date-timestamp-format
10518 A date or a time-stamp@footnote{The variable
10519 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10523 @cindex #+DESCRIPTION
10524 The document description. Back-ends handle it as they see fit (e.g., for the
10525 XHTML meta tag), if at all. You can use several such keywords for long
10530 @vindex user-mail-address
10531 The email address (@code{user-mail-address}).
10535 The keywords defining the contents of the document. Back-ends handle it as
10536 they see fit (e.g., for the XHTML meta tag), if at all. You can use several
10537 such keywords if the list is long.
10541 @vindex org-export-default-language
10542 The language used for translating some strings
10543 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10544 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10548 @cindex #+SELECT_TAGS
10549 @vindex org-export-select-tags
10550 The tags that select a tree for export (@code{org-export-select-tags}). The
10551 default value is @code{:export:}. Within a subtree tagged with
10552 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10553 below). When headlines are selectively exported with @code{:export:}
10554 anywhere in a file, text before the first headline is ignored.
10557 @cindex #+EXCLUDE_TAGS
10558 @vindex org-export-exclude-tags
10559 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10560 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10561 tag will be unconditionally excluded from the export, even if they have an
10562 @code{:export:} tag. Code blocks contained in excluded subtrees will still
10563 be executed during export even though the subtree is not exported.
10567 The title to be shown (otherwise derived from buffer's name). You can use
10568 several such keywords for long titles.
10571 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10572 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10573 recognizes the following arguments:
10577 @vindex org-export-with-smart-quotes
10578 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10581 Toggle emphasized text (@code{org-export-with-emphasize}).
10584 @vindex org-export-with-special-strings
10585 Toggle conversion of special strings
10586 (@code{org-export-with-special-strings}).
10589 @vindex org-export-with-fixed-width
10590 Toggle fixed-width sections
10591 (@code{org-export-with-fixed-width}).
10594 @vindex org-export-with-timestamps
10595 Toggle inclusion of any time/date active/inactive stamps
10596 (@code{org-export-with-timestamps}).
10599 @vindex org-export-preserve-breaks
10600 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10603 @vindex org-export-with-sub-superscripts
10604 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10605 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10606 it is (@code{org-export-with-sub-superscripts}).
10609 @vindex org-export-with-archived-trees
10610 Configure export of archived trees. Can be set to @code{headline} to only
10611 process the headline, skipping its contents
10612 (@code{org-export-with-archived-trees}).
10615 @vindex org-export-with-author
10616 Toggle inclusion of author name into exported file
10617 (@code{org-export-with-author}).
10620 @vindex org-export-with-clocks
10621 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10624 @vindex org-export-with-creator
10625 Configure inclusion of creator info into exported file. It may be set to
10626 @code{comment} (@code{org-export-with-creator}).
10629 @vindex org-export-with-drawers
10630 Toggle inclusion of drawers, or list drawers to include
10631 (@code{org-export-with-drawers}).
10634 @vindex org-export-with-entities
10635 Toggle inclusion of entities (@code{org-export-with-entities}).
10638 @vindex org-export-with-email
10639 Toggle inclusion of the author's e-mail into exported file
10640 (@code{org-export-with-email}).
10643 @vindex org-export-with-footnotes
10644 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10647 @vindex org-export-headline-levels
10648 Set the number of headline levels for export
10649 (@code{org-export-headline-levels}). Below that level, headlines are treated
10650 differently. In most back-ends, they become list items.
10653 @vindex org-export-with-inlinetasks
10654 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10657 @vindex org-export-with-section-numbers
10658 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10659 be set to a number @samp{n}, so only headlines at that level or above will be
10663 @vindex org-export-with-planning
10664 Toggle export of planning information (@code{org-export-with-planning}).
10665 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10666 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10669 @vindex org-export-with-priority
10670 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10673 @vindex org-export-with-properties
10674 Toggle inclusion of property drawers, or list properties to include
10675 (@code{org-export-with-properties}).
10678 @vindex org-export-with-statistics-cookies
10679 Toggle inclusion of statistics cookies
10680 (@code{org-export-with-statistics-cookies}).
10683 @vindex org-export-with-tags
10684 Toggle inclusion of tags, may also be @code{not-in-toc}
10685 (@code{org-export-with-tags}).
10688 @vindex org-export-with-tasks
10689 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10690 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10691 (@code{org-export-with-tasks}).
10694 @vindex org-export-with-latex
10695 Configure export of @LaTeX{} fragments and environments. It may be set to
10696 @code{verbatim} (@code{org-export-with-latex}).
10699 @vindex org-export-time-stamp-file
10700 Toggle inclusion of the creation time into exported file
10701 (@code{org-export-time-stamp-file}).
10704 @vindex org-export-with-toc
10705 Toggle inclusion of the table of contents, or set the level limit
10706 (@code{org-export-with-toc}).
10709 @vindex org-export-with-todo-keywords
10710 Toggle inclusion of TODO keywords into exported text
10711 (@code{org-export-with-todo-keywords}).
10714 @vindex org-export-with-tables
10715 Toggle inclusion of tables (@code{org-export-with-tables}).
10718 @cindex property, EXPORT_FILE_NAME
10719 When exporting only a subtree, each of the previous keywords@footnote{With
10720 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10721 properties. These begin with @samp{EXPORT_}, followed by the name of the
10722 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10723 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10724 properties. Subtree export also supports the self-explicit
10725 @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide equivalent
10726 for this property. The file name in this case is derived from the file
10727 associated to the buffer, if possible, or asked to the user otherwise.}.
10730 @vindex org-export-allow-bind-keywords
10731 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10732 can become buffer-local during export by using the BIND keyword. Its syntax
10733 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10734 settings that cannot be changed using specific keywords.
10736 @node ASCII/Latin-1/UTF-8 export
10737 @section ASCII/Latin-1/UTF-8 export
10738 @cindex ASCII export
10739 @cindex Latin-1 export
10740 @cindex UTF-8 export
10742 ASCII export produces a simple and very readable version of an Org mode
10743 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10744 with special characters and symbols available in these encodings.
10746 @vindex org-ascii-text-width
10747 Upon exporting, text is filled and justified, when appropriate, according the
10748 text width set in @code{org-ascii-text-width}.
10750 @vindex org-ascii-links-to-notes
10751 Links are exported in a footnote-like style, with the descriptive part in the
10752 text and the link in a note before the next heading. See the variable
10753 @code{org-ascii-links-to-notes} for details and other options.
10755 @subheading ASCII export commands
10758 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10759 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10760 will be @file{myfile.txt}. The file will be overwritten without warning.
10761 When the original file is @file{myfile.txt}, the resulting file becomes
10762 @file{myfile.txt.txt} in order to prevent data loss.
10763 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10764 Export to a temporary buffer. Do not create a file.
10767 @subheading Header and sectioning structure
10769 In the exported version, the first three outline levels become headlines,
10770 defining a general document structure. Additional levels are exported as
10771 lists. The transition can also occur at a different level (@pxref{Export
10774 @subheading Quoting ASCII text
10776 You can insert text that will only appear when using @code{ASCII} back-end
10777 with the following constructs:
10780 @cindex #+BEGIN_ASCII
10782 Text @@@@ascii:and additional text@@@@ within a paragraph.
10787 All lines in this block will appear only when using this back-end.
10791 @subheading ASCII specific attributes
10792 @cindex #+ATTR_ASCII
10793 @cindex horizontal rules, in ASCII export
10795 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10796 specifies the length, in characters, of a given horizontal rule. It must be
10797 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10800 #+ATTR_ASCII: :width 10
10804 @subheading ASCII special blocks
10805 @cindex special blocks, in ASCII export
10806 @cindex #+BEGIN_JUSTIFYLEFT
10807 @cindex #+BEGIN_JUSTIFYRIGHT
10809 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
10810 possible to justify contents to the left or the right of the page with the
10811 following dedicated blocks.
10814 #+BEGIN_JUSTIFYLEFT
10815 It's just a jump to the left...
10818 #+BEGIN_JUSTIFYRIGHT
10819 ...and then a step to the right.
10823 @node Beamer export
10824 @section Beamer export
10825 @cindex Beamer export
10827 The @LaTeX{} class @emph{Beamer} allows production of high quality
10828 presentations using @LaTeX{} and pdf processing. Org mode has special
10829 support for turning an Org mode file or tree into a Beamer presentation.
10831 @subheading Beamer export commands
10834 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10835 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
10836 file will be @file{myfile.tex}. The file will be overwritten without
10838 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10839 Export to a temporary buffer. Do not create a file.
10840 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10841 Export as @LaTeX{} and then process to PDF.
10843 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10846 @subheading Sectioning, Frames and Blocks
10848 Any tree with not-too-deep level nesting should in principle be exportable as
10849 a Beamer presentation. Headlines fall into three categories: sectioning
10850 elements, frames and blocks.
10854 @vindex org-beamer-frame-level
10855 Headlines become frames when their level is equal to
10856 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10857 (@pxref{Export settings}).
10859 @cindex property, BEAMER_ENV
10860 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10861 set to either to @code{frame} or @code{fullframe}, its level overrides the
10862 variable. A @code{fullframe} is a frame with an empty (ignored) title.
10865 @vindex org-beamer-environments-default
10866 @vindex org-beamer-environments-extra
10867 All frame's children become @code{block} environments. Special block types
10868 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10869 this property is set, the entry will also get a @code{:B_environment:} tag to
10870 make this visible. This tag has no semantic meaning, it is only a visual
10871 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10872 supported values and @code{org-beamer-environments-extra} for adding more).
10875 @cindex property, BEAMER_REF
10876 As a special case, if the @code{BEAMER_ENV} property is set to either
10877 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10878 headline will become, respectively, an appendix, a note (within frame or
10879 between frame, depending on its level), a note with its title ignored or an
10880 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
10881 is mandatory in order to refer to the frame being resumed, and contents are
10884 Also, a headline with an @code{ignoreheading} environment will have its
10885 contents only inserted in the output. This special value is useful to have
10886 data between frames, or to properly close a @code{column} environment.
10889 @cindex property, BEAMER_ACT
10890 @cindex property, BEAMER_OPT
10891 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
10892 The former is translated as an overlay/action specification, or a default
10893 overlay specification when enclosed within square brackets. The latter
10894 specifies options@footnote{The @code{fragile} option is added automatically
10895 if it contains code that requires a verbatim environment, though.} for the
10896 current frame or block. The export back-end will automatically wrap
10897 properties within angular or square brackets when appropriate.
10899 @cindex property, BEAMER_COL
10900 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
10901 be a decimal number representing the width of the column as a fraction of the
10902 total text width. If the headline has no specific environment, its title
10903 will be ignored and its contents will fill the column created. Otherwise,
10904 the block will fill the whole column and the title will be preserved. Two
10905 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
10906 @code{columns} @LaTeX{} environment. It will end before the next headline
10907 without such a property. This environment is generated automatically.
10908 Although, it can also be explicitly created, with a special @code{columns}
10909 value for @code{BEAMER_ENV} property (if it needs to be set up with some
10910 specific options, for example).
10912 @subheading Beamer specific syntax
10914 Beamer back-end is an extension of @LaTeX{} back-end. As such, all @LaTeX{}
10915 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
10916 recognized. See @ref{@LaTeX{} and PDF export} for more information.
10918 @cindex #+BEAMER_THEME
10919 @cindex #+BEAMER_COLOR_THEME
10920 @cindex #+BEAMER_FONT_THEME
10921 @cindex #+BEAMER_INNER_THEME
10922 @cindex #+BEAMER_OUTER_THEME
10923 Beamer export introduces a number of keywords to insert code in the
10924 document's header. Four control appearance of the presentation:
10925 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
10926 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
10927 @code{#+BEAMER_OUTER_THEME}. All of them accept optional arguments
10928 within square brackets. The last one, @code{#+BEAMER_HEADER}, is more
10929 generic and allows you to append any line of code in the header.
10932 #+BEAMER_THEME: Rochester [height=20pt]
10933 #+BEAMER_COLOR_THEME: spruce
10936 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
10937 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
10938 keyword (@pxref{Table of contents}) are not. In that case, it is also
10939 possible to specify options, enclosed within square brackets.
10942 #+TOC: headlines [currentsection]
10945 Beamer specific code can be inserted with the following constructs:
10948 @cindex #+BEGIN_BEAMER
10953 All lines in this block will appear only when using this back-end.
10956 Text @@@@beamer:some code@@@@ within a paragraph.
10959 In particular, this last example can be used to add overlay specifications to
10960 objects whose type is among @code{bold}, @code{item}, @code{link},
10961 @code{radio-target} and @code{target}, when the value is enclosed within
10962 angular brackets and put at the beginning the object.
10965 A *@@@@beamer:<2->@@@@useful* feature
10968 @cindex #+ATTR_BEAMER
10969 Eventually, every plain list has support for @code{:environment},
10970 @code{:overlay} and @code{:options} attributes through
10971 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
10972 of a different environment, the second sets overlay specifications and
10973 the last one inserts optional arguments in current list environment.
10976 #+ATTR_BEAMER: :overlay +-
10981 @subheading Editing support
10983 You can turn on a special minor mode @code{org-beamer-mode} for faster
10991 @orgcmd{C-c C-b,org-beamer-select-environment}
10992 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
10993 environment or the @code{BEAMER_COL} property.
10996 Also, a template for useful in-buffer settings or properties can be inserted
10997 into the buffer with @kbd{M-x org-beamer-insert-options-template}. Among
10998 other things, this will install a column view format which is very handy for
10999 editing special properties used by Beamer.
11001 @subheading An example
11003 Here is a simple example Org document that is intended for Beamer export.
11006 #+TITLE: Example Presentation
11007 #+AUTHOR: Carsten Dominik
11008 #+OPTIONS: H:2 toc:t num:t
11009 #+LATEX_CLASS: beamer
11010 #+LATEX_CLASS_OPTIONS: [presentation]
11011 #+BEAMER_THEME: Madrid
11012 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11014 * This is the first structural section
11017 *** Thanks to Eric Fraga :B_block:
11022 for the first viable Beamer setup in Org
11023 *** Thanks to everyone else :B_block:
11029 for contributing to the discussion
11030 **** This will be formatted as a beamer note :B_note:
11034 ** Frame 2 (where we will not use columns)
11036 Please test this stuff!
11040 @section HTML export
11041 @cindex HTML export
11043 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11044 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11045 language, but with additional support for tables.
11048 * HTML Export commands:: How to invoke HTML export
11049 * HTML doctypes:: Org can export to various (X)HTML flavors
11050 * HTML preamble and postamble:: How to insert a preamble and a postamble
11051 * Quoting HTML tags:: Using direct HTML in Org mode
11052 * Links in HTML export:: How links will be interpreted and formatted
11053 * Tables in HTML export:: How to modify the formatting of tables
11054 * Images in HTML export:: How to insert figures into HTML output
11055 * Math formatting in HTML export:: Beautiful math also on the web
11056 * Text areas in HTML export:: An alternative way to show an example
11057 * CSS support:: Changing the appearance of the output
11058 * JavaScript support:: Info and Folding in a web browser
11061 @node HTML Export commands
11062 @subsection HTML export commands
11065 @orgcmd{C-c C-e h h,org-html-export-to-html}
11066 Export as an HTML file. For an Org file @file{myfile.org},
11067 the HTML file will be @file{myfile.html}. The file will be overwritten
11070 Export as an HTML file and immediately open it with a browser.
11071 @orgcmd{C-c C-e h H,org-html-export-as-html}
11072 Export to a temporary buffer. Do not create a file.
11075 @c FIXME Exporting sublevels
11076 @c @cindex headline levels, for exporting
11077 @c In the exported version, the first 3 outline levels will become headlines,
11078 @c defining a general document structure. Additional levels will be exported as
11079 @c itemized lists. If you want that transition to occur at a different level,
11080 @c specify it with a numeric prefix argument. For example,
11083 @c @kbd{C-2 C-c C-e b}
11087 @c creates two levels of headings and does the rest as items.
11089 @node HTML doctypes
11090 @subsection HTML doctypes
11091 @vindex org-html-doctype
11092 @vindex org-html-doctype-alist
11094 Org can export to various (X)HTML flavors.
11096 Setting the variable @code{org-html-doctype} allows you to export to different
11097 (X)HTML variants. The exported HTML will be adjusted according to the syntax
11098 requirements of that variant. You can either set this variable to a doctype
11099 string directly, in which case the exporter will try to adjust the syntax
11100 automatically, or you can use a ready-made doctype. The ready-made options
11107 ``html4-transitional''
11113 ``xhtml-transitional''
11124 See the variable @code{org-html-doctype-alist} for details. The default is
11127 @subsubheading Fancy HTML5 export
11128 @vindex org-html-html5-fancy
11129 @vindex org-html-html5-elements
11131 HTML5 introduces several new element types. By default, Org will not make
11132 use of these element types, but you can set @code{org-html-html5-fancy} to
11133 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11134 enable a few new block-level elements. These are created using arbitrary
11135 #+BEGIN and #+END blocks. For instance:
11154 #+ATTR_HTML: :controls controls :width 350
11156 #+HTML: <source src="movie.mp4" type="video/mp4">
11157 #+HTML: <source src="movie.ogg" type="video/ogg">
11158 Your browser does not support the video tag.
11165 <video controls="controls" width="350">
11166 <source src="movie.mp4" type="video/mp4">
11167 <source src="movie.ogg" type="video/ogg">
11168 <p>Your browser does not support the video tag.</p>
11172 Special blocks that do not correspond to HTML5 elements (see
11173 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11174 @code{#+BEGIN_LEDERHOSEN} will still export to @samp{<div class="lederhosen">}.
11176 Headlines cannot appear within special blocks. To wrap a headline and its
11177 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11178 @code{HTML_CONTAINER} property on the headline itself.
11180 @node HTML preamble and postamble
11181 @subsection HTML preamble and postamble
11182 @vindex org-html-preamble
11183 @vindex org-html-postamble
11184 @vindex org-html-preamble-format
11185 @vindex org-html-postamble-format
11186 @vindex org-html-validation-link
11187 @vindex org-export-creator-string
11188 @vindex org-export-time-stamp-file
11190 The HTML exporter lets you define a preamble and a postamble.
11192 The default value for @code{org-html-preamble} is @code{t}, which means
11193 that the preamble is inserted depending on the relevant format string in
11194 @code{org-html-preamble-format}.
11196 Setting @code{org-html-preamble} to a string will override the default format
11197 string. If you set it to a function, it will insert the output of the
11198 function, which must be a string. Setting to @code{nil} will not insert any
11201 The default value for @code{org-html-postamble} is @code{'auto}, which means
11202 that the HTML exporter will look for information about the author, the email,
11203 the creator and the date, and build the postamble from these values. Setting
11204 @code{org-html-postamble} to @code{t} will insert the postamble from the
11205 relevant format string found in @code{org-html-postamble-format}. Setting it
11206 to @code{nil} will not insert any postamble.
11208 @node Quoting HTML tags
11209 @subsection Quoting HTML tags
11211 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11212 @samp{>} in HTML export. If you want to include raw HTML code, which
11213 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11214 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11215 that should be copied verbatim to the exported file use either
11218 @cindex #+BEGIN_HTML
11220 #+HTML: Literal HTML code for export
11224 @cindex #+BEGIN_HTML
11228 All lines between these markers are exported literally
11233 @node Links in HTML export
11234 @subsection Links in HTML export
11236 @cindex links, in HTML export
11237 @cindex internal links, in HTML export
11238 @cindex external links, in HTML export
11239 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11240 includes automatic links created by radio targets (@pxref{Radio
11241 targets}). Links to external files will still work if the target file is on
11242 the same @i{relative} path as the published Org file. Links to other
11243 @file{.org} files will be translated into HTML links under the assumption
11244 that an HTML version also exists of the linked file, at the same relative
11245 path. @samp{id:} links can then be used to jump to specific entries across
11246 files. For information related to linking files while publishing them to a
11247 publishing directory see @ref{Publishing links}.
11249 If you want to specify attributes for links, you can do so using a special
11250 @code{#+ATTR_HTML} line to define attributes that will be added to the
11251 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11252 and @code{style} attributes for a link:
11254 @cindex #+ATTR_HTML
11256 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11257 [[http://orgmode.org]]
11260 @node Tables in HTML export
11261 @subsection Tables in HTML export
11262 @cindex tables, in HTML
11263 @vindex org-html-table-default-attributes
11265 Org mode tables are exported to HTML using the table attributes defined in
11266 @code{org-html-table-default-attributes}. The default setting makes tables
11267 without cell borders and frame. If you would like to change this for
11268 individual tables, place something like the following before the table:
11271 @cindex #+ATTR_HTML
11273 #+CAPTION: This is a table with lines around and between cells
11274 #+ATTR_HTML: :border 2 :rules all :frame border
11277 You can also group columns in the HTML output (@pxref{Column groups}).
11279 Below is a list of options for customizing tables HTML export.
11282 @vindex org-html-table-align-individual-fields
11283 @item org-html-table-align-individual-fields
11284 Non-nil means attach style attributes for alignment to each table field.
11286 @vindex org-html-table-caption-above
11287 @item org-html-table-caption-above
11288 When non-nil, place caption string at the beginning of the table.
11290 @vindex org-html-table-data-tags
11291 @item org-html-table-data-tags
11292 The opening and ending tags for table data fields.
11294 @vindex org-html-table-default-attributes
11295 @item org-html-table-default-attributes
11296 Default attributes and values which will be used in table tags.
11298 @vindex org-html-table-header-tags
11299 @item org-html-table-header-tags
11300 The opening and ending tags for table header fields.
11302 @vindex org-html-table-row-tags
11303 @item org-html-table-row-tags
11304 The opening and ending tags for table rows.
11306 @vindex org-html-table-use-header-tags-for-first-column
11307 @item org-html-table-use-header-tags-for-first-column
11308 Non-nil means format column one in tables with header tags.
11311 @node Images in HTML export
11312 @subsection Images in HTML export
11314 @cindex images, inline in HTML
11315 @cindex inlining images in HTML
11316 @vindex org-html-inline-images
11317 HTML export can inline images given as links in the Org file, and
11318 it can make an image the clickable part of a link. By
11319 default@footnote{But see the variable
11320 @code{org-html-inline-images}.}, images are inlined if a link does
11321 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11322 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11323 @samp{the image} that points to the image. If the description part
11324 itself is a @code{file:} link or a @code{http:} URL pointing to an
11325 image, this image will be inlined and activated so that clicking on the
11326 image will activate the link. For example, to include a thumbnail that
11327 will link to a high resolution version of the image, you could use:
11330 [[file:highres.jpg][file:thumb.jpg]]
11333 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11334 In the example below we specify the @code{alt} and @code{title} attributes to
11335 support text viewers and accessibility, and align it to the right.
11338 @cindex #+ATTR_HTML
11340 #+CAPTION: A black cat stalking a spider
11341 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11346 You could use @code{http} addresses just as well.
11348 @node Math formatting in HTML export
11349 @subsection Math formatting in HTML export
11352 @cindex imagemagick
11354 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11355 different ways on HTML pages. The default is to use the
11356 @uref{http://www.mathjax.org, MathJax system} which should work out of the
11357 box with Org mode installation because @uref{http://orgmode.org} serves
11358 @file{MathJax} for Org mode users for small applications and for testing
11359 purposes. @b{If you plan to use this regularly or on pages with significant
11360 page views, you should install@footnote{Installation instructions can be
11361 found on the MathJax website, see
11362 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
11363 your own server in order to limit the load of our server.} To configure
11364 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
11365 insert something like the following into the buffer:
11368 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
11371 @noindent See the docstring of the variable
11372 @code{org-html-mathjax-options} for the meaning of the parameters in
11375 If you prefer, you can also request that @LaTeX{} fragments are processed
11376 into small images that will be inserted into the browser page. Before the
11377 availability of MathJax, this was the default method for Org files. This
11378 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11379 available on your system. You can still get this processing with
11382 #+OPTIONS: tex:dvipng
11388 #+OPTIONS: tex:imagemagick
11391 @node Text areas in HTML export
11392 @subsection Text areas in HTML export
11394 @cindex text areas, in HTML
11395 An alternative way to publish literal code examples in HTML is to use text
11396 areas, where the example can even be edited before pasting it into an
11397 application. It is triggered by @code{:textarea} attribute at an
11398 @code{example} or @code{src} block.
11400 You may also use @code{:height} and @code{:width} attributes to specify the
11401 height and width of the text area, which default to the number of lines in
11402 the example, and 80, respectively. For example
11405 #+ATTR_HTML: :textarea t :width 40
11407 (defun org-xor (a b)
11415 @subsection CSS support
11416 @cindex CSS, for HTML export
11417 @cindex HTML export, CSS
11419 @vindex org-html-todo-kwd-class-prefix
11420 @vindex org-html-tag-class-prefix
11421 You can modify the CSS style definitions for the exported file. The HTML
11422 exporter assigns the following special CSS classes@footnote{If the classes on
11423 TODO keywords and tags lead to conflicts, use the variables
11424 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11425 make them unique.} to appropriate parts of the document---your style
11426 specifications may change these, in addition to any of the standard classes
11427 like for headlines, tables, etc.
11429 p.author @r{author information, including email}
11430 p.date @r{publishing date}
11431 p.creator @r{creator info, about org mode version}
11432 .title @r{document title}
11433 .todo @r{TODO keywords, all not-done states}
11434 .done @r{the DONE keywords, all states that count as done}
11435 .WAITING @r{each TODO keyword also uses a class named after itself}
11436 .timestamp @r{timestamp}
11437 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11438 .timestamp-wrapper @r{span around keyword plus timestamp}
11439 .tag @r{tag in a headline}
11440 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11441 .target @r{target for links}
11442 .linenr @r{the line number in a code example}
11443 .code-highlighted @r{for highlighting referenced code lines}
11444 div.outline-N @r{div for outline level N (headline plus text))}
11445 div.outline-text-N @r{extra div for text at outline level N}
11446 .section-number-N @r{section number in headlines, different for each level}
11447 .figure-number @r{label like "Figure 1:"}
11448 .table-number @r{label like "Table 1:"}
11449 .listing-number @r{label like "Listing 1:"}
11450 div.figure @r{how to format an inlined image}
11451 pre.src @r{formatted source code}
11452 pre.example @r{normal example}
11453 p.verse @r{verse paragraph}
11454 div.footnotes @r{footnote section headline}
11455 p.footnote @r{footnote definition paragraph, containing a footnote}
11456 .footref @r{a footnote reference number (always a <sup>)}
11457 .footnum @r{footnote number in footnote definition (always <sup>)}
11460 @vindex org-html-style-default
11461 @vindex org-html-head-include-default-style
11462 @vindex org-html-head
11463 @vindex org-html-head-extra
11464 @cindex #+HTML_INCLUDE_STYLE
11465 Each exported file contains a compact default style that defines these
11466 classes in a basic way@footnote{This style is defined in the constant
11467 @code{org-html-style-default}, which you should not modify. To turn
11468 inclusion of these defaults off, customize
11469 @code{org-html-head-include-default-style} or set @code{html-style} to
11470 @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or
11471 add to them by using the variables @code{org-html-head} and
11472 @code{org-html-head-extra}. You can override the global values of these
11473 variables for each file by using these keywords:
11475 @cindex #+HTML_HEAD
11476 @cindex #+HTML_HEAD_EXTRA
11478 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11479 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11483 For longer style definitions, you can use several such lines. You could also
11484 directly write a @code{<style>} @code{</style>} section in this way, without
11485 referring to an external file.
11487 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11488 property to assign a class to the tree. In order to specify CSS styles for a
11489 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11492 @c FIXME: More about header and footer styles
11493 @c FIXME: Talk about links and targets.
11495 @node JavaScript support
11496 @subsection JavaScript supported display of web pages
11498 @cindex Rose, Sebastian
11499 Sebastian Rose has written a JavaScript program especially designed to
11500 enhance the web viewing experience of HTML files created with Org. This
11501 program allows you to view large files in two different ways. The first one
11502 is an @emph{Info}-like mode where each section is displayed separately and
11503 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11504 as well, press @kbd{?} for an overview of the available keys). The second
11505 view type is a @emph{folding} view much like Org provides inside Emacs. The
11506 script is available at @url{http://orgmode.org/org-info.js} and you can find
11507 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11508 We host the script at our site, but if you use it a lot, you might not want
11509 to be dependent on @url{http://orgmode.org} and prefer to install a local
11510 copy on your own web server.
11512 All it then takes to use this program is adding a single line to the Org
11515 @cindex #+INFOJS_OPT
11517 #+INFOJS_OPT: view:info toc:nil
11521 If this line is found, the HTML header will automatically contain the code
11522 needed to invoke the script. Using the line above, you can set the following
11526 path: @r{The path to the script. The default is to grab the script from}
11527 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11528 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11529 view: @r{Initial view when the website is first shown. Possible values are:}
11530 info @r{Info-like interface with one section per page.}
11531 overview @r{Folding interface, initially showing only top-level.}
11532 content @r{Folding interface, starting with all headlines visible.}
11533 showall @r{Folding interface, all headlines and text visible.}
11534 sdepth: @r{Maximum headline level that will still become an independent}
11535 @r{section for info and folding modes. The default is taken from}
11536 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11537 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11538 @r{info/folding section can still contain child headlines.}
11539 toc: @r{Should the table of contents @emph{initially} be visible?}
11540 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11541 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11542 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11543 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11544 @r{If yes, the toc will never be displayed as a section.}
11545 ltoc: @r{Should there be short contents (children) in each section?}
11546 @r{Make this @code{above} if the section should be above initial text.}
11547 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11548 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11549 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11550 @r{default), only one such button will be present.}
11553 @vindex org-html-infojs-options
11554 @vindex org-html-use-infojs
11555 You can choose default values for these options by customizing the variable
11556 @code{org-html-infojs-options}. If you always want to apply the script to your
11557 pages, configure the variable @code{org-html-use-infojs}.
11559 @node @LaTeX{} and PDF export
11560 @section @LaTeX{} and PDF export
11561 @cindex @LaTeX{} export
11564 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11565 standard or custom document class. With further processing@footnote{The
11566 default @LaTeX{} output is designed for processing with @code{pdftex} or
11567 @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
11568 possibly @code{luatex}. The @LaTeX{} exporter can be configured to support
11569 alternative TeX engines, see the options
11570 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11571 which the @LaTeX{} exporter is able to control, this back-end is able to
11572 produce PDF output. Because the @LaTeX{} exporter can be configured to use
11573 the @code{hyperref} package, the default setup produces fully-linked PDF
11576 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11577 will not be started if two contiguous syntactical elements are not separated
11580 This back-end also offers enhanced support for footnotes. Thus, it handles
11581 nested footnotes, footnotes in tables and footnotes in a list item's
11585 * @LaTeX{} export commands:: How to export to LaTeX and PDF
11586 * Header and sectioning:: Setting up the export file structure
11587 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11588 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
11591 @node @LaTeX{} export commands
11592 @subsection @LaTeX{} export commands
11595 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11596 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11597 file will be @file{myfile.tex}. The file will be overwritten without
11599 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11600 Export to a temporary buffer. Do not create a file.
11601 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11602 Export as @LaTeX{} and then process to PDF.
11604 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11607 @node Header and sectioning
11608 @subsection Header and sectioning structure
11609 @cindex @LaTeX{} class
11610 @cindex @LaTeX{} sectioning structure
11611 @cindex @LaTeX{} header
11612 @cindex header, for @LaTeX{} files
11613 @cindex sectioning structure, for @LaTeX{} export
11615 By default, the first three outline levels become headlines, defining a
11616 general document structure. Additional levels are exported as @code{itemize}
11617 or @code{enumerate} lists. The transition can also occur at a different
11618 level (@pxref{Export settings}).
11620 By default, the @LaTeX{} output uses the class @code{article}.
11622 @vindex org-latex-default-class
11623 @vindex org-latex-classes
11624 @vindex org-latex-default-packages-alist
11625 @vindex org-latex-packages-alist
11626 You can change this globally by setting a different value for
11627 @code{org-latex-default-class} or locally by adding an option like
11628 @code{#+LATEX_CLASS: myclass} in your file, or with
11629 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11630 containing only this (sub)tree. The class must be listed in
11631 @code{org-latex-classes}. This variable defines a header template for each
11632 class@footnote{Into which the values of
11633 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11634 are spliced.}, and allows you to define the sectioning structure for each
11635 class. You can also define your own classes there.
11637 @cindex #+LATEX_CLASS
11638 @cindex #+LATEX_CLASS_OPTIONS
11639 @cindex property, EXPORT_LATEX_CLASS
11640 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11641 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11642 property can specify the options for the @code{\documentclass} macro. These
11643 options have to be provided, as expected by @LaTeX{}, within square brackets.
11645 @cindex #+LATEX_HEADER
11646 @cindex #+LATEX_HEADER_EXTRA
11647 You can also use the @code{LATEX_HEADER} and
11648 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11649 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11650 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11651 to add lines to the header. See the docstring of @code{org-latex-classes} for
11654 An example is shown below.
11657 #+LATEX_CLASS: article
11658 #+LATEX_CLASS_OPTIONS: [a4paper]
11659 #+LATEX_HEADER: \usepackage@{xyz@}
11665 @node Quoting @LaTeX{} code
11666 @subsection Quoting @LaTeX{} code
11668 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11669 inserted into the @LaTeX{} file. Furthermore, you can add special code that
11670 should only be present in @LaTeX{} export with the following constructs:
11673 @cindex #+BEGIN_LATEX
11675 Code within @@@@latex:some code@@@@ a paragraph.
11677 #+LATEX: Literal @LaTeX{} code for export
11680 All lines between these markers are exported literally
11684 @node @LaTeX{} specific attributes
11685 @subsection @LaTeX{} specific attributes
11686 @cindex #+ATTR_LATEX
11688 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
11689 affect tables, images, plain lists, special blocks and source blocks.
11691 @subsubheading Tables in @LaTeX{} export
11692 @cindex tables, in @LaTeX{} export
11694 For @LaTeX{} export of a table, you can specify a label and a caption
11695 (@pxref{Images and tables}). You can also use attributes to control table
11696 layout and contents. Valid @LaTeX{} attributes include:
11700 @vindex org-latex-default-table-mode
11701 Nature of table's contents. It can be set to @code{table}, @code{math},
11702 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
11703 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11704 ignored and the table will be wrapped in a math environment. Also,
11705 contiguous tables sharing the same math mode will be wrapped within the same
11706 environment. Default mode is determined in
11707 @code{org-latex-default-table-mode}.
11709 @vindex org-latex-default-table-environment
11710 Environment used for the table. It can be set to any @LaTeX{} table
11711 environment, like @code{tabularx}@footnote{Requires adding the
11712 @code{tabularx} package to @code{org-latex-packages-alist}.},
11713 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11714 @code{tabu} package to @code{org-latex-packages-alist}.},
11715 @code{bmatrix}@enddots{} It defaults to
11716 @code{org-latex-default-table-environment} value.
11718 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11719 (@pxref{Images and tables}). If you need more advanced commands for that
11720 task, you can use @code{:caption} attribute instead. Its value should be raw
11721 @LaTeX{} code. It has precedence over @code{#+CAPTION}.
11724 The @code{:float} specifies the float environment for the table. Possible
11725 values are @code{sideways}@footnote{Formerly, the value was
11726 @code{sidewaystable}. This is deprecated since Org 8.3.},
11727 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
11728 a caption will have a @code{table} environment. Moreover, the
11729 @code{:placement} attribute can specify the positioning of the float. Note:
11730 @code{:placement} is ignored for @code{:float sideways} tables.
11734 Set, respectively, the alignment string of the table, its font size and its
11735 width. They only apply on regular tables.
11737 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11738 only takes effect when used in conjunction with the @code{:width} attribute.
11739 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11740 value of @code{:width}.
11744 @vindex org-latex-tables-booktabs
11745 @vindex org-latex-tables-centered
11746 They toggle, respectively, @code{booktabs} usage (assuming the package is
11747 properly loaded), table centering and removal of every horizontal rule but
11748 the first one (in a "table.el" table only). In particular,
11749 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11750 activates the first (respectively second) attribute globally.
11752 @itemx :math-suffix
11753 @itemx :math-arguments
11754 A string that will be inserted, respectively, before the table within the
11755 math environment, after the table within the math environment, and between
11756 the macro name and the contents of the table. The @code{:math-arguments}
11757 attribute is used for matrix macros that require more than one argument
11758 (e.g., @code{qbordermatrix}).
11761 Thus, attributes can be used in a wide array of situations, like writing
11762 a table that will span over multiple pages, or a matrix product:
11765 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11769 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11772 #+ATTR_LATEX: :mode math :environment bmatrix
11777 In the example below, @LaTeX{} command
11778 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11781 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11787 @subsubheading Images in @LaTeX{} export
11788 @cindex images, inline in @LaTeX{}
11789 @cindex inlining images in @LaTeX{}
11791 Images that are linked to without a description part in the link, like
11792 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11793 output file resulting from @LaTeX{} processing. Org will use an
11794 @code{\includegraphics} macro to insert the image@footnote{In the case of
11795 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11796 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11798 You can specify specify image width or height with, respectively,
11799 @code{:width} and @code{:height} attributes. It is also possible to add any
11800 other option with the @code{:options} attribute, as shown in the following
11804 #+ATTR_LATEX: :width 5cm :options angle=90
11805 [[./img/sed-hr4049.pdf]]
11808 If you need a specific command for the caption, use @code{:caption}
11809 attribute. It will override standard @code{#+CAPTION} value, if any.
11812 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11813 [[./img/sed-hr4049.pdf]]
11816 If you have specified a caption as described in @ref{Images and tables}, the
11817 picture will be wrapped into a @code{figure} environment and thus become
11818 a floating element. You can also ask Org to export an image as a float
11819 without specifying caption by setting the @code{:float} attribute. You may
11823 @code{t}: if you want to use the standard @samp{figure} environment. It is
11824 used by default if you provide a caption to the image.
11826 @code{multicolumn}: if you wish to include an image which spans multiple
11827 columns in a page. This will export the image wrapped in a @code{figure*}
11830 @code{wrap}: if you would like to let text flow around the image. It will
11831 make the figure occupy the left half of the page.
11833 @code{sideways}: if you would like the image to appear alone on a separate
11834 page rotated ninety degrees using the @code{sidewaysfigure}
11835 environment. Setting this @code{:float} option will ignore the
11836 @code{:placement} setting.
11838 @code{nil}: if you need to avoid any floating environment, even when
11839 a caption is provided.
11842 To modify the placement option of any floating environment, set the
11843 @code{placement} attribute.
11846 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11850 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11851 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11853 @subsubheading Plain lists in @LaTeX{} export
11854 @cindex plain lists, in @LaTeX{} export
11856 Plain lists accept two optional attributes: @code{:environment} and
11857 @code{:options}. The first one allows the use of a non-standard environment
11858 (e.g., @samp{inparaenum}). The second one specifies additional arguments for
11862 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
11863 - you need ``paralist'' package to reproduce this example.
11866 @subsubheading Source blocks in @LaTeX{} export
11867 @cindex source blocks, in @LaTeX{} export
11869 In addition to syntax defined in @ref{Literal examples}, names and captions
11870 (@pxref{Images and tables}), source blocks also accept two additional
11871 attributes: @code{:float} and @code{:options}.
11873 You may set the former to
11876 @code{t}: if you want to make the source block a float. It is the default
11877 value when a caption is provided.
11879 @code{multicolumn}: if you wish to include a source block which spans multiple
11882 @code{nil}: if you need to avoid any floating environment, even when a caption
11883 is provided. It is useful for source code that may not fit in a single page.
11887 #+ATTR_LATEX: :float nil
11888 #+BEGIN_SRC emacs-lisp
11889 Code that may not fit in a single page.
11893 @vindex org-latex-listings-options
11894 @vindex org-latex-minted-options
11895 The latter allows to specify options relative to the package used to
11896 highlight code in the output (e.g., @code{listings}). This is the local
11897 counterpart to @code{org-latex-listings-options} and
11898 @code{org-latex-minted-options} variables, which see.
11901 #+ATTR_LATEX: :options commentstyle=\bfseries
11902 #+BEGIN_SRC emacs-lisp
11903 (defun Fib (n) ; Count rabbits.
11904 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
11908 @subsubheading Special blocks in @LaTeX{} export
11909 @cindex special blocks, in @LaTeX{} export
11910 @cindex abstract, in @LaTeX{} export
11911 @cindex proof, in @LaTeX{} export
11913 In @LaTeX{} back-end, special blocks become environments of the same name.
11914 Value of @code{:options} attribute will be appended as-is to that
11915 environment's opening string. For example:
11919 We demonstrate how to solve the Syracuse problem.
11922 #+ATTR_LATEX: :options [Proof of important theorem]
11925 Therefore, any even number greater than 2 is the sum of two primes.
11934 We demonstrate how to solve the Syracuse problem.
11937 \begin@{proof@}[Proof of important theorem]
11939 Therefore, any even number greater than 2 is the sum of two primes.
11943 If you need to insert a specific caption command, use @code{:caption}
11944 attribute. It will override standard @code{#+CAPTION} value, if any. For
11948 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
11954 @subsubheading Horizontal rules
11955 @cindex horizontal rules, in @LaTeX{} export
11957 Width and thickness of a given horizontal rule can be controlled with,
11958 respectively, @code{:width} and @code{:thickness} attributes:
11961 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
11965 @node Markdown export
11966 @section Markdown export
11967 @cindex Markdown export
11969 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
11970 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
11973 It is built over HTML back-end: any construct not supported by Markdown
11974 syntax (e.g., tables) will be controlled and translated by @code{html}
11975 back-end (@pxref{HTML export}).
11977 @subheading Markdown export commands
11980 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
11981 Export as a text file written in Markdown syntax. For an Org file,
11982 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
11983 will be overwritten without warning.
11984 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
11985 Export to a temporary buffer. Do not create a file.
11987 Export as a text file with Markdown syntax, then open it.
11990 @subheading Header and sectioning structure
11992 @vindex org-md-headline-style
11993 Markdown export can generate both @code{atx} and @code{setext} types for
11994 headlines, according to @code{org-md-headline-style}. The former introduces
11995 a hard limit of two levels, whereas the latter pushes it to six. Headlines
11996 below that limit are exported as lists. You can also set a soft limit before
11997 that one (@pxref{Export settings}).
11999 @c begin opendocument
12001 @node OpenDocument text export
12002 @section OpenDocument text export
12004 @cindex OpenDocument
12005 @cindex export, OpenDocument
12006 @cindex LibreOffice
12008 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12009 (ODT) format. Documents created by this exporter use the
12010 @cite{OpenDocument-v1.2
12011 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12012 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12013 are compatible with LibreOffice 3.4.
12016 * Pre-requisites for ODT export:: What packages ODT exporter relies on
12017 * ODT export commands:: How to invoke ODT export
12018 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
12019 * Applying custom styles:: How to apply custom styles to the output
12020 * Links in ODT export:: How links will be interpreted and formatted
12021 * Tables in ODT export:: How Tables are exported
12022 * Images in ODT export:: How to insert images
12023 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
12024 * Labels and captions in ODT export:: How captions are rendered
12025 * Literal examples in ODT export:: How source and example blocks are formatted
12026 * Advanced topics in ODT export:: Read this if you are a power user
12029 @node Pre-requisites for ODT export
12030 @subsection Pre-requisites for ODT export
12032 The ODT exporter relies on the @file{zip} program to create the final
12033 output. Check the availability of this program before proceeding further.
12035 @node ODT export commands
12036 @subsection ODT export commands
12038 @subsubheading Exporting to ODT
12039 @anchor{x-export-to-odt}
12041 @cindex region, active
12042 @cindex active region
12043 @cindex transient-mark-mode
12045 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12046 @cindex property EXPORT_FILE_NAME
12048 Export as OpenDocument Text file.
12050 @vindex org-odt-preferred-output-format
12051 If @code{org-odt-preferred-output-format} is specified, automatically convert
12052 the exported file to that format. @xref{x-export-to-other-formats, ,
12053 Automatically exporting to other formats}.
12055 For an Org file @file{myfile.org}, the ODT file will be
12056 @file{myfile.odt}. The file will be overwritten without warning. If there
12057 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12058 turned on} only the region will be exported. If the selected region is a
12059 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12060 tree head will become the document title. If the tree head entry has, or
12061 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12065 Export as an OpenDocument Text file and open the resulting file.
12067 @vindex org-odt-preferred-output-format
12068 If @code{org-odt-preferred-output-format} is specified, open the converted
12069 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
12073 @node Extending ODT export
12074 @subsection Extending ODT export
12076 The ODT exporter can interface with a variety of document
12077 converters and supports popular converters out of the box. As a result, you
12078 can use it to export to formats like @samp{doc} or convert a document from
12079 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12081 @cindex @file{unoconv}
12082 @cindex LibreOffice
12083 If you have a working installation of LibreOffice, a document converter is
12084 pre-configured for you and you can use it right away. If you would like to
12085 use @file{unoconv} as your preferred converter, customize the variable
12086 @code{org-odt-convert-process} to point to @code{unoconv}. You can
12087 also use your own favorite converter or tweak the default settings of the
12088 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
12089 document converter}.
12091 @subsubheading Automatically exporting to other formats
12092 @anchor{x-export-to-other-formats}
12094 @vindex org-odt-preferred-output-format
12095 Very often, you will find yourself exporting to ODT format, only to
12096 immediately save the exported document to other formats like @samp{doc},
12097 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
12098 preferred output format by customizing the variable
12099 @code{org-odt-preferred-output-format}. This way, the export commands
12100 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12101 format that is of immediate interest to you.
12103 @subsubheading Converting between document formats
12104 @anchor{x-convert-to-other-formats}
12106 There are many document converters in the wild which support conversion to
12107 and from various file formats, including, but not limited to the
12108 ODT format. LibreOffice converter, mentioned above, is one such
12109 converter. Once a converter is configured, you can interact with it using
12110 the following command.
12112 @vindex org-odt-convert
12115 @item M-x org-odt-convert RET
12116 Convert an existing document from one format to another. With a prefix
12117 argument, also open the newly produced file.
12120 @node Applying custom styles
12121 @subsection Applying custom styles
12122 @cindex styles, custom
12123 @cindex template, custom
12125 The ODT exporter ships with a set of OpenDocument styles
12126 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12127 output. These factory styles, however, may not cater to your specific
12128 tastes. To customize the output, you can either modify the above styles
12129 files directly, or generate the required styles using an application like
12130 LibreOffice. The latter method is suitable for expert and non-expert
12131 users alike, and is described here.
12133 @subsubheading Applying custom styles: the easy way
12137 Create a sample @file{example.org} file with the below settings and export it
12141 #+OPTIONS: H:10 num:t
12145 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
12146 to locate the target styles---these typically have the @samp{Org} prefix---and
12147 modify those to your taste. Save the modified file either as an
12148 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12151 @cindex #+ODT_STYLES_FILE
12152 @vindex org-odt-styles-file
12153 Customize the variable @code{org-odt-styles-file} and point it to the
12154 newly created file. For additional configuration options
12155 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12157 If you would like to choose a style on a per-file basis, you can use the
12158 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
12161 #+ODT_STYLES_FILE: "/path/to/example.ott"
12167 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12172 @subsubheading Using third-party styles and templates
12174 You can use third-party styles and templates for customizing your output.
12175 This will produce the desired output only if the template provides all
12176 style names that the @samp{ODT} exporter relies on. Unless this condition is
12177 met, the output is going to be less than satisfactory. So it is highly
12178 recommended that you only work with templates that are directly derived from
12179 the factory settings.
12181 @node Links in ODT export
12182 @subsection Links in ODT export
12183 @cindex links, in ODT export
12185 ODT exporter creates native cross-references for internal links. It creates
12186 Internet-style links for all other links.
12188 A link with no description and destined to a regular (un-itemized) outline
12189 heading is replaced with a cross-reference and section number of the heading.
12191 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12192 with a cross-reference and sequence number of the labeled entity.
12193 @xref{Labels and captions in ODT export}.
12195 @node Tables in ODT export
12196 @subsection Tables in ODT export
12197 @cindex tables, in ODT export
12199 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12200 tables is supported. However, export of complex @file{table.el} tables---tables
12201 that have column or row spans---is not supported. Such tables are
12202 stripped from the exported document.
12204 By default, a table is exported with top and bottom frames and with rules
12205 separating row and column groups (@pxref{Column groups}). Furthermore, all
12206 tables are typeset to occupy the same width. If the table specifies
12207 alignment and relative width for its columns (@pxref{Column width and
12208 alignment}) then these are honored on export.@footnote{The column widths are
12209 interpreted as weighted ratios with the default weight being 1}
12212 You can control the width of the table by specifying @code{:rel-width}
12213 property using an @code{#+ATTR_ODT} line.
12215 For example, consider the following table which makes use of all the rules
12219 #+ATTR_ODT: :rel-width 50
12220 | Area/Month | Jan | Feb | Mar | Sum |
12221 |---------------+-------+-------+-------+-------|
12223 | <l13> | <r5> | <r5> | <r5> | <r6> |
12224 | North America | 1 | 21 | 926 | 948 |
12225 | Middle East | 6 | 75 | 844 | 925 |
12226 | Asia Pacific | 9 | 27 | 790 | 826 |
12227 |---------------+-------+-------+-------+-------|
12228 | Sum | 16 | 123 | 2560 | 2699 |
12231 On export, the table will occupy 50% of text area. The columns will be sized
12232 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12233 and rest of the columns will be right-aligned. There will be vertical rules
12234 after separating the header and last columns from other columns. There will
12235 be horizontal rules separating the header and last rows from other rows.
12237 If you are not satisfied with the above formatting options, you can create
12238 custom table styles and associate them with a table using the
12239 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12241 @node Images in ODT export
12242 @subsection Images in ODT export
12243 @cindex images, embedding in ODT
12244 @cindex embedding images in ODT
12246 @subsubheading Embedding images
12247 You can embed images within the exported document by providing a link to the
12248 desired image file with no link description. For example, to embed
12249 @samp{img.png} do either of the following:
12259 @subsubheading Embedding clickable images
12260 You can create clickable images by providing a link whose description is a
12261 link to an image file. For example, to embed a image
12262 @file{org-mode-unicorn.png} which when clicked jumps to
12263 @uref{http://Orgmode.org} website, do the following
12266 [[http://orgmode.org][./org-mode-unicorn.png]]
12269 @subsubheading Sizing and scaling of embedded images
12272 You can control the size and scale of the embedded images using the
12273 @code{#+ATTR_ODT} attribute.
12275 @cindex identify, ImageMagick
12276 @vindex org-odt-pixels-per-inch
12277 The exporter specifies the desired size of the image in the final document in
12278 units of centimeters. In order to scale the embedded images, the exporter
12279 queries for pixel dimensions of the images using one of a) ImageMagick's
12280 @file{identify} program or b) Emacs `create-image' and `image-size'
12281 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12282 routinely produce documents that have large images or you export your Org
12283 files that has images using a Emacs batch script, then the use of
12284 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12285 converted in to units of centimeters using
12286 @code{org-odt-pixels-per-inch}. The default value of this variable is
12287 set to @code{display-pixels-per-inch}. You can tweak this variable to
12288 achieve the best results.
12290 The examples below illustrate the various possibilities.
12293 @item Explicitly size the image
12294 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12297 #+ATTR_ODT: :width 10 :height 10
12301 @item Scale the image
12302 To embed @file{img.png} at half its size, do the following:
12305 #+ATTR_ODT: :scale 0.5
12309 @item Scale the image to a specific width
12310 To embed @file{img.png} with a width of 10 cm while retaining the original
12311 height:width ratio, do the following:
12314 #+ATTR_ODT: :width 10
12318 @item Scale the image to a specific height
12319 To embed @file{img.png} with a height of 10 cm while retaining the original
12320 height:width ratio, do the following
12323 #+ATTR_ODT: :height 10
12328 @subsubheading Anchoring of images
12331 You can control the manner in which an image is anchored by setting the
12332 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
12333 of the the following three values for the @code{:anchor} property:
12334 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12336 To create an image that is anchored to a page, do the following:
12338 #+ATTR_ODT: :anchor "page"
12342 @node Math formatting in ODT export
12343 @subsection Math formatting in ODT export
12345 The ODT exporter has special support for handling math.
12348 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12349 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12352 @node Working with @LaTeX{} math snippets
12353 @subsubheading Working with @LaTeX{} math snippets
12355 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12356 document in one of the following ways:
12362 This option is activated on a per-file basis with
12368 With this option, @LaTeX{} fragments are first converted into MathML
12369 fragments using an external @LaTeX{}-to-MathML converter program. The
12370 resulting MathML fragments are then embedded as an OpenDocument Formula in
12371 the exported document.
12373 @vindex org-latex-to-mathml-convert-command
12374 @vindex org-latex-to-mathml-jar-file
12376 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12377 @code{org-latex-to-mathml-convert-command} and
12378 @code{org-latex-to-mathml-jar-file}.
12380 If you prefer to use @file{MathToWeb}@footnote{See
12381 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
12382 converter, you can configure the above variables as shown below.
12385 (setq org-latex-to-mathml-convert-command
12386 "java -jar %j -unicode -force -df %o %I"
12387 org-latex-to-mathml-jar-file
12388 "/path/to/mathtoweb.jar")
12391 You can use the following commands to quickly verify the reliability of
12392 the @LaTeX{}-to-MathML converter.
12395 @item M-x org-odt-export-as-odf RET
12396 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12398 @item M-x org-odt-export-as-odf-and-open RET
12399 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12400 and open the formula file with the system-registered application.
12404 @cindex imagemagick
12407 This option is activated on a per-file basis with
12410 #+OPTIONS: tex:dvipng
12416 #+OPTIONS: tex:imagemagick
12419 With this option, @LaTeX{} fragments are processed into PNG images and the
12420 resulting images are embedded in the exported document. This method requires
12421 that the @file{dvipng} program or @file{imagemagick} suite be available on
12425 @node Working with MathML or OpenDocument formula files
12426 @subsubheading Working with MathML or OpenDocument formula files
12428 For various reasons, you may find embedding @LaTeX{} math snippets in an
12429 ODT document less than reliable. In that case, you can embed a
12430 math equation by linking to its MathML (@file{.mml}) source or its
12431 OpenDocument formula (@file{.odf}) file as shown below:
12443 @node Labels and captions in ODT export
12444 @subsection Labels and captions in ODT export
12446 You can label and caption various category of objects---an inline image, a
12447 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12448 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12449 each labeled or captioned object of a given category separately. As a
12450 result, each such object is assigned a sequence number based on order of it's
12451 appearance in the Org file.
12453 In the exported document, a user-provided caption is augmented with the
12454 category and sequence number. Consider the following inline image in an Org
12458 #+CAPTION: Bell curve
12459 #+LABEL: fig:SED-HR4049
12463 It could be rendered as shown below in the exported document.
12466 Figure 2: Bell curve
12469 @vindex org-odt-category-map-alist
12470 You can modify the category component of the caption by customizing the
12471 option @code{org-odt-category-map-alist}. For example, to tag all embedded
12472 images with the string @samp{Illustration} (instead of the default
12473 @samp{Figure}) use the following setting:
12476 (setq org-odt-category-map-alist
12477 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12480 With this, previous image will be captioned as below in the exported
12484 Illustration 2: Bell curve
12487 @node Literal examples in ODT export
12488 @subsection Literal examples in ODT export
12490 Export of literal examples (@pxref{Literal examples}) with full fontification
12491 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
12492 generate all style definitions needed for a fancy listing.@footnote{Your
12493 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12494 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
12495 as prefix and inherit their color from the faces used by Emacs
12496 @code{font-lock} library for the source language.
12498 @vindex org-odt-fontify-srcblocks
12499 If you prefer to use your own custom styles for fontification, you can do
12500 so by customizing the option
12501 @code{org-odt-create-custom-styles-for-srcblocks}.
12503 @vindex org-odt-create-custom-styles-for-srcblocks
12504 You can turn off fontification of literal examples by customizing the
12505 option @code{org-odt-fontify-srcblocks}.
12507 @node Advanced topics in ODT export
12508 @subsection Advanced topics in ODT export
12510 If you rely heavily on ODT export, you may want to exploit the full
12511 set of features that the exporter offers. This section describes features
12512 that would be of interest to power users.
12515 * Configuring a document converter:: How to register a document converter
12516 * Working with OpenDocument style files:: Explore the internals
12517 * Creating one-off styles:: How to produce custom highlighting etc
12518 * Customizing tables in ODT export:: How to define and use Table templates
12519 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
12522 @node Configuring a document converter
12523 @subsubheading Configuring a document converter
12525 @cindex doc, docx, rtf
12528 The ODT exporter can work with popular converters with little or no
12529 extra configuration from your side. @xref{Extending ODT export}.
12530 If you are using a converter that is not supported by default or if you would
12531 like to tweak the default converter settings, proceed as below.
12534 @item Register the converter
12536 @vindex org-odt-convert-processes
12537 Name your converter and add it to the list of known converters by
12538 customizing the option @code{org-odt-convert-processes}. Also specify how
12539 the converter can be invoked via command-line to effect the conversion.
12541 @item Configure its capabilities
12543 @vindex org-odt-convert-capabilities
12544 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12545 converter can handle by customizing the variable
12546 @code{org-odt-convert-capabilities}. Use the default value for this
12547 variable as a guide for configuring your converter. As suggested by the
12548 default setting, you can specify the full set of formats supported by the
12549 converter and not limit yourself to specifying formats that are related to
12550 just the OpenDocument Text format.
12552 @item Choose the converter
12554 @vindex org-odt-convert-process
12555 Select the newly added converter as the preferred one by customizing the
12556 option @code{org-odt-convert-process}.
12559 @node Working with OpenDocument style files
12560 @subsubheading Working with OpenDocument style files
12561 @cindex styles, custom
12562 @cindex template, custom
12564 This section explores the internals of the ODT exporter and the
12565 means by which it produces styled documents. Read this section if you are
12566 interested in exploring the automatic and custom OpenDocument styles used by
12569 @anchor{x-factory-styles}
12570 @subsubheading a) Factory styles
12572 The ODT exporter relies on two files for generating its output.
12573 These files are bundled with the distribution under the directory pointed to
12574 by the variable @code{org-odt-styles-dir}. The two files are:
12577 @anchor{x-orgodtstyles-xml}
12579 @file{OrgOdtStyles.xml}
12581 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12582 document. This file gets modified for the following purposes:
12586 To control outline numbering based on user settings.
12589 To add styles generated by @file{htmlfontify.el} for fontification of code
12593 @anchor{x-orgodtcontenttemplate-xml}
12595 @file{OrgOdtContentTemplate.xml}
12597 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12598 document. The contents of the Org outline are inserted between the
12599 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12601 Apart from serving as a template file for the final @file{content.xml}, the
12602 file serves the following purposes:
12606 It contains automatic styles for formatting of tables which are referenced by
12610 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12611 elements that control how various entities---tables, images, equations,
12612 etc.---are numbered.
12616 @anchor{x-overriding-factory-styles}
12617 @subsubheading b) Overriding factory styles
12618 The following two variables control the location from which the ODT
12619 exporter picks up the custom styles and content template files. You can
12620 customize these variables to override the factory styles used by the
12624 @anchor{x-org-odt-styles-file}
12626 @code{org-odt-styles-file}
12628 Use this variable to specify the @file{styles.xml} that will be used in the
12629 final output. You can specify one of the following values:
12632 @item A @file{styles.xml} file
12634 Use this file instead of the default @file{styles.xml}
12636 @item A @file{.odt} or @file{.ott} file
12638 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12641 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12643 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12644 Template file. Additionally extract the specified member files and embed
12645 those within the final @samp{ODT} document.
12647 Use this option if the @file{styles.xml} file references additional files
12648 like header and footer images.
12652 Use the default @file{styles.xml}
12655 @anchor{x-org-odt-content-template-file}
12657 @code{org-odt-content-template-file}
12659 Use this variable to specify the blank @file{content.xml} that will be used
12660 in the final output.
12663 @node Creating one-off styles
12664 @subsubheading Creating one-off styles
12666 There are times when you would want one-off formatting in the exported
12667 document. You can achieve this by embedding raw OpenDocument XML in the Org
12668 file. The use of this feature is better illustrated with couple of examples.
12671 @item Embedding ODT tags as part of regular text
12673 You can inline OpenDocument syntax by enclosing it within
12674 @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do
12678 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12679 text</text:span>@@@@. But this is a regular text.
12682 @strong{Hint:} To see the above example in action, edit your
12683 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12684 custom @samp{Highlight} style as shown below.
12687 <style:style style:name="Highlight" style:family="text">
12688 <style:text-properties fo:background-color="#ff0000"/>
12692 @item Embedding a one-line OpenDocument XML
12694 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12695 directive. For example, to force a page break do the following:
12698 #+ODT: <text:p text:style-name="PageBreak"/>
12701 @strong{Hint:} To see the above example in action, edit your
12702 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12703 custom @samp{PageBreak} style as shown below.
12706 <style:style style:name="PageBreak" style:family="paragraph"
12707 style:parent-style-name="Text_20_body">
12708 <style:paragraph-properties fo:break-before="page"/>
12712 @item Embedding a block of OpenDocument XML
12714 You can add a large block of OpenDocument XML using the
12715 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12717 For example, to create a one-off paragraph that uses bold text, do the
12722 <text:p text:style-name="Text_20_body_20_bold">
12723 This paragraph is specially formatted and uses bold text.
12730 @node Customizing tables in ODT export
12731 @subsubheading Customizing tables in ODT export
12732 @cindex tables, in ODT export
12735 You can override the default formatting of the table by specifying a custom
12736 table style with the @code{#+ATTR_ODT} line. For a discussion on default
12737 formatting of tables @pxref{Tables in ODT export}.
12739 This feature closely mimics the way table templates are defined in the
12741 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12742 OpenDocument-v1.2 Specification}}
12744 @vindex org-odt-table-styles
12745 To have a quick preview of this feature, install the below setting and
12746 export the table that follows:
12749 (setq org-odt-table-styles
12750 (append org-odt-table-styles
12751 '(("TableWithHeaderRowAndColumn" "Custom"
12752 ((use-first-row-styles . t)
12753 (use-first-column-styles . t)))
12754 ("TableWithFirstRowandLastRow" "Custom"
12755 ((use-first-row-styles . t)
12756 (use-last-row-styles . t))))))
12760 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12761 | Name | Phone | Age |
12762 | Peter | 1234 | 17 |
12763 | Anna | 4321 | 25 |
12766 In the above example, you used a template named @samp{Custom} and installed
12767 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12768 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
12769 styles needed for producing the above template have been pre-defined for
12770 you. These styles are available under the section marked @samp{Custom
12771 Table Template} in @file{OrgOdtContentTemplate.xml}
12772 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
12773 additional templates you have to define these styles yourselves.
12775 To use this feature proceed as follows:
12779 Create a table template@footnote{See the @code{<table:table-template>}
12780 element of the OpenDocument-v1.2 specification}
12782 A table template is nothing but a set of @samp{table-cell} and
12783 @samp{paragraph} styles for each of the following table cell categories:
12797 The names for the above styles must be chosen based on the name of the table
12798 template using a well-defined convention.
12800 The naming convention is better illustrated with an example. For a table
12801 template with the name @samp{Custom}, the needed style names are listed in
12802 the following table.
12804 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12805 @headitem Table cell type
12806 @tab @code{table-cell} style
12807 @tab @code{paragraph} style
12812 @tab @samp{CustomTableCell}
12813 @tab @samp{CustomTableParagraph}
12815 @tab @samp{CustomFirstColumnTableCell}
12816 @tab @samp{CustomFirstColumnTableParagraph}
12818 @tab @samp{CustomLastColumnTableCell}
12819 @tab @samp{CustomLastColumnTableParagraph}
12821 @tab @samp{CustomFirstRowTableCell}
12822 @tab @samp{CustomFirstRowTableParagraph}
12824 @tab @samp{CustomLastRowTableCell}
12825 @tab @samp{CustomLastRowTableParagraph}
12827 @tab @samp{CustomEvenRowTableCell}
12828 @tab @samp{CustomEvenRowTableParagraph}
12830 @tab @samp{CustomOddRowTableCell}
12831 @tab @samp{CustomOddRowTableParagraph}
12833 @tab @samp{CustomEvenColumnTableCell}
12834 @tab @samp{CustomEvenColumnTableParagraph}
12836 @tab @samp{CustomOddColumnTableCell}
12837 @tab @samp{CustomOddColumnTableParagraph}
12840 To create a table template with the name @samp{Custom}, define the above
12842 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12843 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12847 Define a table style@footnote{See the attributes @code{table:template-name},
12848 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12849 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12850 @code{table:use-banding-rows-styles}, and
12851 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12852 the OpenDocument-v1.2 specification}
12854 @vindex org-odt-table-styles
12855 To define a table style, create an entry for the style in the variable
12856 @code{org-odt-table-styles} and specify the following:
12859 @item the name of the table template created in step (1)
12860 @item the set of cell styles in that template that are to be activated
12863 For example, the entry below defines two different table styles
12864 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12865 based on the same template @samp{Custom}. The styles achieve their intended
12866 effect by selectively activating the individual cell styles in that template.
12869 (setq org-odt-table-styles
12870 (append org-odt-table-styles
12871 '(("TableWithHeaderRowAndColumn" "Custom"
12872 ((use-first-row-styles . t)
12873 (use-first-column-styles . t)))
12874 ("TableWithFirstRowandLastRow" "Custom"
12875 ((use-first-row-styles . t)
12876 (use-last-row-styles . t))))))
12880 Associate a table with the table style
12882 To do this, specify the table style created in step (2) as part of
12883 the @code{ATTR_ODT} line as shown below.
12886 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12887 | Name | Phone | Age |
12888 | Peter | 1234 | 17 |
12889 | Anna | 4321 | 25 |
12893 @node Validating OpenDocument XML
12894 @subsubheading Validating OpenDocument XML
12896 Occasionally, you will discover that the document created by the
12897 ODT exporter cannot be opened by your favorite application. One of
12898 the common reasons for this is that the @file{.odt} file is corrupt. In such
12899 cases, you may want to validate the document against the OpenDocument RELAX
12900 NG Compact Syntax (RNC) schema.
12902 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12903 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
12904 general help with validation (and schema-sensitive editing) of XML files:
12905 @inforef{Introduction,,nxml-mode}.
12907 @vindex org-odt-schema-dir
12908 If you have ready access to OpenDocument @file{.rnc} files and the needed
12909 schema-locating rules in a single folder, you can customize the variable
12910 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
12911 will take care of updating the @code{rng-schema-locating-files} for you.
12913 @c end opendocument
12916 @section Org export
12919 @code{org} export back-end creates a normalized version of the Org document
12920 in current buffer. In particular, it evaluates Babel code (@pxref{Evaluating
12921 code blocks}) and removes other back-ends specific contents.
12923 @subheading Org export commands
12926 @orgcmd{C-c C-e O o,org-org-export-to-org}
12927 Export as an Org document. For an Org file, @file{myfile.org}, the resulting
12928 file will be @file{myfile.org.org}. The file will be overwritten without
12930 @orgcmd{C-c C-e O O,org-org-export-as-org}
12931 Export to a temporary buffer. Do not create a file.
12933 Export to an Org file, then open it.
12936 @node iCalendar export
12937 @section iCalendar export
12938 @cindex iCalendar export
12940 @vindex org-icalendar-include-todo
12941 @vindex org-icalendar-use-deadline
12942 @vindex org-icalendar-use-scheduled
12943 @vindex org-icalendar-categories
12944 @vindex org-icalendar-alarm-time
12945 Some people use Org mode for keeping track of projects, but still prefer a
12946 standard calendar application for anniversaries and appointments. In this
12947 case it can be useful to show deadlines and other time-stamped items in Org
12948 files in the calendar application. Org mode can export calendar information
12949 in the standard iCalendar format. If you also want to have TODO entries
12950 included in the export, configure the variable
12951 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
12952 and TODO items as VTODO@. It will also create events from deadlines that are
12953 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
12954 to set the start and due dates for the TODO entry@footnote{See the variables
12955 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12956 As categories, it will use the tags locally defined in the heading, and the
12957 file/tree category@footnote{To add inherited tags or the TODO state,
12958 configure the variable @code{org-icalendar-categories}.}. See the variable
12959 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12962 @vindex org-icalendar-store-UID
12963 @cindex property, ID
12964 The iCalendar standard requires each entry to have a globally unique
12965 identifier (UID). Org creates these identifiers during export. If you set
12966 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12967 @code{:ID:} property of the entry and re-used next time you report this
12968 entry. Since a single entry can give rise to multiple iCalendar entries (as
12969 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12970 prefixes to the UID, depending on what triggered the inclusion of the entry.
12971 In this way the UID remains unique, but a synchronization program can still
12972 figure out from which entry all the different instances originate.
12975 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
12976 Create iCalendar entries for the current buffer and store them in the same
12977 directory, using a file extension @file{.ics}.
12978 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
12979 @vindex org-agenda-files
12980 Like @kbd{C-c C-e c f}, but do this for all files in
12981 @code{org-agenda-files}. For each of these files, a separate iCalendar
12982 file will be written.
12983 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
12984 @vindex org-icalendar-combined-agenda-file
12985 Create a single large iCalendar file from all files in
12986 @code{org-agenda-files} and write it to the file given by
12987 @code{org-icalendar-combined-agenda-file}.
12990 @vindex org-use-property-inheritance
12991 @vindex org-icalendar-include-body
12992 @cindex property, SUMMARY
12993 @cindex property, DESCRIPTION
12994 @cindex property, LOCATION
12995 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12996 property can be inherited from higher in the hierarchy if you configure
12997 @code{org-use-property-inheritance} accordingly.} properties if the selected
12998 entries have them. If not, the summary will be derived from the headline,
12999 and the description from the body (limited to
13000 @code{org-icalendar-include-body} characters).
13002 How this calendar is best read and updated, depends on the application
13003 you are using. The FAQ covers this issue.
13005 @node Other built-in back-ends
13006 @section Other built-in back-ends
13007 @cindex export back-ends, built-in
13008 @vindex org-export-backends
13010 On top of the aforementioned back-ends, Org comes with other built-in ones:
13013 @item @file{ox-man.el}: export to a man page.
13014 @item @file{ox-texinfo.el}: export to @code{Texinfo} format.
13017 To activate these export back-ends, customize @code{org-export-backends} or
13018 load them directly with e.g., @code{(require 'ox-texinfo)}. This will add
13019 new keys in the export dispatcher (@pxref{The export dispatcher}).
13021 See the comment section of these files for more information on how to use
13024 @node Export in foreign buffers
13025 @section Export in foreign buffers
13027 Most built-in back-ends come with a command to convert the selected region
13028 into a selected format and replace this region by the exported output. Here
13029 is a list of such conversion commands:
13032 @item org-html-convert-region-to-html
13033 Convert the selected region into HTML.
13034 @item org-latex-convert-region-to-latex
13035 Convert the selected region into @LaTeX{}.
13036 @item org-texinfo-convert-region-to-texinfo
13037 Convert the selected region into @code{Texinfo}.
13038 @item org-md-convert-region-to-md
13039 Convert the selected region into @code{MarkDown}.
13042 This is particularly useful for converting tables and lists in foreign
13043 buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13044 use Org commands for editing a list, and finally select and convert the list
13045 with @code{M-x org-html-convert-region-to-html RET}.
13047 @node Advanced configuration
13048 @section Advanced configuration
13052 @vindex org-export-before-processing-hook
13053 @vindex org-export-before-parsing-hook
13054 Two hooks are run during the first steps of the export process. The first
13055 one, @code{org-export-before-processing-hook} is called before expanding
13056 macros, Babel code and include keywords in the buffer. The second one,
13057 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13058 before parsing the buffer. Their main use is for heavy duties, that is
13059 duties involving structural modifications of the document. For example, one
13060 may want to remove every headline in the buffer during export. The following
13061 code can achieve this:
13065 (defun my-headline-removal (backend)
13066 "Remove all headlines in the current buffer.
13067 BACKEND is the export back-end being used, as a symbol."
13069 (lambda () (delete-region (point) (progn (forward-line) (point))))))
13071 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13075 Note that functions used in these hooks require a mandatory argument,
13076 a symbol representing the back-end used.
13078 @subheading Filters
13080 @cindex Filters, exporting
13081 Filters are lists of functions applied on a specific part of the output from
13082 a given back-end. More explicitly, each time a back-end transforms an Org
13083 object or element into another language, all functions within a given filter
13084 type are called in turn on the string produced. The string returned by the
13085 last function will be the one used in the final output.
13087 There are filter sets for each type of element or object, for plain text,
13088 for the parse tree, for the export options and for the final output. They
13089 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13090 where @code{TYPE} is the type targeted by the filter. Valid types are:
13092 @multitable @columnfractions .33 .33 .33
13099 @item comment-block
13102 @item dynamic-block
13106 @tab export-snippet
13109 @tab footnote-definition
13110 @tab footnote-reference
13112 @tab horizontal-rule
13113 @tab inline-babel-call
13114 @item inline-src-block
13119 @tab latex-environment
13120 @item latex-fragment
13123 @item node-property
13130 @tab property-drawer
13132 @item quote-section
13135 @item special-block
13137 @tab statistics-cookie
13138 @item strike-through
13152 For example, the following snippet allows me to use non-breaking spaces in
13153 the Org buffer and get them translated into @LaTeX{} without using the
13154 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13158 (defun my-latex-filter-nobreaks (text backend info)
13159 "Ensure \"Â \" are properly handled in LaTeX export."
13160 (when (org-export-derived-backend-p backend 'latex)
13161 (replace-regexp-in-string "Â " "~" text)))
13163 (add-to-list 'org-export-filter-plain-text-functions
13164 'my-latex-filter-nobreaks)
13168 Three arguments must be provided to a filter: the code being changed, the
13169 back-end used, and some information about the export process. You can safely
13170 ignore the third argument for most purposes. Note the use of
13171 @code{org-export-derived-backend-p}, which ensures that the filter will only
13172 be applied when using @code{latex} back-end or any other back-end derived
13173 from it (e.g., @code{beamer}).
13175 @subheading Defining filters for individual files
13177 You can customize the export for just a specific file by binding export
13178 filter variables using @code{#+BIND}. Here is an example where we introduce
13179 two filters, one to remove brackets from time stamps, and one to entirely
13180 remove any strike-through text. The functions doing the filtering are
13181 defined in an src block that allows the filter function definitions to exist
13182 in the file itself and ensures that the functions will be there when needed.
13185 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
13186 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
13187 #+begin_src emacs-lisp :exports results :results none
13188 (defun tmp-f-timestamp (s backend info)
13189 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
13190 (defun tmp-f-strike-through (s backend info) "")
13194 @subheading Extending an existing back-end
13196 This is obviously the most powerful customization, since the changes happen
13197 at the parser level. Indeed, some export back-ends are built as extensions
13198 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13200 Extending a back-end means that if an element type is not transcoded by the
13201 new back-end, it will be handled by the original one. Hence you can extend
13202 specific parts of a back-end without too much work.
13204 As an example, imagine we want the @code{ascii} back-end to display the
13205 language used in a source block, when it is available, but only when some
13206 attribute is non-@code{nil}, like the following:
13209 #+ATTR_ASCII: :language t
13212 Because that back-end is lacking in that area, we are going to create a new
13213 back-end, @code{my-ascii} that will do the job.
13217 (defun my-ascii-src-block (src-block contents info)
13218 "Transcode a SRC-BLOCK element from Org to ASCII.
13219 CONTENTS is nil. INFO is a plist used as a communication
13221 (if (not (org-export-read-attribute :attr_ascii src-block :language))
13222 (org-export-with-backend 'ascii src-block contents info)
13224 (format ",--[ %s ]--\n%s`----"
13225 (org-element-property :language src-block)
13226 (replace-regexp-in-string
13228 (org-element-normalize-string
13229 (org-export-format-code-default src-block info)))))))
13231 (org-export-define-derived-backend 'my-ascii 'ascii
13232 :translate-alist '((src-block . my-ascii-src-block)))
13236 The @code{my-ascii-src-block} function looks at the attribute above the
13237 element. If it isn't true, it gives hand to the @code{ascii} back-end.
13238 Otherwise, it creates a box around the code, leaving room for the language.
13239 A new back-end is then created. It only changes its behavior when
13240 translating @code{src-block} type element. Now, all it takes to use the new
13241 back-end is calling the following from an Org buffer:
13244 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13247 It is obviously possible to write an interactive function for this, install
13248 it in the export dispatcher menu, and so on.
13252 @chapter Publishing
13255 Org includes a publishing management system that allows you to configure
13256 automatic HTML conversion of @emph{projects} composed of interlinked org
13257 files. You can also configure Org to automatically upload your exported HTML
13258 pages and related attachments, such as images and source code files, to a web
13261 You can also use Org to convert files into PDF, or even combine HTML and PDF
13262 conversion so that files are available in both formats on the server.
13264 Publishing has been contributed to Org by David O'Toole.
13267 * Configuration:: Defining projects
13268 * Uploading files:: How to get files up on the server
13269 * Sample configuration:: Example projects
13270 * Triggering publication:: Publication commands
13273 @node Configuration
13274 @section Configuration
13276 Publishing needs significant configuration to specify files, destination
13277 and many other properties of a project.
13280 * Project alist:: The central configuration variable
13281 * Sources and destinations:: From here to there
13282 * Selecting files:: What files are part of the project?
13283 * Publishing action:: Setting the function doing the publishing
13284 * Publishing options:: Tweaking HTML/@LaTeX{} export
13285 * Publishing links:: Which links keep working after publishing?
13286 * Sitemap:: Generating a list of all pages
13287 * Generating an index:: An index that reaches across pages
13290 @node Project alist
13291 @subsection The variable @code{org-publish-project-alist}
13292 @cindex org-publish-project-alist
13293 @cindex projects, for publishing
13295 @vindex org-publish-project-alist
13296 Publishing is configured almost entirely through setting the value of one
13297 variable, called @code{org-publish-project-alist}. Each element of the list
13298 configures one project, and may be in one of the two following forms:
13301 ("project-name" :property value :property value ...)
13302 @r{i.e., a well-formed property list with alternating keys and values}
13304 ("project-name" :components ("project-name" "project-name" ...))
13308 In both cases, projects are configured by specifying property values. A
13309 project defines the set of files that will be published, as well as the
13310 publishing configuration to use when publishing those files. When a project
13311 takes the second form listed above, the individual members of the
13312 @code{:components} property are taken to be sub-projects, which group
13313 together files requiring different publishing options. When you publish such
13314 a ``meta-project'', all the components will also be published, in the
13317 @node Sources and destinations
13318 @subsection Sources and destinations for files
13319 @cindex directories, for publishing
13321 Most properties are optional, but some should always be set. In
13322 particular, Org needs to know where to look for source files,
13323 and where to put published files.
13325 @multitable @columnfractions 0.3 0.7
13326 @item @code{:base-directory}
13327 @tab Directory containing publishing source files
13328 @item @code{:publishing-directory}
13329 @tab Directory where output files will be published. You can directly
13330 publish to a web server using a file name syntax appropriate for
13331 the Emacs @file{tramp} package. Or you can publish to a local directory and
13332 use external tools to upload your website (@pxref{Uploading files}).
13333 @item @code{:preparation-function}
13334 @tab Function or list of functions to be called before starting the
13335 publishing process, for example, to run @code{make} for updating files to be
13336 published. The project property list is scoped into this call as the
13337 variable @code{project-plist}.
13338 @item @code{:completion-function}
13339 @tab Function or list of functions called after finishing the publishing
13340 process, for example, to change permissions of the resulting files. The
13341 project property list is scoped into this call as the variable
13342 @code{project-plist}.
13346 @node Selecting files
13347 @subsection Selecting files
13348 @cindex files, selecting for publishing
13350 By default, all files with extension @file{.org} in the base directory
13351 are considered part of the project. This can be modified by setting the
13353 @multitable @columnfractions 0.25 0.75
13354 @item @code{:base-extension}
13355 @tab Extension (without the dot!) of source files. This actually is a
13356 regular expression. Set this to the symbol @code{any} if you want to get all
13357 files in @code{:base-directory}, even without extension.
13359 @item @code{:exclude}
13360 @tab Regular expression to match file names that should not be
13361 published, even though they have been selected on the basis of their
13364 @item @code{:include}
13365 @tab List of files to be included regardless of @code{:base-extension}
13366 and @code{:exclude}.
13368 @item @code{:recursive}
13369 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13372 @node Publishing action
13373 @subsection Publishing action
13374 @cindex action, for publishing
13376 Publishing means that a file is copied to the destination directory and
13377 possibly transformed in the process. The default transformation is to export
13378 Org files as HTML files, and this is done by the function
13379 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13380 export}). But you also can publish your content as PDF files using
13381 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13382 using the corresponding functions.
13384 If you want to publish the Org file as an @code{.org} file but with the
13385 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13386 function @code{org-org-publish-to-org}. This will produce @file{file.org}
13387 and put it in the publishing directory. If you want a htmlized version of
13388 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13389 produce @file{file.org.html} in the publishing directory@footnote{If the
13390 publishing directory is the same than the source directory, @file{file.org}
13391 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13393 Other files like images only need to be copied to the publishing destination.
13394 For this you can use @code{org-publish-attachment}. For non-org files, you
13395 always need to specify the publishing function:
13397 @multitable @columnfractions 0.3 0.7
13398 @item @code{:publishing-function}
13399 @tab Function executing the publication of a file. This may also be a
13400 list of functions, which will all be called in turn.
13401 @item @code{:htmlized-source}
13402 @tab non-@code{nil} means, publish htmlized source.
13405 The function must accept three arguments: a property list containing at least
13406 a @code{:publishing-directory} property, the name of the file to be published
13407 and the path to the publishing directory of the output file. It should take
13408 the specified file, make the necessary transformation (if any) and place the
13409 result into the destination folder.
13411 @node Publishing options
13412 @subsection Options for the exporters
13413 @cindex options, for publishing
13415 The property list can be used to set export options during the publishing
13416 process. In most cases, these properties correspond to user variables in
13417 Org. While some properties are available for all export back-ends, most of
13418 them are back-end specific. The following sections list properties along
13419 with the variable they belong to. See the documentation string of these
13420 options for details.
13422 @vindex org-publish-project-alist
13423 When a property is given a value in @code{org-publish-project-alist}, its
13424 setting overrides the value of the corresponding user variable (if any)
13425 during publishing. Options set within a file (@pxref{Export settings}),
13426 however, override everything.
13428 @subsubheading Generic properties
13430 @multitable {@code{:with-sub-superscript}} {@code{org-export-with-sub-superscripts}}
13431 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
13432 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
13433 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
13434 @item @code{:language} @tab @code{org-export-default-language}
13435 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
13436 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
13437 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
13438 @item @code{:select-tags} @tab @code{org-export-select-tags}
13439 @item @code{:with-author} @tab @code{org-export-with-author}
13440 @item @code{:with-creator} @tab @code{org-export-with-creator}
13441 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
13442 @item @code{:with-email} @tab @code{org-export-with-email}
13443 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
13444 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
13445 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
13446 @item @code{:with-latex} @tab @code{org-export-with-latex}
13447 @item @code{:with-planning} @tab @code{org-export-with-planning}
13448 @item @code{:with-priority} @tab @code{org-export-with-priority}
13449 @item @code{:with-properties} @tab @code{org-export-with-properties}
13450 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
13451 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
13452 @item @code{:with-tables} @tab @code{org-export-with-tables}
13453 @item @code{:with-tags} @tab @code{org-export-with-tags}
13454 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
13455 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
13456 @item @code{:with-toc} @tab @code{org-export-with-toc}
13457 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
13460 @subsubheading ASCII specific properties
13462 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
13463 @item @code{:ascii-bullets} @tab @code{org-ascii-bullets}
13464 @item @code{:ascii-caption-above} @tab @code{org-ascii-caption-above}
13465 @item @code{:ascii-charset} @tab @code{org-ascii-charset}
13466 @item @code{:ascii-global-margin} @tab @code{org-ascii-global-margin}
13467 @item @code{:ascii-format-drawer-function} @tab @code{org-ascii-format-drawer-function}
13468 @item @code{:ascii-format-inlinetask-function} @tab @code{org-ascii-format-inlinetask-function}
13469 @item @code{:ascii-headline-spacing} @tab @code{org-ascii-headline-spacing}
13470 @item @code{:ascii-indented-line-width} @tab @code{org-ascii-indented-line-width}
13471 @item @code{:ascii-inlinetask-width} @tab @code{org-ascii-inlinetask-width}
13472 @item @code{:ascii-inner-margin} @tab @code{org-ascii-inner-margin}
13473 @item @code{:ascii-links-to-notes} @tab @code{org-ascii-links-to-notes}
13474 @item @code{:ascii-paragraph-spacing} @tab @code{org-ascii-paragraph-spacing}
13475 @item @code{:ascii-quote-margin} @tab @code{org-ascii-quote-margin}
13476 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
13477 @item @code{:ascii-table-use-ascii-art} @tab @code{org-ascii-table-use-ascii-art}
13478 @item @code{:ascii-table-widen-columns} @tab @code{org-ascii-table-widen-columns}
13479 @item @code{:ascii-text-width} @tab @code{org-ascii-text-width}
13480 @item @code{:ascii-underline} @tab @code{org-ascii-underline}
13481 @item @code{:ascii-verbatim-format} @tab @code{org-ascii-verbatim-format}
13484 @subsubheading Beamer specific properties
13486 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
13487 @item @code{:beamer-theme} @tab @code{org-beamer-theme}
13488 @item @code{:beamer-column-view-format} @tab @code{org-beamer-column-view-format}
13489 @item @code{:beamer-environments-extra} @tab @code{org-beamer-environments-extra}
13490 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
13491 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
13492 @item @code{:beamer-outline-frame-title} @tab @code{org-beamer-outline-frame-title}
13495 @subsubheading HTML specific properties
13497 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
13498 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
13499 @item @code{:html-coding-system} @tab @code{org-html-coding-system}
13500 @item @code{:html-container} @tab @code{org-html-container-element}
13501 @item @code{:html-divs} @tab @code{org-html-divs}
13502 @item @code{:html-doctype} @tab @code{org-html-doctype}
13503 @item @code{:html-extension} @tab @code{org-html-extension}
13504 @item @code{:html-footnote-format} @tab @code{org-html-footnote-format}
13505 @item @code{:html-footnote-separator} @tab @code{org-html-footnote-separator}
13506 @item @code{:html-footnotes-section} @tab @code{org-html-footnotes-section}
13507 @item @code{:html-format-drawer-function} @tab @code{org-html-format-drawer-function}
13508 @item @code{:html-format-headline-function} @tab @code{org-html-format-headline-function}
13509 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
13510 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
13511 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
13512 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
13513 @item @code{:html-head} @tab @code{org-html-head}
13514 @item @code{:html-home/up-format} @tab @code{org-html-home/up-format}
13515 @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy}
13516 @item @code{:html-htmlize-font-prefix} @tab @code{org-html-htmlize-font-prefix}
13517 @item @code{:html-htmlize-output-type} @tab @code{org-html-htmlize-output-type}
13518 @item @code{:html-indent} @tab @code{org-html-indent}
13519 @item @code{:html-infojs-options} @tab @code{org-html-infojs-options}
13520 @item @code{:html-infojs-template} @tab @code{org-html-infojs-template}
13521 @item @code{:html-inline-image-rules} @tab @code{org-html-inline-image-rules}
13522 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
13523 @item @code{:html-link-home} @tab @code{org-html-link-home}
13524 @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html}
13525 @item @code{:html-link-up} @tab @code{org-html-link-up}
13526 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
13527 @item @code{:html-mathjax-options} @tab @code{org-html-mathjax-options}
13528 @item @code{:html-mathjax-template} @tab @code{org-html-mathjax-template}
13529 @item @code{:html-metadata-timestamp-format} @tab @code{org-html-metadata-timestamp-format}
13530 @item @code{:html-postamble-format} @tab @code{org-html-postamble-format}
13531 @item @code{:html-postamble} @tab @code{org-html-postamble}
13532 @item @code{:html-preamble-format} @tab @code{org-html-preamble-format}
13533 @item @code{:html-preamble} @tab @code{org-html-preamble}
13534 @item @code{:html-protect-char-alist} @tab @code{org-html-protect-char-alist}
13535 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
13536 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
13537 @item @code{:html-table-caption-above} @tab @code{org-html-table-caption-above}
13538 @item @code{:html-table-data-tags} @tab @code{org-html-table-data-tags}
13539 @item @code{:html-table-header-tags} @tab @code{org-html-table-header-tags}
13540 @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags}
13541 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
13542 @item @code{:html-tag-class-prefix} @tab @code{org-html-tag-class-prefix}
13543 @item @code{:html-text-markup-alist} @tab @code{org-html-text-markup-alist}
13544 @item @code{:html-todo-kwd-class-prefix} @tab @code{org-html-todo-kwd-class-prefix}
13545 @item @code{:html-toplevel-hlevel} @tab @code{org-html-toplevel-hlevel}
13546 @item @code{:html-use-infojs} @tab @code{org-html-use-infojs}
13547 @item @code{:html-use-unicode-chars} @tab @code{org-html-use-unicode-chars}
13548 @item @code{:html-validation-link} @tab @code{org-html-validation-link}
13549 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
13552 @subsubheading @LaTeX{} specific properties
13554 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}}
13555 @item @code{:latex-active-timestamp-format} @tab @code{org-latex-active-timestamp-format}
13556 @item @code{:latex-classes} @tab @code{org-latex-classes}
13557 @item @code{:latex-class} @tab @code{org-latex-default-class}
13558 @item @code{:latex-default-figure-position} @tab @code{org-latex-default-figure-position}
13559 @item @code{:latex-default-table-environment} @tab @code{org-latex-default-table-environment}
13560 @item @code{:latex-default-table-mode} @tab @code{org-latex-default-table-mode}
13561 @item @code{:latex-diary-timestamp-format} @tab @code{org-latex-diary-timestamp-format}
13562 @item @code{:latex-footnote-separator} @tab @code{org-latex-footnote-separator}
13563 @item @code{:latex-format-drawer-function} @tab @code{org-latex-format-drawer-function}
13564 @item @code{:latex-format-headline-function} @tab @code{org-latex-format-headline-function}
13565 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
13566 @item @code{:latex-hyperref-template} @tab @code{org-latex-hyperref-template}
13567 @item @code{:latex-image-default-height} @tab @code{org-latex-image-default-height}
13568 @item @code{:latex-image-default-option} @tab @code{org-latex-image-default-option}
13569 @item @code{:latex-image-default-width} @tab @code{org-latex-image-default-width}
13570 @item @code{:latex-inactive-timestamp-format} @tab @code{org-latex-inactive-timestamp-format}
13571 @item @code{:latex-inline-image-rules} @tab @code{org-latex-inline-image-rules}
13572 @item @code{:latex-inputenc-alist} @tab @code{org-latex-inputenc-alist}
13573 @item @code{:latex-known-warnings} @tab @code{org-latex-known-warnings}
13574 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
13575 @item @code{:latex-listings-langs} @tab @code{org-latex-listings-langs}
13576 @item @code{:latex-listings-options} @tab @code{org-latex-listings-options}
13577 @item @code{:latex-listings} @tab @code{org-latex-listings}
13578 @item @code{:latex-logfiles-extensions} @tab @code{org-latex-logfiles-extensions}
13579 @item @code{:latex-minted-langs} @tab @code{org-latex-minted-langs}
13580 @item @code{:latex-minted-options} @tab @code{org-latex-minted-options}
13581 @item @code{:latex-pdf-process} @tab @code{org-latex-pdf-process}
13582 @item @code{:latex-remove-logfiles} @tab @code{org-latex-remove-logfiles}
13583 @item @code{:latex-table-caption-above} @tab @code{org-latex-table-caption-above}
13584 @item @code{:latex-table-scientific-notation} @tab @code{org-latex-table-scientific-notation}
13585 @item @code{:latex-tables-booktabs} @tab @code{org-latex-tables-booktabs}
13586 @item @code{:latex-tables-centered} @tab @code{org-latex-tables-centered}
13587 @item @code{:latex-text-markup-alist} @tab @code{org-latex-text-markup-alist}
13588 @item @code{:latex-title-command} @tab @code{org-latex-title-command}
13589 @item @code{:latex-toc-command} @tab @code{org-latex-toc-command}
13592 @subsubheading Markdown specific properties
13594 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
13595 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
13598 @subsubheading ODT specific properties
13600 @multitable {@code{:odt-create-custom-styles-for-srcblocks}} {@code{org-odt-create-custom-styles-for-srcblocks}}
13601 @item @code{:odt-convert-capabilities} @tab @code{org-odt-convert-capabilities}
13602 @item @code{:odt-convert-processes} @tab @code{org-odt-convert-processes}
13603 @item @code{:odt-convert-process} @tab @code{org-odt-convert-process}
13604 @item @code{:odt-create-custom-styles-for-srcblocks} @tab @code{org-odt-create-custom-styles-for-srcblocks}
13605 @item @code{:odt-display-outline-level} @tab @code{org-odt-display-outline-level}
13606 @item @code{:odt-fontify-srcblocks} @tab @code{org-odt-fontify-srcblocks}
13607 @item @code{:odt-format-drawer-function} @tab @code{org-odt-format-drawer-function}
13608 @item @code{:odt-format-headline-function} @tab @code{org-odt-format-headline-function}
13609 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
13610 @item @code{:odt-inline-formula-rules} @tab @code{org-odt-inline-formula-rules}
13611 @item @code{:odt-inline-image-rules} @tab @code{org-odt-inline-image-rules}
13612 @item @code{:odt-pixels-per-inch} @tab @code{org-odt-pixels-per-inch}
13613 @item @code{:odt-preferred-output-format} @tab @code{org-odt-preferred-output-format}
13614 @item @code{:odt-prettify-xml} @tab @code{org-odt-prettify-xml}
13615 @item @code{:odt-schema-dir} @tab @code{org-odt-schema-dir}
13616 @item @code{:odt-styles-file} @tab @code{org-odt-content-template-file}
13617 @item @code{:odt-styles-file} @tab @code{org-odt-styles-file}
13618 @item @code{:odt-table-styles} @tab @code{org-odt-table-styles}
13619 @item @code{:odt-use-date-fields} @tab @code{org-odt-use-date-fields}
13622 @subsubheading Org specific properties
13624 @multitable {@code{:org-htmlized-css-url}} {@code{org-org-htmlized-css-url}}
13625 @item @code{:org-htmlized-css-url} @tab @code{org-org-htmlized-css-url}
13628 @subsubheading Texinfo specific properties
13630 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
13631 @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format}
13632 @item @code{:texinfo-classes} @tab @code{org-texinfo-classes}
13633 @item @code{:texinfo-class} @tab @code{org-texinfo-default-class}
13634 @item @code{:texinfo-coding-system} @tab @code{org-texinfo-coding-system}
13635 @item @code{:texinfo-def-table-markup} @tab @code{org-texinfo-def-table-markup}
13636 @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format}
13637 @item @code{:texinfo-filename} @tab @code{org-texinfo-filename}
13638 @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function}
13639 @item @code{:texinfo-format-headline-function} @tab @code{org-texinfo-format-headline-function}
13640 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
13641 @item @code{:texinfo-inactive-timestamp-format} @tab @code{org-texinfo-inactive-timestamp-format}
13642 @item @code{:texinfo-info-process} @tab @code{org-texinfo-info-process}
13643 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
13644 @item @code{:texinfo-logfiles-extensions} @tab @code{org-texinfo-logfiles-extensions}
13645 @item @code{:texinfo-node-description-column} @tab @code{org-texinfo-node-description-column}
13646 @item @code{:texinfo-remove-logfiles} @tab @code{org-texinfo-remove-logfiles}
13647 @item @code{:texinfo-table-scientific-notation} @tab @code{org-texinfo-table-scientific-notation}
13648 @item @code{:texinfo-tables-verbatim} @tab @code{org-texinfo-tables-verbatim}
13649 @item @code{:texinfo-text-markup-alist} @tab @code{org-texinfo-text-markup-alist}
13652 @node Publishing links
13653 @subsection Links between published files
13654 @cindex links, publishing
13656 To create a link from one Org file to another, you would use something like
13657 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
13658 (@pxref{Hyperlinks}). When published, this link becomes a link to
13659 @file{foo.html}. You can thus interlink the pages of your "org web" project
13660 and the links will work as expected when you publish them to HTML@. If you
13661 also publish the Org source file and want to link to it, use an @code{http:}
13662 link instead of a @code{file:} link, because @code{file:} links are converted
13663 to link to the corresponding @file{html} file.
13665 You may also link to related files, such as images. Provided you are careful
13666 with relative file names, and provided you have also configured Org to upload
13667 the related files, these links will work too. See @ref{Complex example}, for
13668 an example of this usage.
13671 @subsection Generating a sitemap
13672 @cindex sitemap, of published pages
13674 The following properties may be used to control publishing of
13675 a map of files for a given project.
13677 @multitable @columnfractions 0.35 0.65
13678 @item @code{:auto-sitemap}
13679 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
13680 or @code{org-publish-all}.
13682 @item @code{:sitemap-filename}
13683 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
13684 becomes @file{sitemap.html}).
13686 @item @code{:sitemap-title}
13687 @tab Title of sitemap page. Defaults to name of file.
13689 @item @code{:sitemap-function}
13690 @tab Plug-in function to use for generation of the sitemap.
13691 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
13692 of links to all files in the project.
13694 @item @code{:sitemap-sort-folders}
13695 @tab Where folders should appear in the sitemap. Set this to @code{first}
13696 (default) or @code{last} to display folders first or last,
13697 respectively. Any other value will mix files and folders.
13699 @item @code{:sitemap-sort-files}
13700 @tab How the files are sorted in the site map. Set this to
13701 @code{alphabetically} (default), @code{chronologically} or
13702 @code{anti-chronologically}. @code{chronologically} sorts the files with
13703 older date first while @code{anti-chronologically} sorts the files with newer
13704 date first. @code{alphabetically} sorts the files alphabetically. The date of
13705 a file is retrieved with @code{org-publish-find-date}.
13707 @item @code{:sitemap-ignore-case}
13708 @tab Should sorting be case-sensitive? Default @code{nil}.
13710 @item @code{:sitemap-file-entry-format}
13711 @tab With this option one can tell how a sitemap's entry is formatted in the
13712 sitemap. This is a format string with some escape sequences: @code{%t} stands
13713 for the title of the file, @code{%a} stands for the author of the file and
13714 @code{%d} stands for the date of the file. The date is retrieved with the
13715 @code{org-publish-find-date} function and formatted with
13716 @code{org-publish-sitemap-date-format}. Default @code{%t}.
13718 @item @code{:sitemap-date-format}
13719 @tab Format string for the @code{format-time-string} function that tells how
13720 a sitemap entry's date is to be formatted. This property bypasses
13721 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
13723 @item @code{:sitemap-sans-extension}
13724 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
13725 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
13726 Defaults to @code{nil}.
13730 @node Generating an index
13731 @subsection Generating an index
13732 @cindex index, in a publishing project
13734 Org mode can generate an index across the files of a publishing project.
13736 @multitable @columnfractions 0.25 0.75
13737 @item @code{:makeindex}
13738 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
13739 publish it as @file{theindex.html}.
13742 The file will be created when first publishing a project with the
13743 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
13744 "theindex.inc"}. You can then build around this include statement by adding
13745 a title, style information, etc.
13747 @node Uploading files
13748 @section Uploading files
13752 For those people already utilizing third party sync tools such as
13753 @command{rsync} or @command{unison}, it might be preferable not to use the built in
13754 @i{remote} publishing facilities of Org mode which rely heavily on
13755 Tramp. Tramp, while very useful and powerful, tends not to be
13756 so efficient for multiple file transfer and has been known to cause problems
13759 Specialized synchronization utilities offer several advantages. In addition
13760 to timestamp comparison, they also do content and permissions/attribute
13761 checks. For this reason you might prefer to publish your web to a local
13762 directory (possibly even @i{in place} with your Org files) and then use
13763 @file{unison} or @file{rsync} to do the synchronization with the remote host.
13765 Since Unison (for example) can be configured as to which files to transfer to
13766 a certain remote destination, it can greatly simplify the project publishing
13767 definition. Simply keep all files in the correct location, process your Org
13768 files with @code{org-publish} and let the synchronization tool do the rest.
13769 You do not need, in this scenario, to include attachments such as @file{jpg},
13770 @file{css} or @file{gif} files in the project definition since the 3rd party
13773 Publishing to a local directory is also much faster than to a remote one, so
13774 that you can afford more easily to republish entire projects. If you set
13775 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
13776 benefit of re-including any changed external files such as source example
13777 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
13778 Org is not smart enough to detect if included files have been modified.
13780 @node Sample configuration
13781 @section Sample configuration
13783 Below we provide two example configurations. The first one is a simple
13784 project publishing only a set of Org files. The second example is
13785 more complex, with a multi-component project.
13788 * Simple example:: One-component publishing
13789 * Complex example:: A multi-component publishing example
13792 @node Simple example
13793 @subsection Example: simple publishing configuration
13795 This example publishes a set of Org files to the @file{public_html}
13796 directory on the local machine.
13799 (setq org-publish-project-alist
13801 :base-directory "~/org/"
13802 :publishing-directory "~/public_html"
13803 :section-numbers nil
13805 :html-head "<link rel=\"stylesheet\"
13806 href=\"../other/mystyle.css\"
13807 type=\"text/css\"/>")))
13810 @node Complex example
13811 @subsection Example: complex publishing configuration
13813 This more complicated example publishes an entire website, including
13814 Org files converted to HTML, image files, Emacs Lisp source code, and
13815 style sheets. The publishing directory is remote and private files are
13818 To ensure that links are preserved, care should be taken to replicate
13819 your directory structure on the web server, and to use relative file
13820 paths. For example, if your Org files are kept in @file{~/org} and your
13821 publishable images in @file{~/images}, you would link to an image with
13824 file:../images/myimage.png
13827 On the web server, the relative path to the image should be the
13828 same. You can accomplish this by setting up an "images" folder in the
13829 right place on the web server, and publishing images to it.
13832 (setq org-publish-project-alist
13834 :base-directory "~/org/"
13835 :base-extension "org"
13836 :publishing-directory "/ssh:user@@host:~/html/notebook/"
13837 :publishing-function org-html-publish-to-html
13838 :exclude "PrivatePage.org" ;; regexp
13840 :section-numbers nil
13842 :html-head "<link rel=\"stylesheet\"
13843 href=\"../other/mystyle.css\" type=\"text/css\"/>"
13847 :base-directory "~/images/"
13848 :base-extension "jpg\\|gif\\|png"
13849 :publishing-directory "/ssh:user@@host:~/html/images/"
13850 :publishing-function org-publish-attachment)
13853 :base-directory "~/other/"
13854 :base-extension "css\\|el"
13855 :publishing-directory "/ssh:user@@host:~/html/other/"
13856 :publishing-function org-publish-attachment)
13857 ("website" :components ("orgfiles" "images" "other"))))
13860 @node Triggering publication
13861 @section Triggering publication
13863 Once properly configured, Org can publish with the following commands:
13866 @orgcmd{C-c C-e P x,org-publish}
13867 Prompt for a specific project and publish all files that belong to it.
13868 @orgcmd{C-c C-e P p,org-publish-current-project}
13869 Publish the project containing the current file.
13870 @orgcmd{C-c C-e P f,org-publish-current-file}
13871 Publish only the current file.
13872 @orgcmd{C-c C-e P a,org-publish-all}
13873 Publish every project.
13876 @vindex org-publish-use-timestamps-flag
13877 Org uses timestamps to track when a file has changed. The above functions
13878 normally only publish changed files. You can override this and force
13879 publishing of all files by giving a prefix argument to any of the commands
13880 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
13881 This may be necessary in particular if files include other files via
13882 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
13885 @node Working with source code
13886 @chapter Working with source code
13887 @cindex Schulte, Eric
13888 @cindex Davison, Dan
13889 @cindex source code, working with
13891 Source code can be included in Org mode documents using a @samp{src} block,
13895 #+BEGIN_SRC emacs-lisp
13896 (defun org-xor (a b)
13902 Org mode provides a number of features for working with live source code,
13903 including editing of code blocks in their native major-mode, evaluation of
13904 code blocks, converting code blocks into source files (known as @dfn{tangling}
13905 in literate programming), and exporting code blocks and their
13906 results in several formats. This functionality was contributed by Eric
13907 Schulte and Dan Davison, and was originally named Org-babel.
13909 The following sections describe Org mode's code block handling facilities.
13912 * Structure of code blocks:: Code block syntax described
13913 * Editing source code:: Language major-mode editing
13914 * Exporting code blocks:: Export contents and/or results
13915 * Extracting source code:: Create pure source code files
13916 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
13917 * Library of Babel:: Use and contribute to a library of useful code blocks
13918 * Languages:: List of supported code block languages
13919 * Header arguments:: Configure code block functionality
13920 * Results of evaluation:: How evaluation results are handled
13921 * Noweb reference syntax:: Literate programming in Org mode
13922 * Key bindings and useful functions:: Work quickly with code blocks
13923 * Batch execution:: Call functions from the command line
13927 @node Structure of code blocks
13928 @section Structure of code blocks
13929 @cindex code block, structure
13930 @cindex source code, block structure
13932 @cindex #+BEGIN_SRC
13934 Live code blocks can be specified with a @samp{src} block or
13935 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
13936 @ref{Easy templates} system} The structure of a @samp{src} block is
13940 #+BEGIN_SRC <language> <switches> <header arguments>
13945 The @code{#+NAME:} line is optional, and can be used to name the code
13946 block. Live code blocks require that a language be specified on the
13947 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
13948 @cindex source code, inline
13950 Live code blocks can also be specified inline using
13953 src_<language>@{<body>@}
13959 src_<language>[<header arguments>]@{<body>@}
13963 @item <#+NAME: name>
13964 This line associates a name with the code block. This is similar to the
13965 @code{#+NAME: Name} lines that can be used to name tables in Org mode
13966 files. Referencing the name of a code block makes it possible to evaluate
13967 the block from other places in the file, from other files, or from Org mode
13968 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
13969 and the behavior of Org mode when two or more blocks share the same name is
13973 The language of the code in the block (see @ref{Languages}).
13974 @cindex source code, language
13976 Optional switches control code block export (see the discussion of switches in
13977 @ref{Literal examples})
13978 @cindex source code, switches
13979 @item <header arguments>
13980 Optional header arguments control many aspects of evaluation, export and
13981 tangling of code blocks (see @ref{Header arguments}).
13982 Header arguments can also be set on a per-buffer or per-subtree
13983 basis using properties.
13984 @item source code, header arguments
13986 Source code in the specified language.
13990 @node Editing source code
13991 @section Editing source code
13992 @cindex code block, editing
13993 @cindex source code, editing
13995 @vindex org-edit-src-auto-save-idle-delay
13996 @vindex org-edit-src-turn-on-auto-save
13998 Use @kbd{C-c '} to edit the current code block. This brings up a language
13999 major-mode edit buffer containing the body of the code block. Manually
14000 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14001 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14002 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14003 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14004 Use @kbd{C-c '} again to exit.
14006 The @code{org-src-mode} minor mode will be active in the edit buffer. The
14007 following variables can be used to configure the behavior of the edit
14008 buffer. See also the customization group @code{org-edit-structure} for
14009 further configuration options.
14012 @item org-src-lang-modes
14013 If an Emacs major-mode named @code{<lang>-mode} exists, where
14014 @code{<lang>} is the language named in the header line of the code block,
14015 then the edit buffer will be placed in that major-mode. This variable
14016 can be used to map arbitrary language names to existing major modes.
14017 @item org-src-window-setup
14018 Controls the way Emacs windows are rearranged when the edit buffer is created.
14019 @item org-src-preserve-indentation
14020 @cindex indentation, in source blocks
14021 By default, the value is @code{nil}, which means that when code blocks are
14022 evaluated during export or tangled, they are re-inserted into the code block,
14023 which may replace sequences of spaces with tab characters. When non-nil,
14024 whitespace in code blocks will be preserved during export or tangling,
14025 exactly as it appears. This variable is especially useful for tangling
14026 languages such as Python, in which whitespace indentation in the output is
14028 @item org-src-ask-before-returning-to-edit-buffer
14029 By default, Org will ask before returning to an open edit buffer. Set this
14030 variable to @code{nil} to switch without asking.
14033 To turn on native code fontification in the @emph{Org} buffer, configure the
14034 variable @code{org-src-fontify-natively}.
14037 @node Exporting code blocks
14038 @section Exporting code blocks
14039 @cindex code block, exporting
14040 @cindex source code, exporting
14042 It is possible to export the @emph{code} of code blocks, the @emph{results}
14043 of code block evaluation, @emph{both} the code and the results of code block
14044 evaluation, or @emph{none}. For most languages, the default exports code.
14045 However, for some languages (e.g., @code{ditaa}) the default exports the
14046 results of code block evaluation. For information on exporting code block
14047 bodies, see @ref{Literal examples}.
14049 The @code{:exports} header argument can be used to specify export
14050 behavior (note that these arguments are only relevant for code blocks, not
14053 @subsubheading Header arguments:
14056 @cindex @code{:exports}, src header argument
14057 @item :exports code
14058 The default in most languages. The body of the code block is exported, as
14059 described in @ref{Literal examples}.
14060 @item :exports results
14061 The code block will be evaluated each time to buffer is exported, and the
14062 results will be placed in the Org mode buffer for export, either updating
14063 previous results of the code block located anywhere in the buffer or, if no
14064 previous results exist, placing the results immediately after the code block.
14065 The body of the code block will not be exported.
14066 @item :exports both
14067 Both the code block and its results will be exported.
14068 @item :exports none
14069 Neither the code block nor its results will be exported.
14072 It is possible to inhibit the evaluation of code blocks during export.
14073 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14074 ensure that no code blocks are evaluated as part of the export process. This
14075 can be useful in situations where potentially untrusted Org mode files are
14076 exported in an automated fashion, for example when Org mode is used as the
14077 markup language for a wiki. It is also possible to set this variable to
14078 @code{inline-only}. In that case, only inline code blocks will be
14079 evaluated, in order to insert their results. Non-inline code blocks are
14080 assumed to have their results already inserted in the buffer by manual
14081 evaluation. This setting is useful to avoid expensive recalculations during
14082 export, not to provide security.
14084 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
14085 on export. However, code blocks in subtrees excluded from export
14086 (@pxref{Export settings}) may be evaluated on export.
14088 @node Extracting source code
14089 @section Extracting source code
14091 @cindex source code, extracting
14092 @cindex code block, extracting source code
14094 Creating pure source code files by extracting code from source blocks is
14095 referred to as ``tangling''---a term adopted from the literate programming
14096 community. During ``tangling'' of code blocks their bodies are expanded
14097 using @code{org-babel-expand-src-block} which can expand both variable and
14098 ``noweb'' style references (see @ref{Noweb reference syntax}).
14100 @subsubheading Header arguments
14103 @cindex @code{:tangle}, src header argument
14105 The default. The code block is not included in the tangled output.
14107 Include the code block in the tangled output. The output file name is the
14108 name of the org file with the extension @samp{.org} replaced by the extension
14109 for the block language.
14110 @item :tangle filename
14111 Include the code block in the tangled output to file @samp{filename}.
14115 @subsubheading Functions
14118 @item org-babel-tangle
14119 Tangle the current file. Bound to @kbd{C-c C-v t}.
14121 With prefix argument only tangle the current code block.
14122 @item org-babel-tangle-file
14123 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
14126 @subsubheading Hooks
14129 @item org-babel-post-tangle-hook
14130 This hook is run from within code files tangled by @code{org-babel-tangle}.
14131 Example applications could include post-processing, compilation or evaluation
14132 of tangled code files.
14135 @subsubheading Jumping between code and Org
14137 When tangling code from an Org-mode buffer to a source code file, you'll
14138 frequently find yourself viewing the file of tangled source code (e.g., many
14139 debuggers point to lines of the source code file). It is useful to be able
14140 to navigate from the tangled source to the Org-mode buffer from which the
14143 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
14144 code to Org-mode functionality. Two header arguments are required for
14145 jumping to work, first the @code{padline} (@ref{padline}) option must be set
14146 to true (the default setting), second the @code{comments} (@ref{comments})
14147 header argument must be set to @code{links}, which will insert comments into
14148 the source code buffer which point back to the original Org-mode file.
14150 @node Evaluating code blocks
14151 @section Evaluating code blocks
14152 @cindex code block, evaluating
14153 @cindex source code, evaluating
14156 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
14157 potential for that code to do harm. Org mode provides safeguards to ensure
14158 that code is only evaluated after explicit confirmation from the user. For
14159 information on these safeguards (and on how to disable them) see @ref{Code
14160 evaluation security}.} and the results of evaluation optionally placed in the
14161 Org mode buffer. The results of evaluation are placed following a line that
14162 begins by default with @code{#+RESULTS} and optionally a cache identifier
14163 and/or the name of the evaluated code block. The default value of
14164 @code{#+RESULTS} can be changed with the customizable variable
14165 @code{org-babel-results-keyword}.
14167 By default, the evaluation facility is only enabled for Lisp code blocks
14168 specified as @code{emacs-lisp}. However, source code blocks in many languages
14169 can be evaluated within Org mode (see @ref{Languages} for a list of supported
14170 languages and @ref{Structure of code blocks} for information on the syntax
14171 used to define a code block).
14174 There are a number of ways to evaluate code blocks. The simplest is to press
14175 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
14176 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
14177 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
14178 @code{org-babel-execute-src-block} function to evaluate the block and insert
14179 its results into the Org mode buffer.
14182 It is also possible to evaluate named code blocks from anywhere in an Org
14183 mode buffer or an Org mode table. These named code blocks can be located in
14184 the current Org mode buffer or in the ``Library of Babel'' (see @ref{Library
14185 of Babel}). Named code blocks can be evaluated with a separate
14186 @code{#+CALL:} line or inline within a block of text. In both cases
14187 the result is wrapped according to the value of
14188 @var{org-babel-inline-result-wrap}, which by default is @code{"=%s="} for
14189 markup that produces verbatim text.
14191 The syntax of the @code{#+CALL:} line is
14194 #+CALL: <name>(<arguments>)
14195 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
14198 The syntax for inline evaluation of named code blocks is
14201 ... call_<name>(<arguments>) ...
14202 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
14207 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
14209 Arguments specified in this section will be passed to the code block. These
14210 arguments use standard function call syntax, rather than
14211 header argument syntax. For example, a @code{#+CALL:} line that passes the
14212 number four to a code block named @code{double}, which declares the header
14213 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
14214 @item <inside header arguments>
14215 Inside header arguments are passed through and applied to the named code
14216 block. These arguments use header argument syntax rather than standard
14217 function call syntax. Inside header arguments affect how the code block is
14218 evaluated. For example, @code{[:results output]} will collect the results of
14219 everything printed to @code{STDOUT} during execution of the code block.
14220 @item <end header arguments>
14221 End header arguments are applied to the calling instance and do not affect
14222 evaluation of the named code block. They affect how the results are
14223 incorporated into the Org mode buffer and how the call line is exported. For
14224 example, @code{:results html} will insert the results of the call line
14225 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
14227 For more examples of passing header arguments to @code{#+CALL:} lines see
14228 @ref{Header arguments in function calls}.
14231 @node Library of Babel
14232 @section Library of Babel
14233 @cindex babel, library of
14234 @cindex source code, library
14235 @cindex code block, library
14237 The ``Library of Babel'' consists of code blocks that can be called from any
14238 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
14239 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
14240 code blocks} for information on the syntax of remote code block evaluation).
14243 The central repository of code blocks in the ``Library of Babel'' is housed
14244 in an Org mode file located in the @samp{contrib} directory of Org mode.
14246 Users can add code blocks they believe to be generally useful to their
14247 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
14248 then loaded into the library with @code{org-babel-lob-ingest}.
14252 Code blocks located in any Org mode file can be loaded into the ``Library of
14253 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
14258 @cindex babel, languages
14259 @cindex source code, languages
14260 @cindex code block, languages
14262 Code blocks in the following languages are supported.
14264 @multitable @columnfractions 0.28 0.3 0.22 0.2
14265 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
14266 @item Asymptote @tab asymptote @tab Awk @tab awk
14267 @item Emacs Calc @tab calc @tab C @tab C
14268 @item C++ @tab C++ @tab Clojure @tab clojure
14269 @item CSS @tab css @tab ditaa @tab ditaa
14270 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
14271 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
14272 @item Java @tab java @tab @tab
14273 @item Javascript @tab js @tab LaTeX @tab latex
14274 @item Ledger @tab ledger @tab Lisp @tab lisp
14275 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14276 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14277 @item Octave @tab octave @tab Org mode @tab org
14278 @item Oz @tab oz @tab Perl @tab perl
14279 @item Plantuml @tab plantuml @tab Python @tab python
14280 @item R @tab R @tab Ruby @tab ruby
14281 @item Sass @tab sass @tab Scheme @tab scheme
14282 @item GNU Screen @tab screen @tab shell @tab sh
14283 @item SQL @tab sql @tab SQLite @tab sqlite
14286 Language-specific documentation is available for some languages. If
14287 available, it can be found at
14288 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14290 The option @code{org-babel-load-languages} controls which languages are
14291 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
14292 variable can be set using the customization interface or by adding code like
14293 the following to your emacs configuration.
14296 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14297 @code{R} code blocks.
14301 (org-babel-do-load-languages
14302 'org-babel-load-languages
14303 '((emacs-lisp . nil)
14307 It is also possible to enable support for a language by loading the related
14308 elisp file with @code{require}.
14311 The following adds support for evaluating @code{clojure} code blocks.
14315 (require 'ob-clojure)
14318 @node Header arguments
14319 @section Header arguments
14320 @cindex code block, header arguments
14321 @cindex source code, block header arguments
14323 Code block functionality can be configured with header arguments. This
14324 section provides an overview of the use of header arguments, and then
14325 describes each header argument in detail.
14328 * Using header arguments:: Different ways to set header arguments
14329 * Specific header arguments:: List of header arguments
14332 @node Using header arguments
14333 @subsection Using header arguments
14335 The values of header arguments can be set in several way. When the header
14336 arguments in each layer have been determined, they are combined in order from
14337 the first, least specific (having the lowest priority) up to the last, most
14338 specific (having the highest priority). A header argument with a higher
14339 priority replaces the same header argument specified at lower priority.
14341 * System-wide header arguments:: Set global default values
14342 * Language-specific header arguments:: Set default values by language
14343 * Header arguments in Org mode properties:: Set default values for a buffer or heading
14344 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
14345 * Code block specific header arguments:: The most common way to set values
14346 * Header arguments in function calls:: The most specific level
14350 @node System-wide header arguments
14351 @subsubheading System-wide header arguments
14352 @vindex org-babel-default-header-args
14353 System-wide values of header arguments can be specified by adapting the
14354 @code{org-babel-default-header-args} variable:
14356 @cindex @code{:session}, src header argument
14357 @cindex @code{:results}, src header argument
14358 @cindex @code{:exports}, src header argument
14359 @cindex @code{:cache}, src header argument
14360 @cindex @code{:noweb}, src header argument
14363 :results => "replace"
14369 For example, the following example could be used to set the default value of
14370 @code{:noweb} header arguments to @code{yes}. This would have the effect of
14371 expanding @code{:noweb} references by default when evaluating source code
14375 (setq org-babel-default-header-args
14376 (cons '(:noweb . "yes")
14377 (assq-delete-all :noweb org-babel-default-header-args)))
14380 @node Language-specific header arguments
14381 @subsubheading Language-specific header arguments
14382 Each language can define its own set of default header arguments in variable
14383 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14384 of the language. See the language-specific documentation available online at
14385 @uref{http://orgmode.org/worg/org-contrib/babel}.
14387 @node Header arguments in Org mode properties
14388 @subsubheading Header arguments in Org mode properties
14390 Buffer-wide header arguments may be specified as properties through the use
14391 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14392 @ref{Property syntax}).
14394 For example the following would set @code{session} to @code{*R*} (only for R
14395 code blocks), and @code{results} to @code{silent} for every code block in the
14396 buffer, ensuring that all execution took place in the same session, and no
14397 results would be inserted into the buffer.
14400 #+PROPERTY: header-args:R :session *R*
14401 #+PROPERTY: header-args :results silent
14404 Header arguments read from Org mode properties can also be set on a
14405 per-subtree basis using property drawers (see @ref{Property syntax}).
14406 @vindex org-use-property-inheritance
14407 When properties are used to set default header arguments, they are always
14408 looked up with inheritance, regardless of the value of
14409 @code{org-use-property-inheritance}. Properties are evaluated as seen by the
14410 outermost call or source block.@footnote{The deprecated syntax for default
14411 header argument properties, using the name of the header argument as a
14412 property name directly, evaluates the property as seen by the corresponding
14413 source block definition. This behavior has been kept for backwards
14416 In the following example the value of
14417 the @code{:cache} header argument will default to @code{yes} in all code
14418 blocks in the subtree rooted at the following heading:
14423 :header-args: :cache yes
14428 @vindex org-babel-default-header-args
14429 Properties defined in this way override the properties set in
14430 @code{org-babel-default-header-args} and are applied for all activated
14431 languages. It is convenient to use the @code{org-set-property} function
14432 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14434 @node Language-specific header arguments in Org mode properties
14435 @subsubheading Language-specific header arguments in Org mode properties
14437 Language-specific header arguments are also read from properties
14438 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14439 targeted. As an example
14444 :header-args:clojure: :session *clojure-1*
14445 :header-args:R: :session *R*
14449 :header-args:clojure: :session *clojure-2*
14453 would independently set a default session header argument for R and clojure
14454 for calls and source blocks under subtree ``Heading'' and change to a
14455 different clojure setting for evaluations under subtree ``Subheading'', while
14456 the R session is inherited from ``Heading'' and therefore unchanged.
14458 @node Code block specific header arguments
14459 @subsubheading Code block specific header arguments
14461 The most common way to assign values to header arguments is at the
14462 code block level. This can be done by listing a sequence of header
14463 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14464 Properties set in this way override both the values of
14465 @code{org-babel-default-header-args} and header arguments specified as
14466 properties. In the following example, the @code{:results} header argument
14467 is set to @code{silent}, meaning the results of execution will not be
14468 inserted in the buffer, and the @code{:exports} header argument is set to
14469 @code{code}, meaning only the body of the code block will be
14470 preserved on export to HTML or @LaTeX{}.
14474 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14476 fac n = n * fac (n-1)
14479 Similarly, it is possible to set header arguments for inline code blocks
14482 src_haskell[:exports both]@{fac 5@}
14485 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14486 @code{#+HEADERS:} lines preceding a code block or nested between the
14487 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14491 Multi-line header arguments on an un-named code block:
14494 #+HEADERS: :var data1=1
14495 #+BEGIN_SRC emacs-lisp :var data2=2
14496 (message "data1:%S, data2:%S" data1 data2)
14503 Multi-line header arguments on a named code block:
14506 #+NAME: named-block
14507 #+HEADER: :var data=2
14508 #+BEGIN_SRC emacs-lisp
14509 (message "data:%S" data)
14512 #+RESULTS: named-block
14516 @node Header arguments in function calls
14517 @subsubheading Header arguments in function calls
14519 At the most specific level, header arguments for ``Library of Babel'' or
14520 @code{#+CALL:} lines can be set as shown in the two examples below. For more
14521 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14524 The following will apply the @code{:exports results} header argument to the
14525 evaluation of the @code{#+CALL:} line.
14528 #+CALL: factorial(n=5) :exports results
14531 The following will apply the @code{:session special} header argument to the
14532 evaluation of the @code{factorial} code block.
14535 #+CALL: factorial[:session special](n=5)
14538 @node Specific header arguments
14539 @subsection Specific header arguments
14540 Header arguments consist of an initial colon followed by the name of the
14541 argument in lowercase letters. The following header arguments are defined:
14544 * var:: Pass arguments to code blocks
14545 * Results:: Specify the type of results and how they will
14546 be collected and handled
14547 * file:: Specify a path for file output
14548 * file-desc:: Specify a description for file results
14549 * file-ext:: Specify an extension for file output
14550 * output-dir:: Specify a directory to write file output to
14551 * dir:: Specify the default (possibly remote)
14552 directory for code block execution
14553 * exports:: Export code and/or results
14554 * tangle:: Toggle tangling and specify file name
14555 * mkdirp:: Toggle creation of parent directories of target
14556 files during tangling
14557 * comments:: Toggle insertion of comments in tangled
14559 * padline:: Control insertion of padding lines in tangled
14561 * no-expand:: Turn off variable assignment and noweb
14562 expansion during tangling
14563 * session:: Preserve the state of code evaluation
14564 * noweb:: Toggle expansion of noweb references
14565 * noweb-ref:: Specify block's noweb reference resolution target
14566 * noweb-sep:: String used to separate noweb references
14567 * cache:: Avoid re-evaluating unchanged code blocks
14568 * sep:: Delimiter for writing tabular results outside Org
14569 * hlines:: Handle horizontal lines in tables
14570 * colnames:: Handle column names in tables
14571 * rownames:: Handle row names in tables
14572 * shebang:: Make tangled files executable
14573 * tangle-mode:: Set permission of tangled files
14574 * eval:: Limit evaluation of specific code blocks
14575 * wrap:: Mark source block evaluation results
14576 * post:: Post processing of code block results
14577 * prologue:: Text to prepend to code block body
14578 * epilogue:: Text to append to code block body
14581 Additional header arguments are defined on a language-specific basis, see
14585 @subsubsection @code{:var}
14586 @cindex @code{:var}, src header argument
14587 The @code{:var} header argument is used to pass arguments to code blocks.
14588 The specifics of how arguments are included in a code block vary by language;
14589 these are addressed in the language-specific documentation. However, the
14590 syntax used to specify arguments is the same across all languages. In every
14591 case, variables require a default value when they are declared.
14593 The values passed to arguments can either be literal values, references, or
14594 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
14595 References include anything in the Org mode file that takes a @code{#+NAME:}
14596 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
14597 other code blocks and the results of other code blocks.
14599 Note: When a reference is made to another code block, the referenced block
14600 will be evaluated unless it has current cached results (see @ref{cache}).
14602 Argument values can be indexed in a manner similar to arrays (see @ref{var,
14603 Indexable variable values}).
14605 The following syntax is used to pass arguments to code blocks using the
14606 @code{:var} header argument.
14612 The argument, @code{assign}, can either be a literal value, such as a string
14613 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
14614 literal example, another code block (with or without arguments), or the
14615 results of evaluating another code block.
14617 Here are examples of passing values by reference:
14622 an Org mode table named with either a @code{#+NAME:} line
14625 #+NAME: example-table
14631 #+NAME: table-length
14632 #+BEGIN_SRC emacs-lisp :var table=example-table
14636 #+RESULTS: table-length
14641 a simple list named with a @code{#+NAME:} line (note that nesting is not
14642 carried through to the source code block)
14645 #+NAME: example-list
14651 #+BEGIN_SRC emacs-lisp :var x=example-list
14659 @item code block without arguments
14660 a code block name (from the example above), as assigned by @code{#+NAME:},
14661 optionally followed by parentheses
14664 #+BEGIN_SRC emacs-lisp :var length=table-length()
14672 @item code block with arguments
14673 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
14674 optional arguments passed within the parentheses following the
14675 code block name using standard function call syntax
14679 #+BEGIN_SRC emacs-lisp :var input=8
14687 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
14695 @item literal example
14696 a literal example block named with a @code{#+NAME:} line
14699 #+NAME: literal-example
14705 #+NAME: read-literal-example
14706 #+BEGIN_SRC emacs-lisp :var x=literal-example
14707 (concatenate 'string x " for you.")
14710 #+RESULTS: read-literal-example
14711 : A literal example
14712 : on two lines for you.
14718 @subsubheading Indexable variable values
14719 It is possible to reference portions of variable values by ``indexing'' into
14720 the variables. Indexes are 0 based with negative values counting back from
14721 the end. If an index is separated by @code{,}s then each subsequent section
14722 will index into the next deepest nesting or dimension of the value. Note
14723 that this indexing occurs @emph{before} other table related header arguments
14724 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
14725 following example assigns the last cell of the first row the table
14726 @code{example-table} to the variable @code{data}:
14729 #+NAME: example-table
14735 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
14743 Ranges of variable values can be referenced using two integers separated by a
14744 @code{:}, in which case the entire inclusive range is referenced. For
14745 example the following assigns the middle three rows of @code{example-table}
14749 #+NAME: example-table
14756 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
14766 Additionally, an empty index, or the single character @code{*}, are both
14767 interpreted to mean the entire range and as such are equivalent to
14768 @code{0:-1}, as shown in the following example in which the entire first
14769 column is referenced.
14772 #+NAME: example-table
14778 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
14786 It is possible to index into the results of code blocks as well as tables.
14787 Any number of dimensions can be indexed. Dimensions are separated from one
14788 another by commas, as shown in the following example.
14792 #+BEGIN_SRC emacs-lisp
14793 '(((1 2 3) (4 5 6) (7 8 9))
14794 ((10 11 12) (13 14 15) (16 17 18))
14795 ((19 20 21) (22 23 24) (25 26 27)))
14798 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
14806 @subsubheading Emacs Lisp evaluation of variables
14808 Emacs lisp code can be used to initialize variable values. When a variable
14809 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
14810 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
14811 the variable value. The following example demonstrates use of this
14812 evaluation to reliably pass the file-name of the Org mode buffer to a code
14813 block---note that evaluation of header arguments is guaranteed to take place
14814 in the original Org mode file, while there is no such guarantee for
14815 evaluation of the code block body.
14818 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
14823 Note that values read from tables and lists will not be evaluated as
14824 Emacs Lisp, as shown in the following example.
14830 #+HEADERS: :var data=table[0,0]
14840 @subsubsection @code{:results}
14841 @cindex @code{:results}, src header argument
14843 There are four classes of @code{:results} header argument. Only one option
14844 per class may be supplied per code block.
14848 @b{collection} header arguments specify how the results should be collected
14849 from the code block
14851 @b{type} header arguments specify what type of result the code block will
14852 return---which has implications for how they will be processed before
14853 insertion into the Org mode buffer
14855 @b{format} header arguments specify what type of result the code block will
14856 return---which has implications for how they will be inserted into the
14859 @b{handling} header arguments specify how the results of evaluating the code
14860 block should be handled.
14863 @subsubheading Collection
14864 The following options are mutually exclusive, and specify how the results
14865 should be collected from the code block.
14869 This is the default. The result is the value of the last statement in the
14870 code block. This header argument places the evaluation in functional
14871 mode. Note that in some languages, e.g., Python, use of this result type
14872 requires that a @code{return} statement be included in the body of the source
14873 code block. E.g., @code{:results value}.
14874 @item @code{output}
14875 The result is the collection of everything printed to STDOUT during the
14876 execution of the code block. This header argument places the
14877 evaluation in scripting mode. E.g., @code{:results output}.
14880 @subsubheading Type
14882 The following options are mutually exclusive and specify what type of results
14883 the code block will return. By default, results are inserted as either a
14884 table or scalar depending on their value.
14887 @item @code{table}, @code{vector}
14888 The results should be interpreted as an Org mode table. If a single value is
14889 returned, it will be converted into a table with one row and one column.
14890 E.g., @code{:results value table}.
14892 The results should be interpreted as an Org mode list. If a single scalar
14893 value is returned it will be converted into a list with only one element.
14894 @item @code{scalar}, @code{verbatim}
14895 The results should be interpreted literally---they will not be
14896 converted into a table. The results will be inserted into the Org mode
14897 buffer as quoted text. E.g., @code{:results value verbatim}.
14899 The results will be interpreted as the path to a file, and will be inserted
14900 into the Org mode buffer as a file link. E.g., @code{:results value file}.
14903 @subsubheading Format
14905 The following options are mutually exclusive and specify what type of results
14906 the code block will return. By default, results are inserted according to the
14907 type as specified above.
14911 The results are interpreted as raw Org mode code and are inserted directly
14912 into the buffer. If the results look like a table they will be aligned as
14913 such by Org mode. E.g., @code{:results value raw}.
14915 The results are will be enclosed in a @code{BEGIN_SRC org} block.
14916 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
14917 in the block and/or if you export the file. E.g., @code{:results value org}.
14919 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
14920 block. E.g., @code{:results value html}.
14922 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
14923 E.g., @code{:results value latex}.
14925 Result are assumed to be parsable code and are enclosed in a code block.
14926 E.g., @code{:results value code}.
14928 The result is converted to pretty-printed code and is enclosed in a code
14929 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
14930 @code{:results value pp}.
14931 @item @code{drawer}
14932 The result is wrapped in a RESULTS drawer. This can be useful for
14933 inserting @code{raw} or @code{org} syntax results in such a way that their
14934 extent is known and they can be automatically removed or replaced.
14937 @subsubheading Handling
14938 The following results options indicate what happens with the
14939 results once they are collected.
14942 @item @code{silent}
14943 The results will be echoed in the minibuffer but will not be inserted into
14944 the Org mode buffer. E.g., @code{:results output silent}.
14945 @item @code{replace}
14946 The default value. Any existing results will be removed, and the new results
14947 will be inserted into the Org mode buffer in their place. E.g.,
14948 @code{:results output replace}.
14949 @item @code{append}
14950 If there are pre-existing results of the code block then the new results will
14951 be appended to the existing results. Otherwise the new results will be
14952 inserted as with @code{replace}.
14953 @item @code{prepend}
14954 If there are pre-existing results of the code block then the new results will
14955 be prepended to the existing results. Otherwise the new results will be
14956 inserted as with @code{replace}.
14960 @subsubsection @code{:file}
14961 @cindex @code{:file}, src header argument
14963 The header argument @code{:file} is used to specify an external file in which
14964 to save code block results. After code block evaluation an Org mode style
14965 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
14966 into the Org mode buffer. Some languages including R, gnuplot, dot, and
14967 ditaa provide special handling of the @code{:file} header argument
14968 automatically wrapping the code block body in the boilerplate code required
14969 to save output to the specified file. This is often useful for saving
14970 graphical output of a code block to the specified file.
14972 The argument to @code{:file} should be either a string specifying the path to
14973 a file, or a list of two strings in which case the first element of the list
14974 should be the path to a file and the second a description for the link.
14977 @subsubsection @code{:file-desc}
14979 The value of the @code{:file-desc} header argument is used to provide a
14980 description for file code block results which are inserted as Org mode links
14981 (see @ref{Link format}). If the @code{:file-desc} header argument is given
14982 with no value the link path will be placed in both the ``link'' and the
14983 ``description'' portion of the Org mode link.
14986 @subsubsection @code{:file-ext}
14987 @cindex @code{:file-ext}, src header argument
14989 The value of the @code{:file-ext} header argument is used to provide an
14990 extension to write the file output to. It is combined with the
14991 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
14992 header argument to generate a complete file name.
14994 This header arg will be overridden by @code{:file}, and thus has no effect
14995 when the latter is specified.
14998 @subsubsection @code{:output-dir}
14999 @cindex @code{:output-dir}, src header argument
15001 The value of the @code{:output-dir} header argument is used to provide a
15002 directory to write the file output to. It may specify an absolute directory
15003 (beginning with @code{/}) or a relative directory (without @code{/}). It can
15004 be combined with the @code{#+NAME:} of the source block and the value of the
15005 @ref{file-ext} header argument to generate a complete file name, or used
15006 along with a @ref{file} header arg.
15009 @subsubsection @code{:dir} and remote execution
15010 @cindex @code{:dir}, src header argument
15012 While the @code{:file} header argument can be used to specify the path to the
15013 output file, @code{:dir} specifies the default directory during code block
15014 execution. If it is absent, then the directory associated with the current
15015 buffer is used. In other words, supplying @code{:dir path} temporarily has
15016 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15017 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
15018 the value of the Emacs variable @code{default-directory}.
15020 When using @code{:dir}, you should supply a relative path for file output
15021 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15022 case that path will be interpreted relative to the default directory.
15024 In other words, if you want your plot to go into a folder called @file{Work}
15025 in your home directory, you could use
15028 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15029 matplot(matrix(rnorm(100), 10), type="l")
15033 @subsubheading Remote execution
15034 A directory on a remote machine can be specified using tramp file syntax, in
15035 which case the code will be evaluated on the remote machine. An example is
15038 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15039 plot(1:10, main=system("hostname", intern=TRUE))
15043 Text results will be returned to the local Org mode buffer as usual, and file
15044 output will be created on the remote machine with relative paths interpreted
15045 relative to the remote directory. An Org mode link to the remote file will be
15048 So, in the above example a plot will be created on the remote machine,
15049 and a link of the following form will be inserted in the org buffer:
15052 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15055 Most of this functionality follows immediately from the fact that @code{:dir}
15056 sets the value of the Emacs variable @code{default-directory}, thanks to
15057 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
15058 install tramp separately in order for these features to work correctly.
15060 @subsubheading Further points
15064 If @code{:dir} is used in conjunction with @code{:session}, although it will
15065 determine the starting directory for a new session as expected, no attempt is
15066 currently made to alter the directory associated with an existing session.
15068 @code{:dir} should typically not be used to create files during export with
15069 @code{:exports results} or @code{:exports both}. The reason is that, in order
15070 to retain portability of exported material between machines, during export
15071 links inserted into the buffer will @emph{not} be expanded against @code{default
15072 directory}. Therefore, if @code{default-directory} is altered using
15073 @code{:dir}, it is probable that the file will be created in a location to
15074 which the link does not point.
15078 @subsubsection @code{:exports}
15079 @cindex @code{:exports}, src header argument
15081 The @code{:exports} header argument specifies what should be included in HTML
15082 or @LaTeX{} exports of the Org mode file. Note that the @code{:exports}
15083 option is only relevant for code blocks, not inline code.
15087 The default. The body of code is included into the exported file. E.g.,
15088 @code{:exports code}.
15089 @item @code{results}
15090 The result of evaluating the code is included in the exported file. E.g.,
15091 @code{:exports results}.
15093 Both the code and results are included in the exported file. E.g.,
15094 @code{:exports both}.
15096 Nothing is included in the exported file. E.g., @code{:exports none}.
15100 @subsubsection @code{:tangle}
15101 @cindex @code{:tangle}, src header argument
15103 The @code{:tangle} header argument specifies whether or not the code
15104 block should be included in tangled extraction of source code files.
15107 @item @code{tangle}
15108 The code block is exported to a source code file named after the full path
15109 (including the directory) and file name (w/o extension) of the Org mode file.
15110 E.g., @code{:tangle yes}.
15112 The default. The code block is not exported to a source code file.
15113 E.g., @code{:tangle no}.
15115 Any other string passed to the @code{:tangle} header argument is interpreted
15116 as a path (directory and file name relative to the directory of the Org mode
15117 file) to which the block will be exported. E.g., @code{:tangle path}.
15121 @subsubsection @code{:mkdirp}
15122 @cindex @code{:mkdirp}, src header argument
15124 The @code{:mkdirp} header argument can be used to create parent directories
15125 of tangled files when missing. This can be set to @code{yes} to enable
15126 directory creation or to @code{no} to inhibit directory creation.
15129 @subsubsection @code{:comments}
15130 @cindex @code{:comments}, src header argument
15131 By default code blocks are tangled to source-code files without any insertion
15132 of comments beyond those which may already exist in the body of the code
15133 block. The @code{:comments} header argument can be set as follows to control
15134 the insertion of extra comments into the tangled code file.
15138 The default. No extra comments are inserted during tangling.
15140 The code block is wrapped in comments which contain pointers back to the
15141 original Org file from which the code was tangled.
15143 A synonym for ``link'' to maintain backwards compatibility.
15145 Include text from the Org mode file as a comment.
15146 The text is picked from the leading context of the tangled code and is
15147 limited by the nearest headline or source block as the case may be.
15149 Turns on both the ``link'' and ``org'' comment options.
15151 Turns on the ``link'' comment option, and additionally wraps expanded noweb
15152 references in the code block body in link comments.
15156 @subsubsection @code{:padline}
15157 @cindex @code{:padline}, src header argument
15158 Control in insertion of padding lines around code block bodies in tangled
15159 code files. The default value is @code{yes} which results in insertion of
15160 newlines before and after each tangled code block. The following arguments
15165 Insert newlines before and after each code block body in tangled code files.
15167 Do not insert any newline padding in tangled output.
15171 @subsubsection @code{:no-expand}
15172 @cindex @code{:no-expand}, src header argument
15174 By default, code blocks are expanded with @code{org-babel-expand-src-block}
15175 during tangling. This has the effect of assigning values to variables
15176 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
15177 references (see @ref{Noweb reference syntax}) with their targets. The
15178 @code{:no-expand} header argument can be used to turn off this behavior.
15179 Note: The @code{:no-expand} header argument has no impact on export,
15180 i.e. code blocks will irrespective of this header argument expanded for
15184 @subsubsection @code{:session}
15185 @cindex @code{:session}, src header argument
15187 The @code{:session} header argument starts a session for an interpreted
15188 language where state is preserved.
15190 By default, a session is not started.
15192 A string passed to the @code{:session} header argument will give the session
15193 a name. This makes it possible to run concurrent sessions for each
15194 interpreted language.
15197 @subsubsection @code{:noweb}
15198 @cindex @code{:noweb}, src header argument
15200 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
15201 references (see @ref{Noweb reference syntax}) when the code block is
15202 evaluated, tangled, or exported. The @code{:noweb} header argument can have
15203 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
15204 @code{no-export} @code{strip-export}.
15208 The default. ``Noweb'' syntax references in the body of the code block will
15209 not be expanded before the code block is evaluated, tangled or exported.
15211 ``Noweb'' syntax references in the body of the code block will be
15212 expanded before the code block is evaluated, tangled or exported.
15213 @item @code{tangle}
15214 ``Noweb'' syntax references in the body of the code block will be expanded
15215 before the code block is tangled. However, ``noweb'' syntax references will
15216 not be expanded when the code block is evaluated or exported.
15217 @item @code{no-export}
15218 ``Noweb'' syntax references in the body of the code block will be expanded
15219 before the block is evaluated or tangled. However, ``noweb'' syntax
15220 references will not be expanded when the code block is exported.
15221 @item @code{strip-export}
15222 ``Noweb'' syntax references in the body of the code block will be expanded
15223 before the block is evaluated or tangled. However, ``noweb'' syntax
15224 references will be removed when the code block is exported.
15226 ``Noweb'' syntax references in the body of the code block will only be
15227 expanded before the block is evaluated.
15230 @subsubheading Noweb prefix lines
15231 Noweb insertions are now placed behind the line prefix of the
15232 @code{<<reference>>}.
15233 This behavior is illustrated in the following example. Because the
15234 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
15235 each line of the expanded noweb reference will be commented.
15247 -- multi-line body of example
15250 Note that noweb replacement text that does not contain any newlines will not
15251 be affected by this change, so it is still possible to use inline noweb
15255 @subsubsection @code{:noweb-ref}
15256 @cindex @code{:noweb-ref}, src header argument
15257 When expanding ``noweb'' style references, the bodies of all code block with
15258 @emph{either} a block name matching the reference name @emph{or} a
15259 @code{:noweb-ref} header argument matching the reference name will be
15260 concatenated together to form the replacement text.
15262 By setting this header argument at the subtree or file level, simple code
15263 block concatenation may be achieved. For example, when tangling the
15264 following Org mode file, the bodies of code blocks will be concatenated into
15265 the resulting pure code file@footnote{(The example needs property inheritance
15266 to be turned on for the @code{noweb-ref} property, see @ref{Property
15270 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
15273 * the mount point of the fullest disk
15275 :noweb-ref: fullest-disk
15278 ** query all mounted disks
15283 ** strip the header row
15288 ** sort by the percent full
15290 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
15293 ** extract the mount point
15295 |awk '@{print $2@}'
15299 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15300 used to separate accumulate noweb references like those above. By default a
15304 @subsubsection @code{:noweb-sep}
15305 @cindex @code{:noweb-sep}, src header argument
15307 The @code{:noweb-sep} header argument holds the string used to separate
15308 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
15312 @subsubsection @code{:cache}
15313 @cindex @code{:cache}, src header argument
15315 The @code{:cache} header argument controls the use of in-buffer caching of
15316 the results of evaluating code blocks. It can be used to avoid re-evaluating
15317 unchanged code blocks. Note that the @code{:cache} header argument will not
15318 attempt to cache results when the @code{:session} header argument is used,
15319 because the results of the code block execution may be stored in the session
15320 outside of the Org mode buffer. The @code{:cache} header argument can have
15321 one of two values: @code{yes} or @code{no}.
15325 The default. No caching takes place, and the code block will be evaluated
15326 every time it is called.
15328 Every time the code block is run a SHA1 hash of the code and arguments
15329 passed to the block will be generated. This hash is packed into the
15330 @code{#+RESULTS:} line and will be checked on subsequent
15331 executions of the code block. If the code block has not
15332 changed since the last time it was evaluated, it will not be re-evaluated.
15335 Code block caches notice if the value of a variable argument
15336 to the code block has changed. If this is the case, the cache is
15337 invalidated and the code block is re-run. In the following example,
15338 @code{caller} will not be re-run unless the results of @code{random} have
15339 changed since it was last run.
15343 #+BEGIN_SRC R :cache yes
15347 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15351 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15355 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15360 @subsubsection @code{:sep}
15361 @cindex @code{:sep}, src header argument
15363 The @code{:sep} header argument can be used to control the delimiter used
15364 when writing tabular results out to files external to Org mode. This is used
15365 either when opening tabular results of a code block by calling the
15366 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15367 or when writing code block results to an external file (see @ref{file})
15370 By default, when @code{:sep} is not specified output tables are tab
15374 @subsubsection @code{:hlines}
15375 @cindex @code{:hlines}, src header argument
15377 Tables are frequently represented with one or more horizontal lines, or
15378 hlines. The @code{:hlines} argument to a code block accepts the
15379 values @code{yes} or @code{no}, with a default value of @code{no}.
15383 Strips horizontal lines from the input table. In most languages this is the
15384 desired effect because an @code{hline} symbol is interpreted as an unbound
15385 variable and raises an error. Setting @code{:hlines no} or relying on the
15386 default value yields the following results.
15397 #+BEGIN_SRC python :var tab=many-cols
15401 #+RESULTS: echo-table
15408 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
15419 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15423 #+RESULTS: echo-table
15433 @subsubsection @code{:colnames}
15434 @cindex @code{:colnames}, src header argument
15436 The @code{:colnames} header argument accepts the values @code{yes},
15437 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
15438 Note that the behavior of the @code{:colnames} header argument may differ
15443 If an input table looks like it has column names
15444 (because its second row is an hline), then the column
15445 names will be removed from the table before
15446 processing, then reapplied to the results.
15455 #+NAME: echo-table-again
15456 #+BEGIN_SRC python :var tab=less-cols
15457 return [[val + '*' for val in row] for row in tab]
15460 #+RESULTS: echo-table-again
15467 Please note that column names are not removed before the table is indexed
15468 using variable indexing @xref{var, Indexable variable values}.
15471 No column name pre-processing takes place
15474 Column names are removed and reapplied as with @code{nil} even if the table
15475 does not ``look like'' it has column names (i.e., the second row is not an
15480 @subsubsection @code{:rownames}
15481 @cindex @code{:rownames}, src header argument
15483 The @code{:rownames} header argument can take on the values @code{yes} or
15484 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
15485 blocks ignore the @code{:rownames} header argument entirely given the ease
15486 with which tables with row names may be handled directly in Emacs Lisp.
15490 No row name pre-processing will take place.
15493 The first column of the table is removed from the table before processing,
15494 and is then reapplied to the results.
15497 #+NAME: with-rownames
15498 | one | 1 | 2 | 3 | 4 | 5 |
15499 | two | 6 | 7 | 8 | 9 | 10 |
15501 #+NAME: echo-table-once-again
15502 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15503 return [[val + 10 for val in row] for row in tab]
15506 #+RESULTS: echo-table-once-again
15507 | one | 11 | 12 | 13 | 14 | 15 |
15508 | two | 16 | 17 | 18 | 19 | 20 |
15511 Please note that row names are not removed before the table is indexed using
15512 variable indexing @xref{var, Indexable variable values}.
15517 @subsubsection @code{:shebang}
15518 @cindex @code{:shebang}, src header argument
15520 Setting the @code{:shebang} header argument to a string value
15521 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15522 first line of any tangled file holding the code block, and the file
15523 permissions of the tangled file are set to make it executable.
15527 @subsubsection @code{:tangle-mode}
15528 @cindex @code{:tangle-mode}, src header argument
15530 The @code{tangle-mode} header argument controls the permission set on tangled
15531 files. The value of this header argument will be passed to
15532 @code{set-file-modes}. For example, to set a tangled file as read only use
15533 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15534 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
15535 (@ref{shebang}) header arguments will automatically be made executable unless
15536 the @code{tangle-mode} header argument is also used. The behavior is
15537 undefined if multiple code blocks with different values for the
15538 @code{tangle-mode} header argument are tangled to the same file.
15541 @subsubsection @code{:eval}
15542 @cindex @code{:eval}, src header argument
15543 The @code{:eval} header argument can be used to limit the evaluation of
15544 specific code blocks. The @code{:eval} header argument can be useful for
15545 protecting against the evaluation of dangerous code blocks or to ensure that
15546 evaluation will require a query regardless of the value of the
15547 @code{org-confirm-babel-evaluate} variable. The possible values of
15548 @code{:eval} and their effects are shown below.
15552 The code block will not be evaluated under any circumstances.
15554 Evaluation of the code block will require a query.
15555 @item never-export or no-export
15556 The code block will not be evaluated during export but may still be called
15559 Evaluation of the code block during export will require a query.
15562 If this header argument is not set then evaluation is determined by the value
15563 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15567 @subsubsection @code{:wrap}
15568 @cindex @code{:wrap}, src header argument
15569 The @code{:wrap} header argument is used to mark the results of source block
15570 evaluation. The header argument can be passed a string that will be appended
15571 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15572 results. If not string is specified then the results will be wrapped in a
15573 @code{#+BEGIN/END_RESULTS} block.
15576 @subsubsection @code{:post}
15577 @cindex @code{:post}, src header argument
15578 The @code{:post} header argument is used to post-process the results of a
15579 code block execution. When a post argument is given, the results of the code
15580 block will temporarily be bound to the @code{*this*} variable. This variable
15581 may then be included in header argument forms such as those used in @ref{var}
15582 header argument specifications allowing passing of results to other code
15583 blocks, or direct execution via Emacs Lisp.
15585 The following example illustrates the usage of the @code{:post} header
15590 #+begin_src sh :var data="" :var width="\\textwidth" :results output
15591 echo "#+ATTR_LATEX :width $width"
15595 #+header: :file /tmp/it.png
15596 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
15606 #+ATTR_LATEX :width 5cm
15607 [[file:/tmp/it.png]]
15612 @subsubsection @code{:prologue}
15613 @cindex @code{:prologue}, src header argument
15614 The value of the @code{prologue} header argument will be prepended to the
15615 code block body before execution. For example, @code{:prologue "reset"} may
15616 be used to reset a gnuplot session before execution of a particular code
15617 block, or the following configuration may be used to do this for all gnuplot
15618 code blocks. Also see @ref{epilogue}.
15621 (add-to-list 'org-babel-default-header-args:gnuplot
15622 '((:prologue . "reset")))
15626 @subsubsection @code{:epilogue}
15627 @cindex @code{:epilogue}, src header argument
15628 The value of the @code{epilogue} header argument will be appended to the code
15629 block body before execution. Also see @ref{prologue}.
15631 @node Results of evaluation
15632 @section Results of evaluation
15633 @cindex code block, results of evaluation
15634 @cindex source code, results of evaluation
15636 The way in which results are handled depends on whether a session is invoked,
15637 as well as on whether @code{:results value} or @code{:results output} is
15638 used. The following table shows the table possibilities. For a full listing
15639 of the possible results header arguments see @ref{Results}.
15641 @multitable @columnfractions 0.26 0.33 0.41
15642 @item @tab @b{Non-session} @tab @b{Session}
15643 @item @code{:results value} @tab value of last expression @tab value of last expression
15644 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
15647 Note: With @code{:results value}, the result in both @code{:session} and
15648 non-session is returned to Org mode as a table (a one- or two-dimensional
15649 vector of strings or numbers) when appropriate.
15651 @subsection Non-session
15652 @subsubsection @code{:results value}
15653 @cindex @code{:results}, src header argument
15654 This is the default. Internally, the value is obtained by wrapping the code
15655 in a function definition in the external language, and evaluating that
15656 function. Therefore, code should be written as if it were the body of such a
15657 function. In particular, note that Python does not automatically return a
15658 value from a function unless a @code{return} statement is present, and so a
15659 @samp{return} statement will usually be required in Python.
15661 This is the only one of the four evaluation contexts in which the code is
15662 automatically wrapped in a function definition.
15664 @subsubsection @code{:results output}
15665 @cindex @code{:results}, src header argument
15666 The code is passed to the interpreter as an external process, and the
15667 contents of the standard output stream are returned as text. (In certain
15668 languages this also contains the error output stream; this is an area for
15671 @subsection Session
15672 @subsubsection @code{:results value}
15673 @cindex @code{:results}, src header argument
15674 The code is passed to an interpreter running as an interactive Emacs inferior
15675 process. Only languages which provide tools for interactive evaluation of
15676 code have session support, so some language (e.g., C and ditaa) do not
15677 support the @code{:session} header argument, and in other languages (e.g.,
15678 Python and Haskell) which have limitations on the code which may be entered
15679 into interactive sessions, those limitations apply to the code in code blocks
15680 using the @code{:session} header argument as well.
15682 Unless the @code{:results output} option is supplied (see below) the result
15683 returned is the result of the last evaluation performed by the
15684 interpreter. (This is obtained in a language-specific manner: the value of
15685 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
15688 @subsubsection @code{:results output}
15689 @cindex @code{:results}, src header argument
15690 The code is passed to the interpreter running as an interactive Emacs
15691 inferior process. The result returned is the concatenation of the sequence of
15692 (text) output from the interactive interpreter. Notice that this is not
15693 necessarily the same as what would be sent to @code{STDOUT} if the same code
15694 were passed to a non-interactive interpreter running as an external
15695 process. For example, compare the following two blocks:
15698 #+BEGIN_SRC python :results output
15709 In non-session mode, the `2' is not printed and does not appear.
15712 #+BEGIN_SRC python :results output :session
15724 But in @code{:session} mode, the interactive interpreter receives input `2'
15725 and prints out its value, `2'. (Indeed, the other print statements are
15728 @node Noweb reference syntax
15729 @section Noweb reference syntax
15730 @cindex code block, noweb reference
15731 @cindex syntax, noweb
15732 @cindex source code, noweb reference
15734 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
15735 Programming system allows named blocks of code to be referenced by using the
15736 familiar Noweb syntax:
15739 <<code-block-name>>
15742 When a code block is tangled or evaluated, whether or not ``noweb''
15743 references are expanded depends upon the value of the @code{:noweb} header
15744 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
15745 evaluation. If @code{:noweb no}, the default, then the reference is not
15746 expanded before evaluation. See the @ref{noweb-ref} header argument for
15747 a more flexible way to resolve noweb references.
15749 It is possible to include the @emph{results} of a code block rather than the
15750 body. This is done by appending parenthesis to the code block name which may
15751 optionally contain arguments to the code block as shown below.
15754 <<code-block-name(optional arguments)>>
15757 Note: the default value, @code{:noweb no}, was chosen to ensure that
15758 correct code is not broken in a language, such as Ruby, where
15759 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
15760 syntactically valid in languages that you use, then please consider setting
15763 Note: if noweb tangling is slow in large Org mode files consider setting the
15764 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
15765 This will result in faster noweb reference resolution at the expense of not
15766 correctly resolving inherited values of the @code{:noweb-ref} header
15769 @node Key bindings and useful functions
15770 @section Key bindings and useful functions
15771 @cindex code block, key bindings
15773 Many common Org mode key sequences are re-bound depending on
15776 Within a code block, the following key bindings
15779 @multitable @columnfractions 0.25 0.75
15781 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
15783 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
15785 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
15787 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
15790 In an Org mode buffer, the following key bindings are active:
15792 @multitable @columnfractions 0.45 0.55
15794 @kindex C-c C-v C-p
15795 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
15797 @kindex C-c C-v C-n
15798 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
15800 @kindex C-c C-v C-e
15801 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
15803 @kindex C-c C-v C-o
15804 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
15806 @kindex C-c C-v C-v
15807 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
15809 @kindex C-c C-v C-u
15810 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
15812 @kindex C-c C-v C-g
15813 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
15815 @kindex C-c C-v C-r
15816 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
15818 @kindex C-c C-v C-b
15819 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15821 @kindex C-c C-v C-s
15822 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15824 @kindex C-c C-v C-d
15825 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
15827 @kindex C-c C-v C-t
15828 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15830 @kindex C-c C-v C-f
15831 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15833 @kindex C-c C-v C-c
15834 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
15836 @kindex C-c C-v C-j
15837 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
15839 @kindex C-c C-v C-l
15840 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
15842 @kindex C-c C-v C-i
15843 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
15845 @kindex C-c C-v C-I
15846 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
15848 @kindex C-c C-v C-z
15849 @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}
15851 @kindex C-c C-v C-a
15852 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15854 @kindex C-c C-v C-h
15855 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
15857 @kindex C-c C-v C-x
15858 @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}
15861 @c When possible these keybindings were extended to work when the control key is
15862 @c kept pressed, resulting in the following additional keybindings.
15864 @c @multitable @columnfractions 0.25 0.75
15865 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15866 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15867 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15868 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
15869 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
15870 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15871 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15872 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
15875 @node Batch execution
15876 @section Batch execution
15877 @cindex code block, batch execution
15878 @cindex source code, batch execution
15880 It is possible to call functions from the command line. This shell
15881 script calls @code{org-babel-tangle} on every one of its arguments.
15883 Be sure to adjust the paths to fit your system.
15887 # -*- mode: shell-script -*-
15889 # tangle files with org-mode
15894 # wrap each argument in the code required to call tangle on it
15896 FILES="$FILES \"$i\""
15901 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
15902 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
15903 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
15904 (mapc (lambda (file)
15905 (find-file (expand-file-name file \"$DIR\"))
15907 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
15910 @node Miscellaneous
15911 @chapter Miscellaneous
15914 * Completion:: M-TAB knows what you need
15915 * Easy templates:: Quick insertion of structural elements
15916 * Speed keys:: Electric commands at the beginning of a headline
15917 * Code evaluation security:: Org mode files evaluate inline code
15918 * Customization:: Adapting Org to your taste
15919 * In-buffer settings:: Overview of the #+KEYWORDS
15920 * The very busy C-c C-c key:: When in doubt, press C-c C-c
15921 * Clean view:: Getting rid of leading stars in the outline
15922 * TTY keys:: Using Org on a tty
15923 * Interaction:: Other Emacs packages
15924 * org-crypt:: Encrypting Org files
15929 @section Completion
15930 @cindex completion, of @TeX{} symbols
15931 @cindex completion, of TODO keywords
15932 @cindex completion, of dictionary words
15933 @cindex completion, of option keywords
15934 @cindex completion, of tags
15935 @cindex completion, of property keys
15936 @cindex completion, of link abbreviations
15937 @cindex @TeX{} symbol completion
15938 @cindex TODO keywords completion
15939 @cindex dictionary word completion
15940 @cindex option keyword completion
15941 @cindex tag completion
15942 @cindex link abbreviations, completion of
15944 Emacs would not be Emacs without completion, and Org mode uses it whenever it
15945 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
15946 some of the completion prompts, you can specify your preference by setting at
15947 most one of the variables @code{org-completion-use-iswitchb}
15948 @code{org-completion-use-ido}.
15950 Org supports in-buffer completion. This type of completion does
15951 not make use of the minibuffer. You simply type a few letters into
15952 the buffer and use the key to complete text right there.
15955 @kindex M-@key{TAB}
15957 Complete word at point
15960 At the beginning of a headline, complete TODO keywords.
15962 After @samp{\}, complete @TeX{} symbols supported by the exporter.
15964 After @samp{*}, complete headlines in the current buffer so that they
15965 can be used in search links like @samp{[[*find this headline]]}.
15967 After @samp{:} in a headline, complete tags. The list of tags is taken
15968 from the variable @code{org-tag-alist} (possibly set through the
15969 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
15970 dynamically from all tags used in the current buffer.
15972 After @samp{:} and not in a headline, complete property keys. The list
15973 of keys is constructed dynamically from all keys used in the current
15976 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
15978 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
15979 @samp{OPTIONS} which set file-specific options for Org mode. When the
15980 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
15981 will insert example settings for this keyword.
15983 In the line after @samp{#+STARTUP: }, complete startup keywords,
15984 i.e., valid keys for this line.
15986 Elsewhere, complete dictionary words using Ispell.
15990 @node Easy templates
15991 @section Easy templates
15992 @cindex template insertion
15993 @cindex insertion, of templates
15995 Org mode supports insertion of empty structural elements (like
15996 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
15997 strokes. This is achieved through a native template expansion mechanism.
15998 Note that Emacs has several other template mechanisms which could be used in
15999 a similar way, for example @file{yasnippet}.
16001 To insert a structural element, type a @samp{<}, followed by a template
16002 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
16003 keystrokes are typed on a line by itself.
16005 The following template selectors are currently supported.
16007 @multitable @columnfractions 0.1 0.9
16008 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
16009 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16010 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
16011 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
16012 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
16013 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
16014 @item @kbd{L} @tab @code{#+LaTeX:}
16015 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
16016 @item @kbd{H} @tab @code{#+HTML:}
16017 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
16018 @item @kbd{A} @tab @code{#+ASCII:}
16019 @item @kbd{i} @tab @code{#+INDEX:} line
16020 @item @kbd{I} @tab @code{#+INCLUDE:} line
16023 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16024 into a complete EXAMPLE template.
16026 You can install additional templates by customizing the variable
16027 @code{org-structure-template-alist}. See the docstring of the variable for
16028 additional details.
16031 @section Speed keys
16033 @vindex org-use-speed-commands
16034 @vindex org-speed-commands-user
16036 Single keys can be made to execute commands when the cursor is at the
16037 beginning of a headline, i.e., before the first star. Configure the variable
16038 @code{org-use-speed-commands} to activate this feature. There is a
16039 pre-defined list of commands, and you can add more such commands using the
16040 variable @code{org-speed-commands-user}. Speed keys not only speed up
16041 navigation and other commands, but they also provide an alternative way to
16042 execute commands bound to keys that are not or not easily available on a TTY,
16043 or on a small mobile device with a limited keyboard.
16045 To see which commands are available, activate the feature and press @kbd{?}
16046 with the cursor at the beginning of a headline.
16048 @node Code evaluation security
16049 @section Code evaluation and security issues
16051 Org provides tools to work with code snippets, including evaluating them.
16053 Running code on your machine always comes with a security risk. Badly
16054 written or malicious code can be executed on purpose or by accident. Org has
16055 default settings which will only evaluate such code if you give explicit
16056 permission to do so, and as a casual user of these features you should leave
16057 these precautions intact.
16059 For people who regularly work with such code, the confirmation prompts can
16060 become annoying, and you might want to turn them off. This can be done, but
16061 you must be aware of the risks that are involved.
16063 Code evaluation can happen under the following circumstances:
16066 @item Source code blocks
16067 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16068 C-c} in the block. The most important thing to realize here is that Org mode
16069 files which contain code snippets are, in a certain sense, like executable
16070 files. So you should accept them and load them into Emacs only from trusted
16071 sources---just like you would do with a program you install on your computer.
16073 Make sure you know what you are doing before customizing the variables
16074 which take off the default security brakes.
16076 @defopt org-confirm-babel-evaluate
16077 When t (the default), the user is asked before every code block evaluation.
16078 When @code{nil}, the user is not asked. When set to a function, it is called with
16079 two arguments (language and body of the code block) and should return t to
16080 ask and @code{nil} not to ask.
16083 For example, here is how to execute "ditaa" code (which is considered safe)
16087 (defun my-org-confirm-babel-evaluate (lang body)
16088 (not (string= lang "ditaa"))) ; don't ask for ditaa
16089 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
16092 @item Following @code{shell} and @code{elisp} links
16093 Org has two link types that can directly evaluate code (@pxref{External
16094 links}). These links can be problematic because the code to be evaluated is
16097 @defopt org-confirm-shell-link-function
16098 Function to queries user about shell link execution.
16100 @defopt org-confirm-elisp-link-function
16101 Functions to query user for Emacs Lisp link execution.
16104 @item Formulas in tables
16105 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
16106 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
16109 @node Customization
16110 @section Customization
16111 @cindex customization
16112 @cindex options, for customization
16113 @cindex variables, for customization
16115 There are more than 500 variables that can be used to customize
16116 Org. For the sake of compactness of the manual, I am not
16117 describing the variables here. A structured overview of customization
16118 variables is available with @kbd{M-x org-customize RET}. Or select
16119 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
16120 settings can also be activated on a per-file basis, by putting special
16121 lines into the buffer (@pxref{In-buffer settings}).
16123 @node In-buffer settings
16124 @section Summary of in-buffer settings
16125 @cindex in-buffer settings
16126 @cindex special keywords
16128 Org mode uses special lines in the buffer to define settings on a
16129 per-file basis. These lines start with a @samp{#+} followed by a
16130 keyword, a colon, and then individual words defining a setting. Several
16131 setting words can be in the same line, but you can also have multiple
16132 lines for the keyword. While these settings are described throughout
16133 the manual, here is a summary. After changing any of these lines in the
16134 buffer, press @kbd{C-c C-c} with the cursor still in the line to
16135 activate the changes immediately. Otherwise they become effective only
16136 when the file is visited again in a new Emacs session.
16138 @vindex org-archive-location
16140 @item #+ARCHIVE: %s_done::
16141 This line sets the archive location for the agenda file. It applies for
16142 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
16143 of the file. The first such line also applies to any entries before it.
16144 The corresponding variable is @code{org-archive-location}.
16146 This line sets the category for the agenda file. The category applies
16147 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
16148 end of the file. The first such line also applies to any entries before it.
16149 @item #+COLUMNS: %25ITEM ...
16150 @cindex property, COLUMNS
16151 Set the default format for columns view. This format applies when
16152 columns view is invoked in locations where no @code{COLUMNS} property
16154 @item #+CONSTANTS: name1=value1 ...
16155 @vindex org-table-formula-constants
16156 @vindex org-table-formula
16157 Set file-local values for constants to be used in table formulas. This
16158 line sets the local variable @code{org-table-formula-constants-local}.
16159 The global version of this variable is
16160 @code{org-table-formula-constants}.
16161 @item #+FILETAGS: :tag1:tag2:tag3:
16162 Set tags that can be inherited by any entry in the file, including the
16164 @item #+LINK: linkword replace
16165 @vindex org-link-abbrev-alist
16166 These lines (several are allowed) specify link abbreviations.
16167 @xref{Link abbreviations}. The corresponding variable is
16168 @code{org-link-abbrev-alist}.
16169 @item #+PRIORITIES: highest lowest default
16170 @vindex org-highest-priority
16171 @vindex org-lowest-priority
16172 @vindex org-default-priority
16173 This line sets the limits and the default for the priorities. All three
16174 must be either letters A--Z or numbers 0--9. The highest priority must
16175 have a lower ASCII number than the lowest priority.
16176 @item #+PROPERTY: Property_Name Value
16177 This line sets a default inheritance value for entries in the current
16178 buffer, most useful for specifying the allowed values of a property.
16179 @cindex #+SETUPFILE
16180 @item #+SETUPFILE: file
16181 This line defines a file that holds more in-buffer setup. Normally this is
16182 entirely ignored. Only when the buffer is parsed for option-setting lines
16183 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
16184 settings line, or when exporting), then the contents of this file are parsed
16185 as if they had been included in the buffer. In particular, the file can be
16186 any other Org mode file with internal setup. You can visit the file the
16187 cursor is in the line with @kbd{C-c '}.
16190 This line sets options to be used at startup of Org mode, when an
16191 Org file is being visited.
16193 The first set of options deals with the initial visibility of the outline
16194 tree. The corresponding variable for global default settings is
16195 @code{org-startup-folded}, with a default value @code{t}, which means
16197 @vindex org-startup-folded
16198 @cindex @code{overview}, STARTUP keyword
16199 @cindex @code{content}, STARTUP keyword
16200 @cindex @code{showall}, STARTUP keyword
16201 @cindex @code{showeverything}, STARTUP keyword
16203 overview @r{top-level headlines only}
16204 content @r{all headlines}
16205 showall @r{no folding of any entries}
16206 showeverything @r{show even drawer contents}
16209 @vindex org-startup-indented
16210 @cindex @code{indent}, STARTUP keyword
16211 @cindex @code{noindent}, STARTUP keyword
16212 Dynamic virtual indentation is controlled by the variable
16213 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
16215 indent @r{start with @code{org-indent-mode} turned on}
16216 noindent @r{start with @code{org-indent-mode} turned off}
16219 @vindex org-startup-align-all-tables
16220 Then there are options for aligning tables upon visiting a file. This
16221 is useful in files containing narrowed table columns. The corresponding
16222 variable is @code{org-startup-align-all-tables}, with a default value
16224 @cindex @code{align}, STARTUP keyword
16225 @cindex @code{noalign}, STARTUP keyword
16227 align @r{align all tables}
16228 noalign @r{don't align tables on startup}
16231 @vindex org-startup-with-inline-images
16232 When visiting a file, inline images can be automatically displayed. The
16233 corresponding variable is @code{org-startup-with-inline-images}, with a
16234 default value @code{nil} to avoid delays when visiting a file.
16235 @cindex @code{inlineimages}, STARTUP keyword
16236 @cindex @code{noinlineimages}, STARTUP keyword
16238 inlineimages @r{show inline images}
16239 noinlineimages @r{don't show inline images on startup}
16242 @vindex org-startup-with-latex-preview
16243 When visiting a file, @LaTeX{} fragments can be converted to images
16244 automatically. The variable @code{org-startup-with-latex-preview} which
16245 controls this behavior, is set to @code{nil} by default to avoid delays on
16247 @cindex @code{latexpreview}, STARTUP keyword
16248 @cindex @code{nolatexpreview}, STARTUP keyword
16250 latexpreview @r{preview @LaTeX{} fragments}
16251 nolatexpreview @r{don't preview @LaTeX{} fragments}
16254 @vindex org-log-done
16255 @vindex org-log-note-clock-out
16256 @vindex org-log-repeat
16257 Logging the closing and reopening of TODO items and clock intervals can be
16258 configured using these options (see variables @code{org-log-done},
16259 @code{org-log-note-clock-out} and @code{org-log-repeat})
16260 @cindex @code{logdone}, STARTUP keyword
16261 @cindex @code{lognotedone}, STARTUP keyword
16262 @cindex @code{nologdone}, STARTUP keyword
16263 @cindex @code{lognoteclock-out}, STARTUP keyword
16264 @cindex @code{nolognoteclock-out}, STARTUP keyword
16265 @cindex @code{logrepeat}, STARTUP keyword
16266 @cindex @code{lognoterepeat}, STARTUP keyword
16267 @cindex @code{nologrepeat}, STARTUP keyword
16268 @cindex @code{logreschedule}, STARTUP keyword
16269 @cindex @code{lognotereschedule}, STARTUP keyword
16270 @cindex @code{nologreschedule}, STARTUP keyword
16271 @cindex @code{logredeadline}, STARTUP keyword
16272 @cindex @code{lognoteredeadline}, STARTUP keyword
16273 @cindex @code{nologredeadline}, STARTUP keyword
16274 @cindex @code{logrefile}, STARTUP keyword
16275 @cindex @code{lognoterefile}, STARTUP keyword
16276 @cindex @code{nologrefile}, STARTUP keyword
16277 @cindex @code{logdrawer}, STARTUP keyword
16278 @cindex @code{nologdrawer}, STARTUP keyword
16279 @cindex @code{logstatesreversed}, STARTUP keyword
16280 @cindex @code{nologstatesreversed}, STARTUP keyword
16282 logdone @r{record a timestamp when an item is marked DONE}
16283 lognotedone @r{record timestamp and a note when DONE}
16284 nologdone @r{don't record when items are marked DONE}
16285 logrepeat @r{record a time when reinstating a repeating item}
16286 lognoterepeat @r{record a note when reinstating a repeating item}
16287 nologrepeat @r{do not record when reinstating repeating item}
16288 lognoteclock-out @r{record a note when clocking out}
16289 nolognoteclock-out @r{don't record a note when clocking out}
16290 logreschedule @r{record a timestamp when scheduling time changes}
16291 lognotereschedule @r{record a note when scheduling time changes}
16292 nologreschedule @r{do not record when a scheduling date changes}
16293 logredeadline @r{record a timestamp when deadline changes}
16294 lognoteredeadline @r{record a note when deadline changes}
16295 nologredeadline @r{do not record when a deadline date changes}
16296 logrefile @r{record a timestamp when refiling}
16297 lognoterefile @r{record a note when refiling}
16298 nologrefile @r{do not record when refiling}
16299 logdrawer @r{store log into drawer}
16300 nologdrawer @r{store log outside of drawer}
16301 logstatesreversed @r{reverse the order of states notes}
16302 nologstatesreversed @r{do not reverse the order of states notes}
16305 @vindex org-hide-leading-stars
16306 @vindex org-odd-levels-only
16307 Here are the options for hiding leading stars in outline headings, and for
16308 indenting outlines. The corresponding variables are
16309 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16310 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16311 @cindex @code{hidestars}, STARTUP keyword
16312 @cindex @code{showstars}, STARTUP keyword
16313 @cindex @code{odd}, STARTUP keyword
16314 @cindex @code{even}, STARTUP keyword
16316 hidestars @r{make all but one of the stars starting a headline invisible.}
16317 showstars @r{show all stars starting a headline}
16318 indent @r{virtual indentation according to outline level}
16319 noindent @r{no virtual indentation according to outline level}
16320 odd @r{allow only odd outline levels (1,3,...)}
16321 oddeven @r{allow all outline levels}
16324 @vindex org-put-time-stamp-overlays
16325 @vindex org-time-stamp-overlay-formats
16326 To turn on custom format overlays over timestamps (variables
16327 @code{org-put-time-stamp-overlays} and
16328 @code{org-time-stamp-overlay-formats}), use
16329 @cindex @code{customtime}, STARTUP keyword
16331 customtime @r{overlay custom time format}
16334 @vindex constants-unit-system
16335 The following options influence the table spreadsheet (variable
16336 @code{constants-unit-system}).
16337 @cindex @code{constcgs}, STARTUP keyword
16338 @cindex @code{constSI}, STARTUP keyword
16340 constcgs @r{@file{constants.el} should use the c-g-s unit system}
16341 constSI @r{@file{constants.el} should use the SI unit system}
16344 @vindex org-footnote-define-inline
16345 @vindex org-footnote-auto-label
16346 @vindex org-footnote-auto-adjust
16347 To influence footnote settings, use the following keywords. The
16348 corresponding variables are @code{org-footnote-define-inline},
16349 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16350 @cindex @code{fninline}, STARTUP keyword
16351 @cindex @code{nofninline}, STARTUP keyword
16352 @cindex @code{fnlocal}, STARTUP keyword
16353 @cindex @code{fnprompt}, STARTUP keyword
16354 @cindex @code{fnauto}, STARTUP keyword
16355 @cindex @code{fnconfirm}, STARTUP keyword
16356 @cindex @code{fnplain}, STARTUP keyword
16357 @cindex @code{fnadjust}, STARTUP keyword
16358 @cindex @code{nofnadjust}, STARTUP keyword
16360 fninline @r{define footnotes inline}
16361 fnnoinline @r{define footnotes in separate section}
16362 fnlocal @r{define footnotes near first reference, but not inline}
16363 fnprompt @r{prompt for footnote labels}
16364 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
16365 fnconfirm @r{offer automatic label for editing or confirmation}
16366 fnplain @r{create @code{[1]}-like labels automatically}
16367 fnadjust @r{automatically renumber and sort footnotes}
16368 nofnadjust @r{do not renumber and sort automatically}
16371 @cindex org-hide-block-startup
16372 To hide blocks on startup, use these keywords. The corresponding variable is
16373 @code{org-hide-block-startup}.
16374 @cindex @code{hideblocks}, STARTUP keyword
16375 @cindex @code{nohideblocks}, STARTUP keyword
16377 hideblocks @r{Hide all begin/end blocks on startup}
16378 nohideblocks @r{Do not hide blocks on startup}
16381 @cindex org-pretty-entities
16382 The display of entities as UTF-8 characters is governed by the variable
16383 @code{org-pretty-entities} and the keywords
16384 @cindex @code{entitiespretty}, STARTUP keyword
16385 @cindex @code{entitiesplain}, STARTUP keyword
16387 entitiespretty @r{Show entities as UTF-8 characters where possible}
16388 entitiesplain @r{Leave entities plain}
16391 @item #+TAGS: TAG1(c1) TAG2(c2)
16392 @vindex org-tag-alist
16393 These lines (several such lines are allowed) specify the valid tags in
16394 this file, and (potentially) the corresponding @emph{fast tag selection}
16395 keys. The corresponding variable is @code{org-tag-alist}.
16398 This line contains the formulas for the table directly above the line.
16400 Table can have multiple lines containing @samp{#+TBLFM:}. Note
16401 that only the first line of @samp{#+TBLFM:} will be applied when
16402 you recalculate the table. For more details see @ref{Using
16403 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16405 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16406 @itemx #+OPTIONS:, #+BIND:,
16407 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16408 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
16409 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16410 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16411 These lines provide settings for exporting files. For more details see
16412 @ref{Export settings}.
16413 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
16414 @vindex org-todo-keywords
16415 These lines set the TODO keywords and their interpretation in the
16416 current file. The corresponding variable is @code{org-todo-keywords}.
16419 @node The very busy C-c C-c key
16420 @section The very busy C-c C-c key
16422 @cindex C-c C-c, overview
16424 The key @kbd{C-c C-c} has many purposes in Org, which are all
16425 mentioned scattered throughout this manual. One specific function of
16426 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
16427 other circumstances it means something like @emph{``Hey Org, look
16428 here and update according to what you see here''}. Here is a summary of
16429 what this means in different contexts.
16433 If there are highlights in the buffer from the creation of a sparse
16434 tree, or from clock display, remove these highlights.
16436 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16437 triggers scanning the buffer for these lines and updating the
16440 If the cursor is inside a table, realign the table. This command
16441 works even if the automatic table editor has been turned off.
16443 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16446 If the current buffer is a capture buffer, close the note and file it.
16447 With a prefix argument, file it, without further interaction, to the
16450 If the cursor is on a @code{<<<target>>>}, update radio targets and
16451 corresponding links in this buffer.
16453 If the cursor is in a property line or at the start or end of a property
16454 drawer, offer property commands.
16456 If the cursor is at a footnote reference, go to the corresponding
16457 definition, and @emph{vice versa}.
16459 If the cursor is on a statistics cookie, update it.
16461 If the cursor is in a plain list item with a checkbox, toggle the status
16464 If the cursor is on a numbered item in a plain list, renumber the
16467 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16470 If the cursor is at a timestamp, fix the day name in the timestamp.
16474 @section A cleaner outline view
16475 @cindex hiding leading stars
16476 @cindex dynamic indentation
16477 @cindex odd-levels-only outlines
16478 @cindex clean outline view
16480 Some people find it noisy and distracting that the Org headlines start with a
16481 potentially large number of stars, and that text below the headlines is not
16482 indented. While this is no problem when writing a @emph{book-like} document
16483 where the outline headings are really section headings, in a more
16484 @emph{list-oriented} outline, indented structure is a lot cleaner:
16488 * Top level headline | * Top level headline
16489 ** Second level | * Second level
16490 *** 3rd level | * 3rd level
16491 some text | some text
16492 *** 3rd level | * 3rd level
16493 more text | more text
16494 * Another top level headline | * Another top level headline
16500 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16501 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16502 be achieved dynamically at display time using @code{org-indent-mode}. In
16503 this minor mode, all lines are prefixed for display with the necessary amount
16504 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16505 property, such that @code{visual-line-mode} (or purely setting
16506 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16507 }. Also headlines are prefixed with additional stars, so that the amount of
16508 indentation shifts by two@footnote{See the variable
16509 @code{org-indent-indentation-per-level}.} spaces per level. All headline
16510 stars but the last one are made invisible using the @code{org-hide}
16511 face@footnote{Turning on @code{org-indent-mode} sets
16512 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16513 @code{nil}.}; see below under @samp{2.} for more information on how this
16514 works. You can turn on @code{org-indent-mode} for all files by customizing
16515 the variable @code{org-startup-indented}, or you can turn it on for
16516 individual files using
16522 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16523 you want the indentation to be hard space characters so that the plain text
16524 file looks as similar as possible to the Emacs display, Org supports you in
16529 @emph{Indentation of text below headlines}@*
16530 You may indent text below each headline to make the left boundary line up
16531 with the headline, like
16535 more text, now indented
16538 @vindex org-adapt-indentation
16539 Org supports this with paragraph filling, line wrapping, and structure
16540 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16541 preserving or adapting the indentation as appropriate.
16544 @vindex org-hide-leading-stars
16545 @emph{Hiding leading stars}@* You can modify the display in such a way that
16546 all leading stars become invisible. To do this in a global way, configure
16547 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16551 #+STARTUP: hidestars
16552 #+STARTUP: showstars
16555 With hidden stars, the tree becomes:
16559 * Top level headline
16567 @vindex org-hide @r{(face)}
16568 The leading stars are not truly replaced by whitespace, they are only
16569 fontified with the face @code{org-hide} that uses the background color as
16570 font color. If you are not using either white or black background, you may
16571 have to customize this face to get the wanted effect. Another possibility is
16572 to set this font such that the extra stars are @i{almost} invisible, for
16573 example using the color @code{grey90} on a white background.
16576 @vindex org-odd-levels-only
16577 Things become cleaner still if you skip all the even levels and use only odd
16578 levels 1, 3, 5..., effectively adding two stars to go from one outline level
16579 to the next@footnote{When you need to specify a level for a property search
16580 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
16581 way we get the outline view shown at the beginning of this section. In order
16582 to make the structure editing and export commands handle this convention
16583 correctly, configure the variable @code{org-odd-levels-only}, or set this on
16584 a per-file basis with one of the following lines:
16591 You can convert an Org file from single-star-per-level to the
16592 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
16593 RET} in that file. The reverse operation is @kbd{M-x
16594 org-convert-to-oddeven-levels}.
16598 @section Using Org on a tty
16599 @cindex tty key bindings
16601 Because Org contains a large number of commands, by default many of
16602 Org's core commands are bound to keys that are generally not
16603 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
16604 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
16605 together with modifiers like @key{Meta} and/or @key{Shift}. To access
16606 these commands on a tty when special keys are unavailable, the following
16607 alternative bindings can be used. The tty bindings below will likely be
16608 more cumbersome; you may find for some of the bindings below that a
16609 customized workaround suits you better. For example, changing a timestamp
16610 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
16611 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
16613 @multitable @columnfractions 0.15 0.2 0.1 0.2
16614 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
16615 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
16616 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
16617 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
16618 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
16619 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
16620 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
16621 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
16622 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
16623 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
16624 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
16625 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
16626 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
16627 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
16628 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
16629 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
16630 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
16631 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
16632 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
16637 @section Interaction with other packages
16638 @cindex packages, interaction with other
16639 Org lives in the world of GNU Emacs and interacts in various ways
16640 with other code out there.
16643 * Cooperation:: Packages Org cooperates with
16644 * Conflicts:: Packages that lead to conflicts
16648 @subsection Packages that Org cooperates with
16651 @cindex @file{calc.el}
16652 @cindex Gillespie, Dave
16653 @item @file{calc.el} by Dave Gillespie
16654 Org uses the Calc package for implementing spreadsheet
16655 functionality in its tables (@pxref{The spreadsheet}). Org
16656 checks for the availability of Calc by looking for the function
16657 @code{calc-eval} which will have been autoloaded during setup if Calc has
16658 been installed properly. As of Emacs 22, Calc is part of the Emacs
16659 distribution. Another possibility for interaction between the two
16660 packages is using Calc for embedded calculations. @xref{Embedded Mode,
16661 , Embedded Mode, calc, GNU Emacs Calc Manual}.
16662 @item @file{constants.el} by Carsten Dominik
16663 @cindex @file{constants.el}
16664 @cindex Dominik, Carsten
16665 @vindex org-table-formula-constants
16666 In a table formula (@pxref{The spreadsheet}), it is possible to use
16667 names for natural constants or units. Instead of defining your own
16668 constants in the variable @code{org-table-formula-constants}, install
16669 the @file{constants} package which defines a large number of constants
16670 and units, and lets you use unit prefixes like @samp{M} for
16671 @samp{Mega}, etc. You will need version 2.0 of this package, available
16672 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
16673 the function @code{constants-get}, which has to be autoloaded in your
16674 setup. See the installation instructions in the file
16675 @file{constants.el}.
16676 @item @file{cdlatex.el} by Carsten Dominik
16677 @cindex @file{cdlatex.el}
16678 @cindex Dominik, Carsten
16679 Org mode can make use of the CD@LaTeX{} package to efficiently enter
16680 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
16681 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
16682 @cindex @file{imenu.el}
16683 Imenu allows menu access to an index of items in a file. Org mode
16684 supports Imenu---all you need to do to get the index is the following:
16686 (add-hook 'org-mode-hook
16687 (lambda () (imenu-add-to-menubar "Imenu")))
16689 @vindex org-imenu-depth
16690 By default the index is two levels deep---you can modify the depth using
16691 the option @code{org-imenu-depth}.
16692 @item @file{remember.el} by John Wiegley
16693 @cindex @file{remember.el}
16694 @cindex Wiegley, John
16695 Org used to use this package for capture, but no longer does.
16696 @item @file{speedbar.el} by Eric M. Ludlam
16697 @cindex @file{speedbar.el}
16698 @cindex Ludlam, Eric M.
16699 Speedbar is a package that creates a special frame displaying files and
16700 index items in files. Org mode supports Speedbar and allows you to
16701 drill into Org files directly from the Speedbar. It also allows you to
16702 restrict the scope of agenda commands to a file or a subtree by using
16703 the command @kbd{<} in the Speedbar frame.
16704 @cindex @file{table.el}
16705 @item @file{table.el} by Takaaki Ota
16707 @cindex table editor, @file{table.el}
16708 @cindex @file{table.el}
16709 @cindex Ota, Takaaki
16711 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
16712 and alignment can be created using the Emacs table package by Takaaki Ota
16713 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
16714 Org mode will recognize these tables and export them properly. Because of
16715 interference with other Org mode functionality, you unfortunately cannot edit
16716 these tables directly in the buffer. Instead, you need to use the command
16717 @kbd{C-c '} to edit them, similar to source code snippets.
16720 @orgcmd{C-c ',org-edit-special}
16721 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
16723 @orgcmd{C-c ~,org-table-create-with-table.el}
16724 Insert a @file{table.el} table. If there is already a table at point, this
16725 command converts it between the @file{table.el} format and the Org mode
16726 format. See the documentation string of the command
16727 @code{org-convert-table} for the restrictions under which this is
16730 @file{table.el} is part of Emacs since Emacs 22.
16731 @item @file{footnote.el} by Steven L. Baur
16732 @cindex @file{footnote.el}
16733 @cindex Baur, Steven L.
16734 Org mode recognizes numerical footnotes as provided by this package.
16735 However, Org mode also has its own footnote support (@pxref{Footnotes}),
16736 which makes using @file{footnote.el} unnecessary.
16740 @subsection Packages that lead to conflicts with Org mode
16744 @cindex @code{shift-selection-mode}
16745 @vindex org-support-shift-select
16746 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
16747 cursor motions combined with the shift key should start or enlarge regions.
16748 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
16749 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
16750 at such a location. By default, @kbd{S-@key{cursor}} commands outside
16751 special contexts don't do anything, but you can customize the variable
16752 @code{org-support-shift-select}. Org mode then tries to accommodate shift
16753 selection by (i) using it outside of the special contexts where special
16754 commands apply, and by (ii) extending an existing active region even if the
16755 cursor moves across a special context.
16757 @item @file{CUA.el} by Kim. F. Storm
16758 @cindex @file{CUA.el}
16759 @cindex Storm, Kim. F.
16760 @vindex org-replace-disputed-keys
16761 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
16762 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
16763 extend the region. In fact, Emacs 23 has this built-in in the form of
16764 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
16765 23, you probably don't want to use another package for this purpose.
16766 However, if you prefer to leave these keys to a different package while
16767 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
16768 When set, Org will move the following key bindings in Org files, and in the
16769 agenda buffer (but not during date selection).
16772 S-UP @result{} M-p S-DOWN @result{} M-n
16773 S-LEFT @result{} M-- S-RIGHT @result{} M-+
16774 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
16777 @vindex org-disputed-keys
16778 Yes, these are unfortunately more difficult to remember. If you want
16779 to have other replacement keys, look at the variable
16780 @code{org-disputed-keys}.
16782 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
16783 @cindex @file{ecomplete.el}
16785 Ecomplete provides ``electric'' address completion in address header
16786 lines in message buffers. Sadly Orgtbl mode cuts ecompletes power
16787 supply: No completion happens when Orgtbl mode is enabled in message
16788 buffers while entering text in address header lines. If one wants to
16789 use ecomplete one should @emph{not} follow the advice to automagically
16790 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
16791 instead---after filling in the message headers---turn on Orgtbl mode
16792 manually when needed in the messages body.
16794 @item @file{filladapt.el} by Kyle Jones
16795 @cindex @file{filladapt.el}
16797 Org mode tries to do the right thing when filling paragraphs, list items and
16798 other elements. Many users reported they had problems using both
16799 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
16803 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
16806 @item @file{yasnippet.el}
16807 @cindex @file{yasnippet.el}
16808 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
16809 @code{"\t"}) overrules YASnippet's access to this key. The following code
16810 fixed this problem:
16813 (add-hook 'org-mode-hook
16815 (org-set-local 'yas/trigger-key [tab])
16816 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
16819 The latest version of yasnippet doesn't play well with Org mode. If the
16820 above code does not fix the conflict, start by defining the following
16824 (defun yas/org-very-safe-expand ()
16825 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
16828 Then, tell Org mode what to do with the new function:
16831 (add-hook 'org-mode-hook
16833 (make-variable-buffer-local 'yas/trigger-key)
16834 (setq yas/trigger-key [tab])
16835 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
16836 (define-key yas/keymap [tab] 'yas/next-field)))
16839 @item @file{windmove.el} by Hovav Shacham
16840 @cindex @file{windmove.el}
16841 This package also uses the @kbd{S-<cursor>} keys, so everything written
16842 in the paragraph above about CUA mode also applies here. If you want make
16843 the windmove function active in locations where Org mode does not have
16844 special functionality on @kbd{S-@key{cursor}}, add this to your
16848 ;; Make windmove work in org-mode:
16849 (add-hook 'org-shiftup-final-hook 'windmove-up)
16850 (add-hook 'org-shiftleft-final-hook 'windmove-left)
16851 (add-hook 'org-shiftdown-final-hook 'windmove-down)
16852 (add-hook 'org-shiftright-final-hook 'windmove-right)
16855 @item @file{viper.el} by Michael Kifer
16856 @cindex @file{viper.el}
16858 Viper uses @kbd{C-c /} and therefore makes this key not access the
16859 corresponding Org mode command @code{org-sparse-tree}. You need to find
16860 another key for this command, or override the key in
16861 @code{viper-vi-global-user-map} with
16864 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
16872 @section org-crypt.el
16873 @cindex @file{org-crypt.el}
16874 @cindex @code{org-decrypt-entry}
16876 Org-crypt will encrypt the text of an entry, but not the headline, or
16877 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
16880 Any text below a headline that has a @samp{:crypt:} tag will be automatically
16881 be encrypted when the file is saved. If you want to use a different tag just
16882 customize the @code{org-crypt-tag-matcher} setting.
16884 To use org-crypt it is suggested that you have the following in your
16888 (require 'org-crypt)
16889 (org-crypt-use-before-save-magic)
16890 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
16892 (setq org-crypt-key nil)
16893 ;; GPG key to use for encryption
16894 ;; Either the Key ID or set to nil to use symmetric encryption.
16896 (setq auto-save-default nil)
16897 ;; Auto-saving does not cooperate with org-crypt.el: so you need
16898 ;; to turn it off if you plan to use org-crypt.el quite often.
16899 ;; Otherwise, you'll get an (annoying) message each time you
16902 ;; To turn it off only locally, you can insert this:
16904 ;; # -*- buffer-auto-save-file-name: nil; -*-
16907 Excluding the crypt tag from inheritance prevents already encrypted text
16908 being encrypted again.
16914 This appendix covers some areas where users can extend the functionality of
16918 * Hooks:: How to reach into Org's internals
16919 * Add-on packages:: Available extensions
16920 * Adding hyperlink types:: New custom link types
16921 * Adding export back-ends:: How to write new export back-ends
16922 * Context-sensitive commands:: How to add functionality to such commands
16923 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
16924 * Dynamic blocks:: Automatically filled blocks
16925 * Special agenda views:: Customized views
16926 * Speeding up your agendas:: Tips on how to speed up your agendas
16927 * Extracting agenda information:: Post-processing of agenda information
16928 * Using the property API:: Writing programs that use entry properties
16929 * Using the mapping API:: Mapping over all or selected entries
16936 Org has a large number of hook variables that can be used to add
16937 functionality. This appendix about hacking is going to illustrate the
16938 use of some of them. A complete list of all hooks with documentation is
16939 maintained by the Worg project and can be found at
16940 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
16942 @node Add-on packages
16943 @section Add-on packages
16944 @cindex add-on packages
16946 A large number of add-on packages have been written by various authors.
16948 These packages are not part of Emacs, but they are distributed as contributed
16949 packages with the separate release available at @uref{http://orgmode.org}.
16950 See the @file{contrib/README} file in the source code directory for a list of
16951 contributed files. You may also find some more information on the Worg page:
16952 @uref{http://orgmode.org/worg/org-contrib/}.
16954 @node Adding hyperlink types
16955 @section Adding hyperlink types
16956 @cindex hyperlinks, adding new types
16958 Org has a large number of hyperlink types built-in
16959 (@pxref{Hyperlinks}). If you would like to add new link types, Org
16960 provides an interface for doing so. Let's look at an example file,
16961 @file{org-man.el}, that will add support for creating links like
16962 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
16966 ;;; org-man.el - Support for links to manpages in Org
16970 (org-add-link-type "man" 'org-man-open)
16971 (add-hook 'org-store-link-functions 'org-man-store-link)
16973 (defcustom org-man-command 'man
16974 "The Emacs command to be used to display a man page."
16976 :type '(choice (const man) (const woman)))
16978 (defun org-man-open (path)
16979 "Visit the manpage on PATH.
16980 PATH should be a topic that can be thrown at the man command."
16981 (funcall org-man-command path))
16983 (defun org-man-store-link ()
16984 "Store a link to a manpage."
16985 (when (memq major-mode '(Man-mode woman-mode))
16986 ;; This is a man page, we do make this link
16987 (let* ((page (org-man-get-page-name))
16988 (link (concat "man:" page))
16989 (description (format "Manpage for %s" page)))
16990 (org-store-link-props
16993 :description description))))
16995 (defun org-man-get-page-name ()
16996 "Extract the page name from the buffer name."
16997 ;; This works for both `Man-mode' and `woman-mode'.
16998 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
16999 (match-string 1 (buffer-name))
17000 (error "Cannot create link to this man page")))
17004 ;;; org-man.el ends here
17008 You would activate this new link type in @file{.emacs} with
17015 Let's go through the file and see what it does.
17018 It does @code{(require 'org)} to make sure that @file{org.el} has been
17021 The next line calls @code{org-add-link-type} to define a new link type
17022 with prefix @samp{man}. The call also contains the name of a function
17023 that will be called to follow such a link.
17025 @vindex org-store-link-functions
17026 The next line adds a function to @code{org-store-link-functions}, in
17027 order to allow the command @kbd{C-c l} to record a useful link in a
17028 buffer displaying a man page.
17031 The rest of the file defines the necessary variables and functions.
17032 First there is a customization variable that determines which Emacs
17033 command should be used to display man pages. There are two options,
17034 @code{man} and @code{woman}. Then the function to follow a link is
17035 defined. It gets the link path as an argument---in this case the link
17036 path is just a topic for the manual command. The function calls the
17037 value of @code{org-man-command} to display the man page.
17039 Finally the function @code{org-man-store-link} is defined. When you try
17040 to store a link with @kbd{C-c l}, this function will be called to
17041 try to make a link. The function must first decide if it is supposed to
17042 create the link for this buffer type; we do this by checking the value
17043 of the variable @code{major-mode}. If not, the function must exit and
17044 return the value @code{nil}. If yes, the link is created by getting the
17045 manual topic from the buffer name and prefixing it with the string
17046 @samp{man:}. Then it must call the command @code{org-store-link-props}
17047 and set the @code{:type} and @code{:link} properties. Optionally you
17048 can also set the @code{:description} property to provide a default for
17049 the link description when the link is later inserted into an Org
17050 buffer with @kbd{C-c C-l}.
17052 When it makes sense for your new link type, you may also define a function
17053 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
17054 support for inserting such a link with @kbd{C-c C-l}. Such a function should
17055 not accept any arguments, and return the full link with prefix.
17057 @node Adding export back-ends
17058 @section Adding export back-ends
17059 @cindex Export, writing back-ends
17061 Org 8.0 comes with a completely rewritten export engine which makes it easy
17062 to write new export back-ends, either from scratch, or by deriving them
17063 from existing ones.
17065 Your two entry points are respectively @code{org-export-define-backend} and
17066 @code{org-export-define-derived-backend}. To grok these functions, you
17067 should first have a look at @file{ox-latex.el} (for how to define a new
17068 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17069 back-end from an existing one.
17071 When creating a new back-end from scratch, the basic idea is to set the name
17072 of the back-end (as a symbol) and an an alist of elements and export
17073 functions. On top of this, you will need to set additional keywords like
17074 @code{:menu-entry} (to display the back-end in the export dispatcher),
17075 @code{:export-block} (to specify what blocks should not be exported by this
17076 back-end), and @code{:options-alist} (to let the user set export options that
17077 are specific to this back-end.)
17079 Deriving a new back-end is similar, except that you need to set
17080 @code{:translate-alist} to an alist of export functions that should be used
17081 instead of the parent back-end functions.
17083 For a complete reference documentation, see
17084 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17085 Reference on Worg}.
17087 @node Context-sensitive commands
17088 @section Context-sensitive commands
17089 @cindex context-sensitive commands, hooks
17090 @cindex add-ons, context-sensitive commands
17091 @vindex org-ctrl-c-ctrl-c-hook
17093 Org has several commands that act differently depending on context. The most
17094 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17095 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17097 Add-ons can tap into this functionality by providing a function that detects
17098 special context for that add-on and executes functionality appropriate for
17099 the context. Here is an example from Dan Davison's @file{org-R.el} which
17100 allows you to evaluate commands based on the @file{R} programming language
17101 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17102 described in @ref{Working with source code} and is now obsolete.}. For this
17103 package, special contexts are lines that start with @code{#+R:} or
17107 (defun org-R-apply-maybe ()
17108 "Detect if this is context for org-R and execute R commands."
17109 (if (save-excursion
17110 (beginning-of-line 1)
17111 (looking-at "#\\+RR?:"))
17112 (progn (call-interactively 'org-R-apply)
17113 t) ;; to signal that we took action
17114 nil)) ;; to signal that we did not
17116 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
17119 The function first checks if the cursor is in such a line. If that is the
17120 case, @code{org-R-apply} is called and the function returns @code{t} to
17121 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
17122 contexts. If the function finds it should do nothing locally, it returns
17123 @code{nil} so that other, similar functions can have a try.
17126 @node Tables in arbitrary syntax
17127 @section Tables and lists in arbitrary syntax
17128 @cindex tables, in other modes
17129 @cindex lists, in other modes
17130 @cindex Orgtbl mode
17132 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
17133 frequent feature request has been to make it work with native tables in
17134 specific languages, for example @LaTeX{}. However, this is extremely
17135 hard to do in a general way, would lead to a customization nightmare,
17136 and would take away much of the simplicity of the Orgtbl mode table
17139 This appendix describes a different approach. We keep the Orgtbl mode
17140 table in its native format (the @i{source table}), and use a custom
17141 function to @i{translate} the table to the correct syntax, and to
17142 @i{install} it in the right location (the @i{target table}). This puts
17143 the burden of writing conversion functions on the user, but it allows
17144 for a very flexible system.
17146 Bastien added the ability to do the same with lists, in Orgstruct mode. You
17147 can use Org's facilities to edit and structure lists by turning
17148 @code{orgstruct-mode} on, then locally exporting such lists in another format
17149 (HTML, @LaTeX{} or Texinfo.)
17153 * Radio tables:: Sending and receiving radio tables
17154 * A @LaTeX{} example:: Step by step, almost a tutorial
17155 * Translator functions:: Copy and modify
17156 * Radio lists:: Sending and receiving lists
17160 @subsection Radio tables
17161 @cindex radio tables
17163 To define the location of the target table, you first need to create two
17164 lines that are comments in the current mode, but contain magic words
17165 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will
17166 insert the translated table between these lines, replacing whatever was there
17167 before. For example in C mode where comments are between @code{/* ... */}:
17170 /* BEGIN RECEIVE ORGTBL table_name */
17171 /* END RECEIVE ORGTBL table_name */
17175 Just above the source table, we put a special line that tells
17176 Orgtbl mode how to translate this table and where to install it. For
17180 #+ORGTBL: SEND table_name translation_function arguments...
17184 @code{table_name} is the reference name for the table that is also used
17185 in the receiver lines. @code{translation_function} is the Lisp function
17186 that does the translation. Furthermore, the line can contain a list of
17187 arguments (alternating key and value) at the end. The arguments will be
17188 passed as a property list to the translation function for
17189 interpretation. A few standard parameters are already recognized and
17190 acted upon before the translation function is called:
17194 Skip the first N lines of the table. Hlines do count as separate lines for
17197 @item :skipcols (n1 n2 ...)
17198 List of columns that should be skipped. If the table has a column with
17199 calculation marks, that column is automatically discarded as well.
17200 Please note that the translator function sees the table @emph{after} the
17201 removal of these columns, the function never knows that there have been
17202 additional columns.
17205 When non-@code{nil}, do not escape special characters @code{&%#_^} when exporting
17206 the table. The default value is @code{nil}.
17210 The one problem remaining is how to keep the source table in the buffer
17211 without disturbing the normal workings of the file, for example during
17212 compilation of a C file or processing of a @LaTeX{} file. There are a
17213 number of different solutions:
17217 The table could be placed in a block comment if that is supported by the
17218 language. For example, in C mode you could wrap the table between
17219 @samp{/*} and @samp{*/} lines.
17221 Sometimes it is possible to put the table after some kind of @i{END}
17222 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
17225 You can just comment the table line-by-line whenever you want to process
17226 the file, and uncomment it whenever you need to edit the table. This
17227 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
17228 makes this comment-toggling very easy, in particular if you bind it to a
17232 @node A @LaTeX{} example
17233 @subsection A @LaTeX{} example of radio tables
17234 @cindex @LaTeX{}, and Orgtbl mode
17236 The best way to wrap the source table in @LaTeX{} is to use the
17237 @code{comment} environment provided by @file{comment.sty}. It has to be
17238 activated by placing @code{\usepackage@{comment@}} into the document
17239 header. Orgtbl mode can insert a radio table skeleton@footnote{By
17240 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
17241 variable @code{orgtbl-radio-table-templates} to install templates for other
17242 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
17243 be prompted for a table name, let's say we use @samp{salesfigures}. You
17244 will then get the following template:
17246 @cindex #+ORGTBL, SEND
17248 % BEGIN RECEIVE ORGTBL salesfigures
17249 % END RECEIVE ORGTBL salesfigures
17251 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17257 @vindex @LaTeX{}-verbatim-environments
17258 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
17259 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
17260 into the receiver location with name @code{salesfigures}. You may now
17261 fill in the table---feel free to use the spreadsheet features@footnote{If
17262 the @samp{#+TBLFM} line contains an odd number of dollar characters,
17263 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
17264 example you can fix this by adding an extra line inside the
17265 @code{comment} environment that is used to balance the dollar
17266 expressions. If you are using AUC@TeX{} with the font-latex library, a
17267 much better solution is to add the @code{comment} environment to the
17268 variable @code{LaTeX-verbatim-environments}.}:
17271 % BEGIN RECEIVE ORGTBL salesfigures
17272 % END RECEIVE ORGTBL salesfigures
17274 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17275 | Month | Days | Nr sold | per day |
17276 |-------+------+---------+---------|
17277 | Jan | 23 | 55 | 2.4 |
17278 | Feb | 21 | 16 | 0.8 |
17279 | March | 22 | 278 | 12.6 |
17280 #+TBLFM: $4=$3/$2;%.1f
17281 % $ (optional extra dollar to keep font-lock happy, see footnote)
17286 When you are done, press @kbd{C-c C-c} in the table to get the converted
17287 table inserted between the two marker lines.
17289 Now let's assume you want to make the table header by hand, because you
17290 want to control how columns are aligned, etc. In this case we make sure
17291 that the table translator skips the first 2 lines of the source
17292 table, and tell the command to work as a @i{splice}, i.e., to not produce
17293 header and footer commands of the target table:
17296 \begin@{tabular@}@{lrrr@}
17297 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
17298 % BEGIN RECEIVE ORGTBL salesfigures
17299 % END RECEIVE ORGTBL salesfigures
17303 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17304 | Month | Days | Nr sold | per day |
17305 |-------+------+---------+---------|
17306 | Jan | 23 | 55 | 2.4 |
17307 | Feb | 21 | 16 | 0.8 |
17308 | March | 22 | 278 | 12.6 |
17309 #+TBLFM: $4=$3/$2;%.1f
17313 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17314 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
17315 and marks horizontal lines with @code{\hline}. Furthermore, it
17316 interprets the following parameters (see also @pxref{Translator functions}):
17319 @item :splice nil/t
17320 When set to t, return only table body lines, don't wrap them into a
17321 tabular environment. Default is @code{nil}.
17324 A format to be used to wrap each field, it should contain @code{%s} for the
17325 original field value. For example, to wrap each field value in dollars,
17326 you could use @code{:fmt "$%s$"}. This may also be a property list with
17327 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17328 A function of one argument can be used in place of the strings; the
17329 function must return a formatted string.
17332 Use this format to print numbers with exponentials. The format should
17333 have @code{%s} twice for inserting mantissa and exponent, for example
17334 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
17335 may also be a property list with column numbers and formats, for example
17336 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
17337 @code{efmt} has been applied to a value, @code{fmt} will also be
17338 applied. Similar to @code{fmt}, functions of two arguments can be
17339 supplied instead of strings.
17342 @node Translator functions
17343 @subsection Translator functions
17344 @cindex HTML, and Orgtbl mode
17345 @cindex translator function
17347 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17348 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17349 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
17350 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
17351 code that produces tables during HTML export.}, these all use a generic
17352 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
17353 itself is a very short function that computes the column definitions for the
17354 @code{tabular} environment, defines a few field and line separators and then
17355 hands processing over to the generic translator. Here is the entire code:
17359 (defun orgtbl-to-latex (table params)
17360 "Convert the Orgtbl mode TABLE to LaTeX."
17361 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
17362 org-table-last-alignment ""))
17365 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
17366 :tend "\\end@{tabular@}"
17367 :lstart "" :lend " \\\\" :sep " & "
17368 :efmt "%s\\,(%s)" :hline "\\hline")))
17369 (orgtbl-to-generic table (org-combine-plists params2 params))))
17373 As you can see, the properties passed into the function (variable
17374 @var{PARAMS}) are combined with the ones newly defined in the function
17375 (variable @var{PARAMS2}). The ones passed into the function (i.e., the
17376 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
17377 would like to use the @LaTeX{} translator, but wanted the line endings to
17378 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
17379 overrule the default with
17382 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17385 For a new language, you can either write your own converter function in
17386 analogy with the @LaTeX{} translator, or you can use the generic function
17387 directly. For example, if you have a language where a table is started
17388 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
17389 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17390 separator is a TAB, you could call the generic translator like this (on
17394 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
17395 :lstart "!BL! " :lend " !EL!" :sep "\t"
17399 Please check the documentation string of the function
17400 @code{orgtbl-to-generic} for a full list of parameters understood by
17401 that function, and remember that you can pass each of them into
17402 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17403 using the generic function.
17405 Of course you can also write a completely new function doing complicated
17406 things the generic translator cannot do. A translator function takes
17407 two arguments. The first argument is the table, a list of lines, each
17408 line either the symbol @code{hline} or a list of fields. The second
17409 argument is the property list containing all parameters specified in the
17410 @samp{#+ORGTBL: SEND} line. The function must return a single string
17411 containing the formatted table. If you write a generally useful
17412 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17413 others can benefit from your work.
17416 @subsection Radio lists
17417 @cindex radio lists
17418 @cindex org-list-insert-radio-list
17420 Sending and receiving radio lists works exactly the same way as sending and
17421 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
17422 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17423 @code{org-list-insert-radio-list}.
17425 Here are the differences with radio tables:
17429 Orgstruct mode must be active.
17431 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17433 The available translation functions for radio lists don't take
17436 @kbd{C-c C-c} will work when pressed on the first item of the list.
17439 Here is a @LaTeX{} example. Let's say that you have this in your
17444 % BEGIN RECEIVE ORGLST to-buy
17445 % END RECEIVE ORGLST to-buy
17447 #+ORGLST: SEND to-buy org-list-to-latex
17456 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17457 @LaTeX{} list between the two marker lines.
17459 @node Dynamic blocks
17460 @section Dynamic blocks
17461 @cindex dynamic blocks
17463 Org documents can contain @emph{dynamic blocks}. These are
17464 specially marked regions that are updated by some user-written function.
17465 A good example for such a block is the clock table inserted by the
17466 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17468 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17469 to the block and can also specify parameters for the function producing
17470 the content of the block.
17472 @cindex #+BEGIN:dynamic block
17474 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17479 Dynamic blocks are updated with the following commands
17482 @orgcmd{C-c C-x C-u,org-dblock-update}
17483 Update dynamic block at point.
17484 @orgkey{C-u C-c C-x C-u}
17485 Update all dynamic blocks in the current file.
17488 Updating a dynamic block means to remove all the text between BEGIN and
17489 END, parse the BEGIN line for parameters and then call the specific
17490 writer function for this block to insert the new content. If you want
17491 to use the original content in the writer function, you can use the
17492 extra parameter @code{:content}.
17494 For a block with name @code{myblock}, the writer function is
17495 @code{org-dblock-write:myblock} with as only parameter a property list
17496 with the parameters given in the begin line. Here is a trivial example
17497 of a block that keeps track of when the block update function was last
17501 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17507 The corresponding block writer function could look like this:
17510 (defun org-dblock-write:block-update-time (params)
17511 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17512 (insert "Last block update at: "
17513 (format-time-string fmt (current-time)))))
17516 If you want to make sure that all dynamic blocks are always up-to-date,
17517 you could add the function @code{org-update-all-dblocks} to a hook, for
17518 example @code{before-save-hook}. @code{org-update-all-dblocks} is
17519 written in a way such that it does nothing in buffers that are not in
17522 You can narrow the current buffer to the current dynamic block (like any
17523 other block) with @code{org-narrow-to-block}.
17525 @node Special agenda views
17526 @section Special agenda views
17527 @cindex agenda views, user-defined
17529 @vindex org-agenda-skip-function
17530 @vindex org-agenda-skip-function-global
17531 Org provides a special hook that can be used to narrow down the selection
17532 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17533 @code{agenda*} view is the same as @code{agenda} except that it only
17534 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17535 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17536 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
17537 specify a function that is used at each match to verify if the match should
17538 indeed be part of the agenda view, and if not, how much should be skipped.
17539 You can specify a global condition that will be applied to all agenda views,
17540 this condition would be stored in the variable
17541 @code{org-agenda-skip-function-global}. More commonly, such a definition is
17542 applied only to specific custom searches, using
17543 @code{org-agenda-skip-function}.
17545 Let's say you want to produce a list of projects that contain a WAITING
17546 tag anywhere in the project tree. Let's further assume that you have
17547 marked all tree headings that define a project with the TODO keyword
17548 PROJECT@. In this case you would run a TODO search for the keyword
17549 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17550 the subtree belonging to the project line.
17552 To achieve this, you must write a function that searches the subtree for
17553 the tag. If the tag is found, the function must return @code{nil} to
17554 indicate that this match should not be skipped. If there is no such
17555 tag, return the location of the end of the subtree, to indicate that
17556 search should continue from there.
17559 (defun my-skip-unless-waiting ()
17560 "Skip trees that are not waiting"
17561 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17562 (if (re-search-forward ":waiting:" subtree-end t)
17563 nil ; tag found, do not skip
17564 subtree-end))) ; tag not found, continue after end of subtree
17567 Now you may use this function in an agenda custom command, for example
17571 (org-add-agenda-custom-command
17572 '("b" todo "PROJECT"
17573 ((org-agenda-skip-function 'my-skip-unless-waiting)
17574 (org-agenda-overriding-header "Projects waiting for something: "))))
17577 @vindex org-agenda-overriding-header
17578 Note that this also binds @code{org-agenda-overriding-header} to get a
17579 meaningful header in the agenda view.
17581 @vindex org-odd-levels-only
17582 @vindex org-agenda-skip-function
17583 A general way to create custom searches is to base them on a search for
17584 entries with a certain level limit. If you want to study all entries with
17585 your custom search function, simply do a search for
17586 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
17587 level number corresponds to order in the hierarchy, not to the number of
17588 stars.}, and then use @code{org-agenda-skip-function} to select the entries
17589 you really want to have.
17591 You may also put a Lisp form into @code{org-agenda-skip-function}. In
17592 particular, you may use the functions @code{org-agenda-skip-entry-if}
17593 and @code{org-agenda-skip-subtree-if} in this form, for example:
17596 @item (org-agenda-skip-entry-if 'scheduled)
17597 Skip current entry if it has been scheduled.
17598 @item (org-agenda-skip-entry-if 'notscheduled)
17599 Skip current entry if it has not been scheduled.
17600 @item (org-agenda-skip-entry-if 'deadline)
17601 Skip current entry if it has a deadline.
17602 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
17603 Skip current entry if it has a deadline, or if it is scheduled.
17604 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
17605 Skip current entry if the TODO keyword is TODO or WAITING.
17606 @item (org-agenda-skip-entry-if 'todo 'done)
17607 Skip current entry if the TODO keyword marks a DONE state.
17608 @item (org-agenda-skip-entry-if 'timestamp)
17609 Skip current entry if it has any timestamp, may also be deadline or scheduled.
17610 @anchor{x-agenda-skip-entry-regexp}
17611 @item (org-agenda-skip-entry-if 'regexp "regular expression")
17612 Skip current entry if the regular expression matches in the entry.
17613 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
17614 Skip current entry unless the regular expression matches.
17615 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
17616 Same as above, but check and skip the entire subtree.
17619 Therefore we could also have written the search for WAITING projects
17620 like this, even without defining a special function:
17623 (org-add-agenda-custom-command
17624 '("b" todo "PROJECT"
17625 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
17626 'regexp ":waiting:"))
17627 (org-agenda-overriding-header "Projects waiting for something: "))))
17630 @node Speeding up your agendas
17631 @section Speeding up your agendas
17632 @cindex agenda views, optimization
17634 When your Org files grow in both number and size, agenda commands may start
17635 to become slow. Below are some tips on how to speed up the agenda commands.
17639 Reduce the number of Org agenda files: this will reduce the slowdown caused
17640 by accessing a hard drive.
17642 Reduce the number of DONE and archived headlines: this way the agenda does
17643 not need to skip them.
17645 @vindex org-agenda-dim-blocked-tasks
17646 Inhibit the dimming of blocked tasks:
17648 (setq org-agenda-dim-blocked-tasks nil)
17651 @vindex org-startup-folded
17652 @vindex org-agenda-inhibit-startup
17653 Inhibit agenda files startup options:
17655 (setq org-agenda-inhibit-startup nil)
17658 @vindex org-agenda-show-inherited-tags
17659 @vindex org-agenda-use-tag-inheritance
17660 Disable tag inheritance in agenda:
17662 (setq org-agenda-use-tag-inheritance nil)
17666 You can set these options for specific agenda views only. See the docstrings
17667 of these variables for details on why they affect the agenda generation, and
17668 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
17669 page} for further explanations.
17671 @node Extracting agenda information
17672 @section Extracting agenda information
17673 @cindex agenda, pipe
17674 @cindex Scripts, for agenda processing
17676 @vindex org-agenda-custom-commands
17677 Org provides commands to access agenda information for the command
17678 line in Emacs batch mode. This extracted information can be sent
17679 directly to a printer, or it can be read by a program that does further
17680 processing of the data. The first of these commands is the function
17681 @code{org-batch-agenda}, that produces an agenda view and sends it as
17682 ASCII text to STDOUT@. The command takes a single string as parameter.
17683 If the string has length 1, it is used as a key to one of the commands
17684 you have configured in @code{org-agenda-custom-commands}, basically any
17685 key you can use after @kbd{C-c a}. For example, to directly print the
17686 current TODO list, you could use
17689 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
17692 If the parameter is a string with 2 or more characters, it is used as a
17693 tags/TODO match string. For example, to print your local shopping list
17694 (all items with the tag @samp{shop}, but excluding the tag
17695 @samp{NewYork}), you could use
17698 emacs -batch -l ~/.emacs \
17699 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
17703 You may also modify parameters on the fly like this:
17706 emacs -batch -l ~/.emacs \
17707 -eval '(org-batch-agenda "a" \
17708 org-agenda-span (quote month) \
17709 org-agenda-include-diary nil \
17710 org-agenda-files (quote ("~/org/project.org")))' \
17715 which will produce a 30-day agenda, fully restricted to the Org file
17716 @file{~/org/projects.org}, not even including the diary.
17718 If you want to process the agenda data in more sophisticated ways, you
17719 can use the command @code{org-batch-agenda-csv} to get a comma-separated
17720 list of values for each agenda item. Each line in the output will
17721 contain a number of fields separated by commas. The fields in a line
17725 category @r{The category of the item}
17726 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
17727 type @r{The type of the agenda entry, can be}
17728 todo @r{selected in TODO match}
17729 tagsmatch @r{selected in tags match}
17730 diary @r{imported from diary}
17731 deadline @r{a deadline}
17732 scheduled @r{scheduled}
17733 timestamp @r{appointment, selected by timestamp}
17734 closed @r{entry was closed on date}
17735 upcoming-deadline @r{warning about nearing deadline}
17736 past-scheduled @r{forwarded scheduled item}
17737 block @r{entry has date block including date}
17738 todo @r{The TODO keyword, if any}
17739 tags @r{All tags including inherited ones, separated by colons}
17740 date @r{The relevant date, like 2007-2-14}
17741 time @r{The time, like 15:00-16:50}
17742 extra @r{String with extra planning info}
17743 priority-l @r{The priority letter if any was given}
17744 priority-n @r{The computed numerical priority}
17748 Time and date will only be given if a timestamp (or deadline/scheduled)
17749 led to the selection of the item.
17751 A CSV list like this is very easy to use in a post-processing script.
17752 For example, here is a Perl program that gets the TODO list from
17753 Emacs/Org and prints all the items, preceded by a checkbox:
17758 # define the Emacs command to run
17759 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
17761 # run it and capture the output
17762 $agenda = qx@{$cmd 2>/dev/null@};
17764 # loop over all lines
17765 foreach $line (split(/\n/,$agenda)) @{
17766 # get the individual values
17767 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
17768 $priority_l,$priority_n) = split(/,/,$line);
17769 # process and print
17770 print "[ ] $head\n";
17774 @node Using the property API
17775 @section Using the property API
17776 @cindex API, for properties
17777 @cindex properties, API
17779 Here is a description of the functions that can be used to work with
17782 @defun org-entry-properties &optional pom which
17783 Get all properties of the entry at point-or-marker POM.@*
17784 This includes the TODO keyword, the tags, time strings for deadline,
17785 scheduled, and clocking, and any additional properties defined in the
17786 entry. The return value is an alist. Keys may occur multiple times
17787 if the property key was used several times.@*
17788 POM may also be @code{nil}, in which case the current entry is used.
17789 If WHICH is @code{nil} or `all', get all properties. If WHICH is
17790 `special' or `standard', only get that subclass.
17792 @vindex org-use-property-inheritance
17793 @findex org-insert-property-drawer
17794 @defun org-entry-get pom property &optional inherit
17795 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
17796 this only looks at properties defined locally in the entry. If @code{INHERIT}
17797 is non-@code{nil} and the entry does not have the property, then also check
17798 higher levels of the hierarchy. If @code{INHERIT} is the symbol
17799 @code{selective}, use inheritance if and only if the setting of
17800 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
17803 @defun org-entry-delete pom property
17804 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
17807 @defun org-entry-put pom property value
17808 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
17811 @defun org-buffer-property-keys &optional include-specials
17812 Get all property keys in the current buffer.
17815 @defun org-insert-property-drawer
17816 Insert a property drawer for the current entry. Also
17819 @defun org-entry-put-multivalued-property pom property &rest values
17820 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
17821 @code{VALUES} should be a list of strings. They will be concatenated, with
17822 spaces as separators.
17825 @defun org-entry-get-multivalued-property pom property
17826 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17827 list of values and return the values as a list of strings.
17830 @defun org-entry-add-to-multivalued-property pom property value
17831 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17832 list of values and make sure that @code{VALUE} is in this list.
17835 @defun org-entry-remove-from-multivalued-property pom property value
17836 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17837 list of values and make sure that @code{VALUE} is @emph{not} in this list.
17840 @defun org-entry-member-in-multivalued-property pom property value
17841 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17842 list of values and check if @code{VALUE} is in this list.
17845 @defopt org-property-allowed-value-functions
17846 Hook for functions supplying allowed values for a specific property.
17847 The functions must take a single argument, the name of the property, and
17848 return a flat list of allowed values. If @samp{:ETC} is one of
17849 the values, use the values as completion help, but allow also other values
17850 to be entered. The functions must return @code{nil} if they are not
17851 responsible for this property.
17854 @node Using the mapping API
17855 @section Using the mapping API
17856 @cindex API, for mapping
17857 @cindex mapping entries, API
17859 Org has sophisticated mapping capabilities to find all entries satisfying
17860 certain criteria. Internally, this functionality is used to produce agenda
17861 views, but there is also an API that can be used to execute arbitrary
17862 functions for each or selected entries. The main entry point for this API
17865 @defun org-map-entries func &optional match scope &rest skip
17866 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
17868 @code{FUNC} is a function or a Lisp form. The function will be called
17869 without arguments, with the cursor positioned at the beginning of the
17870 headline. The return values of all calls to the function will be collected
17871 and returned as a list.
17873 The call to @code{FUNC} will be wrapped into a save-excursion form, so
17874 @code{FUNC} does not need to preserve point. After evaluation, the cursor
17875 will be moved to the end of the line (presumably of the headline of the
17876 processed entry) and search continues from there. Under some circumstances,
17877 this may not produce the wanted results. For example, if you have removed
17878 (e.g., archived) the current (sub)tree it could mean that the next entry will
17879 be skipped entirely. In such cases, you can specify the position from where
17880 search should continue by making @code{FUNC} set the variable
17881 @code{org-map-continue-from} to the desired buffer position.
17883 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
17884 view. Only headlines that are matched by this query will be considered
17885 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
17886 headlines will be visited by the iteration.
17888 @code{SCOPE} determines the scope of this command. It can be any of:
17891 nil @r{the current buffer, respecting the restriction if any}
17892 tree @r{the subtree started with the entry at point}
17893 region @r{The entries within the active region, if any}
17894 file @r{the current buffer, without restriction}
17896 @r{the current buffer, and any archives associated with it}
17897 agenda @r{all agenda files}
17898 agenda-with-archives
17899 @r{all agenda files with any archive files associated with them}
17901 @r{if this is a list, all files in the list will be scanned}
17904 The remaining args are treated as settings for the skipping facilities of
17905 the scanner. The following items can be given here:
17907 @vindex org-agenda-skip-function
17909 archive @r{skip trees with the archive tag}
17910 comment @r{skip trees with the COMMENT keyword}
17911 function or Lisp form
17912 @r{will be used as value for @code{org-agenda-skip-function},}
17913 @r{so whenever the function returns t, FUNC}
17914 @r{will not be called for that entry and search will}
17915 @r{continue from the point where the function leaves it}
17919 The function given to that mapping routine can really do anything you like.
17920 It can use the property API (@pxref{Using the property API}) to gather more
17921 information about the entry, or in order to change metadata in the entry.
17922 Here are a couple of functions that might be handy:
17924 @defun org-todo &optional arg
17925 Change the TODO state of the entry. See the docstring of the functions for
17926 the many possible values for the argument @code{ARG}.
17929 @defun org-priority &optional action
17930 Change the priority of the entry. See the docstring of this function for the
17931 possible values for @code{ACTION}.
17934 @defun org-toggle-tag tag &optional onoff
17935 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
17936 either @code{on} or @code{off} will not toggle tag, but ensure that it is
17941 Promote the current entry.
17945 Demote the current entry.
17948 Here is a simple example that will turn all entries in the current file with
17949 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
17950 Entries in comment trees and in archive trees will be ignored.
17954 '(org-todo "UPCOMING")
17955 "+TOMORROW" 'file 'archive 'comment)
17958 The following example counts the number of entries with TODO keyword
17959 @code{WAITING}, in all agenda files.
17962 (length (org-map-entries t "/+WAITING" 'agenda))
17966 @appendix MobileOrg
17970 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
17971 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
17972 capture support for an Org mode system rooted on a ``real'' computer. It
17973 also allows you to record changes to existing entries. The
17974 @uref{https://github.com/MobileOrg/, iOS implementation} for the
17975 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
17976 and is now in the hands Sean Escriva. Android users should check out
17977 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
17978 by Matt Jones. The two implementations are not identical but offer similar
17981 This appendix describes the support Org has for creating agenda views in a
17982 format that can be displayed by @i{MobileOrg}, and for integrating notes
17983 captured and changes made by @i{MobileOrg} into the main system.
17985 For changing tags and TODO states in MobileOrg, you should have set up the
17986 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
17987 cover all important tags and TODO keywords, even if individual files use only
17988 part of these. MobileOrg will also offer you states and tags set up with
17989 in-buffer settings, but it will understand the logistics of TODO state
17990 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
17991 (@pxref{Setting tags}) only for those set in these variables.
17994 * Setting up the staging area:: Where to interact with the mobile device
17995 * Pushing to MobileOrg:: Uploading Org files and agendas
17996 * Pulling from MobileOrg:: Integrating captured and flagged items
17999 @node Setting up the staging area
18000 @section Setting up the staging area
18002 MobileOrg needs to interact with Emacs through a directory on a server. If
18003 you are using a public server, you should consider encrypting the files that
18004 are uploaded to the server. This can be done with Org mode 7.02 and with
18005 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18006 installation on your system. To turn on encryption, set a password in
18007 @i{MobileOrg} and, on the Emacs side, configure the variable
18008 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18009 password in your Emacs setup, you might also want to configure
18010 @code{org-mobile-encryption-password}. Please read the docstring of that
18011 variable. Note that encryption will apply only to the contents of the
18012 @file{.org} files. The file names themselves will remain visible.}.
18014 The easiest way to create that directory is to use a free
18015 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18016 Dropbox, or if your version of MobileOrg does not support it, you can use a
18017 webdav server. For more information, check out the documentation of MobileOrg and also this
18018 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18019 When MobileOrg first connects to your Dropbox, it will create a directory
18020 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
18024 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18027 Org mode has commands to put files for @i{MobileOrg} into that directory,
18028 and to read captured notes from there.
18030 @node Pushing to MobileOrg
18031 @section Pushing to MobileOrg
18033 This operation copies all files currently listed in @code{org-mobile-files}
18034 to the directory @code{org-mobile-directory}. By default this list contains
18035 all agenda files (as listed in @code{org-agenda-files}), but additional files
18036 can be included by customizing @code{org-mobile-files}. File names will be
18037 staged with paths relative to @code{org-directory}, so all files should be
18038 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18039 have the same name as their targets.}.
18041 The push operation also creates a special Org file @file{agendas.org} with
18042 all custom agenda view defined by the user@footnote{While creating the
18043 agendas, Org mode will force ID properties on all referenced entries, so that
18044 these entries can be uniquely identified if @i{MobileOrg} flags them for
18045 further action. If you do not want to get these properties in so many
18046 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18047 to @code{nil}. Org mode will then rely on outline paths, in the hope that
18048 these will be unique enough.}.
18050 Finally, Org writes the file @file{index.org}, containing links to all other
18051 files. @i{MobileOrg} first reads this file from the server, and then
18052 downloads all agendas and Org files listed in it. To speed up the download,
18053 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18054 automatically in the file @file{checksums.dat}} have changed.
18056 @node Pulling from MobileOrg
18057 @section Pulling from MobileOrg
18059 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18060 files for viewing. It also appends captured entries and pointers to flagged
18061 and changed entries to the file @file{mobileorg.org} on the server. Org has
18062 a @emph{pull} operation that integrates this information into an inbox file
18063 and operates on the pointers to flagged entries. Here is how it works:
18067 Org moves all entries found in
18068 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18069 operation.} and appends them to the file pointed to by the variable
18070 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
18071 will be a top-level entry in the inbox file.
18073 After moving the entries, Org will attempt to implement the changes made in
18074 @i{MobileOrg}. Some changes are applied directly and without user
18075 interaction. Examples are all changes to tags, TODO state, headline and body
18076 text that can be cleanly applied. Entries that have been flagged for further
18077 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18078 again. When there is a problem finding an entry or applying the change, the
18079 pointer entry will remain in the inbox and will be marked with an error
18080 message. You need to later resolve these issues by hand.
18082 Org will then generate an agenda view with all flagged entries. The user
18083 should then go through these entries and do whatever actions are necessary.
18084 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18085 will be displayed in the echo area when the cursor is on the corresponding
18091 Pressing @kbd{?} in that special agenda will display the full flagging note in
18092 another window and also push it onto the kill ring. So you could use @kbd{?
18093 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18094 Pressing @kbd{?} twice in succession will offer to remove the
18095 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18096 in a property). In this way you indicate that the intended processing for
18097 this flagged entry is finished.
18102 If you are not able to process all flagged entries directly, you can always
18103 return to this agenda view@footnote{Note, however, that there is a subtle
18104 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
18105 is guaranteed to search all files that have been addressed by the last pull.
18106 This might include a file that is not currently in your list of agenda files.
18107 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18108 agenda files will be searched.} using @kbd{C-c a ?}.
18110 @node History and acknowledgments
18111 @appendix History and acknowledgments
18112 @cindex acknowledgments
18116 @section From Carsten
18118 Org was born in 2003, out of frustration over the user interface of the Emacs
18119 Outline mode. I was trying to organize my notes and projects, and using
18120 Emacs seemed to be the natural way to go. However, having to remember eleven
18121 different commands with two or three keys per command, only to hide and show
18122 parts of the outline tree, that seemed entirely unacceptable to me. Also,
18123 when using outlines to take notes, I constantly wanted to restructure the
18124 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
18125 cycling} and @emph{structure editing} were originally implemented in the
18126 package @file{outline-magic.el}, but quickly moved to the more general
18127 @file{org.el}. As this environment became comfortable for project planning,
18128 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
18129 @emph{table support}. These areas highlighted the two main goals that Org
18130 still has today: to be a new, outline-based, plain text mode with innovative
18131 and intuitive editing features, and to incorporate project planning
18132 functionality directly into a notes file.
18134 Since the first release, literally thousands of emails to me or to
18135 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
18136 reports, feedback, new ideas, and sometimes patches and add-on code.
18137 Many thanks to everyone who has helped to improve this package. I am
18138 trying to keep here a list of the people who had significant influence
18139 in shaping one or more aspects of Org. The list may not be
18140 complete, if I have forgotten someone, please accept my apologies and
18143 Before I get to this list, a few special mentions are in order:
18146 @item Bastien Guerry
18147 Bastien has written a large number of extensions to Org (most of them
18148 integrated into the core by now), including the @LaTeX{} exporter and the
18149 plain list parser. His support during the early days was central to the
18150 success of this project. Bastien also invented Worg, helped establishing the
18151 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
18152 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
18153 I desparately needed a break.
18154 @item Eric Schulte and Dan Davison
18155 Eric and Dan are jointly responsible for the Org-babel system, which turns
18156 Org into a multi-language environment for evaluating code and doing literate
18157 programming and reproducible research. This has become one of Org's killer
18158 features that define what Org is today.
18160 John has contributed a number of great ideas and patches directly to Org,
18161 including the attachment system (@file{org-attach.el}), integration with
18162 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
18163 items, habit tracking (@file{org-habits.el}), and encryption
18164 (@file{org-crypt.el}). Also, the capture system is really an extended copy
18165 of his great @file{remember.el}.
18166 @item Sebastian Rose
18167 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
18168 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
18169 higher level. He also wrote @file{org-info.js}, a Java script for displaying
18170 web pages derived from Org using an Info-like or a folding interface with
18171 single-key navigation.
18174 @noindent See below for the full list of contributions! Again, please
18175 let me know what I am missing here!
18177 @section From Bastien
18179 I (Bastien) have been maintaining Org between 2011 and 2013. This appendix
18180 would not be complete without adding a few more acknowledgements and thanks.
18182 I am first grateful to Carsten for his trust while handing me over the
18183 maintainership of Org. His unremitting support is what really helped me
18184 getting more confident over time, with both the community and the code.
18186 When I took over maintainership, I knew I would have to make Org more
18187 collaborative than ever, as I would have to rely on people that are more
18188 knowledgeable than I am on many parts of the code. Here is a list of the
18189 persons I could rely on, they should really be considered co-maintainers,
18190 either of the code or the community:
18194 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
18195 from worrying about possible bugs here and let me focus on other parts.
18197 @item Nicolas Goaziou
18198 Nicolas is maintaining the consistency of the deepest parts of Org. His work
18199 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
18200 the doors for many new ideas and features. He rewrote many of the old
18201 exporters to use the new export engine, and helped with documenting this
18202 major change. More importantly (if that's possible), he has been more than
18203 reliable during all the work done for Org 8.0, and always very reactive on
18207 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
18208 into a flexible and conceptually clean process. He patiently coped with the
18209 many hiccups that such a change can create for users.
18212 The Org mode mailing list would not be such a nice place without Nick, who
18213 patiently helped users so many times. It is impossible to overestimate such
18214 a great help, and the list would not be so active without him.
18217 I received support from so many users that it is clearly impossible to be
18218 fair when shortlisting a few of them, but Org's history would not be
18219 complete if the ones above were not mentioned in this manual.
18221 @section List of contributions
18226 @i{Russel Adams} came up with the idea for drawers.
18228 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
18229 feedback on many features and several patches.
18231 @i{Luis Anaya} wrote @file{ox-man.el}.
18233 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
18235 @i{Michael Brand} helped by reporting many bugs and testing many features.
18236 He also implemented the distinction between empty fields and 0-value fields
18237 in Org's spreadsheets.
18239 @i{Christophe Bataillon} created the great unicorn logo that we use on the
18242 @i{Alex Bochannek} provided a patch for rounding timestamps.
18244 @i{Jan Böcker} wrote @file{org-docview.el}.
18246 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
18248 @i{Tom Breton} wrote @file{org-choose.el}.
18250 @i{Charles Cave}'s suggestion sparked the implementation of templates
18251 for Remember, which are now templates for capture.
18253 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
18256 @i{Gregory Chernov} patched support for Lisp forms into table
18257 calculations and improved XEmacs compatibility, in particular by porting
18258 @file{nouline.el} to XEmacs.
18260 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
18261 make Org pupular through her blog.
18263 @i{Toby S. Cubitt} contributed to the code for clock formats.
18265 @i{Baoqiu Cui} contributed the first DocBook exporter. In Org 8.0, we go a
18266 different route: you can now export to Texinfo and export the @file{.texi}
18267 file to DocBook using @code{makeinfo}.
18269 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
18270 came up with the idea of properties, and that there should be an API for
18273 @i{Nick Dokos} tracked down several nasty bugs.
18275 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
18276 inspired some of the early development, including HTML export. He also
18277 asked for a way to narrow wide table columns.
18279 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
18280 several years now. He also sponsored the hosting costs until Rackspace
18281 started to host us for free.
18283 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
18284 the Org-Babel documentation into the manual.
18286 @i{Christian Egli} converted the documentation into Texinfo format, inspired
18287 the agenda, patched CSS formatting into the HTML exporter, and wrote
18288 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
18289 @file{ox-taskjuggler.el} for Org 8.0.
18291 @i{David Emery} provided a patch for custom CSS support in exported
18294 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
18296 @i{Nic Ferrier} contributed mailcap and XOXO support.
18298 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
18300 @i{John Foerch} figured out how to make incremental search show context
18301 around a match in a hidden outline tree.
18303 @i{Raimar Finken} wrote @file{org-git-line.el}.
18305 @i{Mikael Fornius} works as a mailing list moderator.
18307 @i{Austin Frank} works as a mailing list moderator.
18309 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18312 @i{Barry Gidden} did proofreading the manual in preparation for the book
18313 publication through Network Theory Ltd.
18315 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18317 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
18318 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18319 in implementing a clean framework for Org exporters.
18321 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18323 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18326 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18327 task state change logging, and the clocktable. His clear explanations have
18328 been critical when we started to adopt the Git version control system.
18330 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18333 @i{Phil Jackson} wrote @file{org-irc.el}.
18335 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18336 folded entries, and column view for properties.
18338 @i{Matt Jones} wrote @i{MobileOrg Android}.
18340 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18342 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18344 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
18345 provided frequent feedback and some patches.
18347 @i{Matt Lundin} has proposed last-row references for table formulas and named
18348 invisible anchors. He has also worked a lot on the FAQ.
18350 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18351 and is a prolific contributor on the mailing list with competent replies,
18352 small fixes and patches.
18354 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18356 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18358 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18361 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18364 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18366 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18367 and being able to quickly restrict the agenda to a subtree.
18369 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18371 @i{Greg Newman} refreshed the unicorn logo into its current form.
18373 @i{Tim O'Callaghan} suggested in-file links, search options for general
18374 file links, and TAGS.
18376 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18377 version of the reference card.
18379 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18382 @i{Oliver Oppitz} suggested multi-state TODO items.
18384 @i{Scott Otterson} sparked the introduction of descriptive text for
18385 links, among other things.
18387 @i{Pete Phillips} helped during the development of the TAGS feature, and
18388 provided frequent feedback.
18390 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18393 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18394 into bundles of 20 for undo.
18396 @i{Rackspace.com} is hosting our website for free. Thank you Rackspace!
18398 @i{T.V. Raman} reported bugs and suggested improvements.
18400 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18403 @i{Paul Rivier} provided the basic implementation of named footnotes. He
18404 also acted as mailing list moderator for some time.
18406 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18408 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18409 conflict with @file{allout.el}.
18411 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18414 @i{Philip Rooke} created the Org reference card, provided lots
18415 of feedback, developed and applied standards to the Org documentation.
18417 @i{Christian Schlauer} proposed angular brackets around links, among
18420 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18421 enjoy folding in non-org buffers by using Org headlines in comments.
18423 @i{Paul Sexton} wrote @file{org-ctags.el}.
18425 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18426 @file{organizer-mode.el}.
18428 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18429 examples, and remote highlighting for referenced code lines.
18431 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18432 now packaged into Org's @file{contrib} directory.
18434 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18437 @i{Dale Smith} proposed link abbreviations.
18439 @i{James TD Smith} has contributed a large number of patches for useful
18440 tweaks and features.
18442 @i{Adam Spiers} asked for global linking commands, inspired the link
18443 extension system, added support for mairix, and proposed the mapping API.
18445 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18446 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18448 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18449 with links transformation to Org syntax.
18451 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18452 chapter about publishing.
18454 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18456 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18457 enabled source code highlighting in Gnus.
18459 @i{Stefan Vollmar} organized a video-recorded talk at the
18460 Max-Planck-Institute for Neurology. He also inspired the creation of a
18461 concept index for HTML export.
18463 @i{J@"urgen Vollmer} contributed code generating the table of contents
18466 @i{Samuel Wales} has provided important feedback and bug reports.
18468 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18471 @i{David Wainberg} suggested archiving, and improvements to the linking
18474 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18477 @i{Roland Winkler} requested additional key bindings to make Org
18480 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18481 and contributed various ideas and code snippets.
18485 @node GNU Free Documentation License
18486 @appendix GNU Free Documentation License
18487 @include doclicense.texi
18491 @unnumbered Concept index
18496 @unnumbered Key index
18500 @node Command and Function Index
18501 @unnumbered Command and function index
18505 @node Variable Index
18506 @unnumbered Variable index
18508 This is not a complete index of variables and faces, only the ones that are
18509 mentioned in the manual. For a more complete list, use @kbd{M-x
18510 org-customize @key{RET}} and then click yourself through the tree.
18516 @c Local variables:
18518 @c indent-tabs-mode: nil
18519 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
18520 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
18524 @c LocalWords: webdavhost pre