3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Use proper quote and backtick for code sections in PDF output
9 @c Cf. Texinfo manual 14.2
10 @set txicodequoteundirected
11 @set txicodequotebacktick
13 @c Version and Contact Info
14 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
15 @set AUTHOR Carsten Dominik
16 @set MAINTAINER Carsten Dominik
17 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
18 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
23 @c -----------------------------------------------------------------------------
25 @c Macro definitions for commands and keys
26 @c =======================================
28 @c The behavior of the key/command macros will depend on the flag cmdnames
29 @c When set, commands names are shown. When clear, they are not shown.
33 @c Below we define the following macros for Org key tables:
35 @c orgkey{key} A key item
36 @c orgcmd{key,cmd} Key with command name
37 @c xorgcmd{key,cmd} Key with command name as @itemx
38 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
39 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
40 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
41 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
42 @c different functions, so format as @itemx
43 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
44 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
45 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
47 @c a key but no command
59 @c one key with a command
60 @c Inserts: @item KEY COMMAND
61 @macro orgcmd{key,command}
66 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
69 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
78 @c One key with one command, formatted using @itemx
79 @c Inserts: @itemx KEY COMMAND
80 @macro xorgcmd{key,command}
85 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
88 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
97 @c one key with a command, bit do not index the key
98 @c Inserts: @item KEY COMMAND
99 @macro orgcmdnki{key,command}
103 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
106 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
114 @c one key with a command, and special text to replace key in item
115 @c Inserts: @item TEXT COMMAND
116 @macro orgcmdtkc{text,key,command}
121 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
124 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
133 @c two keys with one command
134 @c Inserts: @item KEY1 or KEY2 COMMAND
135 @macro orgcmdkkc{key1,key2,command}
141 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
144 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
150 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
154 @c Two keys with one command name, but different functions, so format as
156 @c Inserts: @item KEY1
157 @c @itemx KEY2 COMMAND
158 @macro orgcmdkxkc{key1,key2,command}
165 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
169 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
180 @c Same as previous, but use "or short"
181 @c Inserts: @item KEY1 or short KEY2 COMMAND
182 @macro orgcmdkskc{key1,key2,command}
188 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
191 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
197 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
201 @c Same as previous, but use @itemx
202 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
203 @macro xorgcmdkskc{key1,key2,command}
209 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
212 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
218 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
222 @c two keys with two commands
223 @c Inserts: @item KEY1 COMMAND1
224 @c @itemx KEY2 COMMAND2
225 @macro orgcmdkkcc{key1,key2,command1,command2}
232 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
233 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
236 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
237 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
247 @c -----------------------------------------------------------------------------
250 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @c Subheadings inside a table.
254 @macro tsubheading{text}
256 @subsubheading \text\
264 This manual is for Org version @value{VERSION}.
266 Copyright @copyright{} 2004--2013 Free Software Foundation, Inc.
269 Permission is granted to copy, distribute and/or modify this document
270 under the terms of the GNU Free Documentation License, Version 1.3 or
271 any later version published by the Free Software Foundation; with no
272 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
273 and with the Back-Cover Texts as in (a) below. A copy of the license
274 is included in the section entitled ``GNU Free Documentation License.''
276 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
277 modify this GNU manual.''
281 @dircategory Emacs editing modes
283 * Org Mode: (org). Outline-based notes management and organizer
287 @title The Org Manual
289 @subtitle Release @value{VERSION}
290 @author by Carsten Dominik
291 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan
292 Davison, Eric Schulte, Thomas Dye, Jambunathan K and Nicolas Goaziou.
294 @c The following two commands start the copyright page.
296 @vskip 0pt plus 1filll
300 @c Output the table of contents at the beginning.
304 @c FIXME These hand-written next,prev,up node pointers make editing a lot
305 @c harder. There should be no need for them, makeinfo can do it
306 @c automatically for any document with a normal structure.
307 @node Top, Introduction, (dir), (dir)
314 * Introduction:: Getting started
315 * Document Structure:: A tree works like your brain
316 * Tables:: Pure magic for quick formatting
317 * Hyperlinks:: Notes in context
318 * TODO Items:: Every tree branch can be a TODO item
319 * Tags:: Tagging headlines and matching sets of tags
320 * Properties and Columns:: Storing information about an entry
321 * Dates and Times:: Making items useful for planning
322 * Capture - Refile - Archive:: The ins and outs for projects
323 * Agenda Views:: Collecting information into views
324 * Markup:: Prepare text for rich export
325 * Exporting:: Sharing and publishing notes
326 * Publishing:: Create a web site of linked Org files
327 * Working With Source Code:: Export, evaluate, and tangle code blocks
328 * Miscellaneous:: All the rest which did not fit elsewhere
329 * Hacking:: How to hack your way around
330 * MobileOrg:: Viewing and capture on a mobile device
331 * History and Acknowledgments:: How Org came into being
332 * GNU Free Documentation License:: The license for this documentation.
333 * Main Index:: An index of Org's concepts and features
334 * Key Index:: Key bindings and where they are described
335 * Command and Function Index:: Command names and some internal functions
336 * Variable Index:: Variables mentioned in the manual
339 --- The Detailed Node Listing ---
343 * Summary:: Brief summary of what Org does
344 * Installation:: Installing Org
345 * Activation:: How to activate Org for certain buffers
346 * Feedback:: Bug reports, ideas, patches etc.
347 * Conventions:: Typesetting conventions in the manual
351 * Outlines:: Org is based on Outline mode
352 * Headlines:: How to typeset Org tree headlines
353 * Visibility cycling:: Show and hide, much simplified
354 * Motion:: Jumping to other headlines
355 * Structure editing:: Changing sequence and level of headlines
356 * Sparse trees:: Matches embedded in context
357 * Plain lists:: Additional structure within an entry
358 * Drawers:: Tucking stuff away
359 * Blocks:: Folding blocks
360 * Footnotes:: How footnotes are defined in Org's syntax
361 * Orgstruct mode:: Structure editing outside Org
362 * Org syntax:: Formal description of Org's syntax
366 * Global and local cycling:: Cycling through various visibility states
367 * Initial visibility:: Setting the initial visibility state
368 * Catching invisible edits:: Preventing mistakes when editing invisible parts
370 Global and local cycling
372 * Initial visibility:: Setting the initial visibility state
373 * Catching invisible edits:: Preventing mistakes when editing invisible parts
377 * Built-in table editor:: Simple tables
378 * Column width and alignment:: Overrule the automatic settings
379 * Column groups:: Grouping to trigger vertical lines
380 * Orgtbl mode:: The table editor as minor mode
381 * The spreadsheet:: The table editor has spreadsheet capabilities
382 * Org-Plot:: Plotting from org tables
386 * References:: How to refer to another field or range
387 * Formula syntax for Calc:: Using Calc to compute stuff
388 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
389 * Durations and time values:: How to compute durations and time values
390 * Field and range formulas:: Formula for specific (ranges of) fields
391 * Column formulas:: Formulas valid for an entire column
392 * Lookup functions:: Lookup functions for searching tables
393 * Editing and debugging formulas:: Fixing formulas
394 * Updating the table:: Recomputing all dependent fields
395 * Advanced features:: Field and column names, parameters and automatic recalc
399 * Link format:: How links in Org are formatted
400 * Internal links:: Links to other places in the current file
401 * External links:: URL-like links to the world
402 * Handling links:: Creating, inserting and following
403 * Using links outside Org:: Linking from my C source code?
404 * Link abbreviations:: Shortcuts for writing complex links
405 * Search options:: Linking to a specific location
406 * Custom searches:: When the default search is not enough
410 * Radio targets:: Make targets trigger links in plain text
414 * TODO basics:: Marking and displaying TODO entries
415 * TODO extensions:: Workflow and assignments
416 * Progress logging:: Dates and notes for progress
417 * Priorities:: Some things are more important than others
418 * Breaking down tasks:: Splitting a task into manageable pieces
419 * Checkboxes:: Tick-off lists
421 Extended use of TODO keywords
423 * Workflow states:: From TODO to DONE in steps
424 * TODO types:: I do this, Fred does the rest
425 * Multiple sets in one file:: Mixing it all, and still finding your way
426 * Fast access to TODO states:: Single letter selection of a state
427 * Per-file keywords:: Different files, different requirements
428 * Faces for TODO keywords:: Highlighting states
429 * TODO dependencies:: When one task needs to wait for others
433 * Closing items:: When was this entry marked DONE?
434 * Tracking TODO state changes:: When did the status change?
435 * Tracking your habits:: How consistent have you been?
439 * Tag inheritance:: Tags use the tree structure of the outline
440 * Setting tags:: How to assign tags to a headline
441 * Tag groups:: Use one tag to search for several tags
442 * Tag searches:: Searching for combinations of tags
444 Properties and columns
446 * Property syntax:: How properties are spelled out
447 * Special properties:: Access to other Org mode features
448 * Property searches:: Matching property values
449 * Property inheritance:: Passing values down the tree
450 * Column view:: Tabular viewing and editing
451 * Property API:: Properties for Lisp programmers
455 * Defining columns:: The COLUMNS format property
456 * Using column view:: How to create and use column view
457 * Capturing column view:: A dynamic block for column view
461 * Scope of column definitions:: Where defined, where valid?
462 * Column attributes:: Appearance and content of a column
466 * Timestamps:: Assigning a time to a tree entry
467 * Creating timestamps:: Commands which insert timestamps
468 * Deadlines and scheduling:: Planning your work
469 * Clocking work time:: Tracking how long you spend on a task
470 * Effort estimates:: Planning work effort in advance
471 * Relative timer:: Notes with a running timer
472 * Countdown timer:: Starting a countdown timer for a task
476 * The date/time prompt:: How Org mode helps you entering date and time
477 * Custom time format:: Making dates look different
479 Deadlines and scheduling
481 * Inserting deadline/schedule:: Planning items
482 * Repeated tasks:: Items that show up again and again
486 * Clocking commands:: Starting and stopping a clock
487 * The clock table:: Detailed reports
488 * Resolving idle time:: Resolving time when you've been idle
490 Capture - Refile - Archive
492 * Capture:: Capturing new stuff
493 * Attachments:: Add files to tasks
494 * RSS Feeds:: Getting input from RSS feeds
495 * Protocols:: External (e.g., Browser) access to Emacs and Org
496 * Refile and copy:: Moving/copying a tree from one place to another
497 * Archiving:: What to do with finished projects
501 * Setting up capture:: Where notes will be stored
502 * Using capture:: Commands to invoke and terminate capture
503 * Capture templates:: Define the outline of different note types
507 * Template elements:: What is needed for a complete template entry
508 * Template expansion:: Filling in information about time and context
509 * Templates in contexts:: Only show a template in a specific context
513 * Moving subtrees:: Moving a tree to an archive file
514 * Internal archiving:: Switch off a tree but keep it in the file
518 * Agenda files:: Files being searched for agenda information
519 * Agenda dispatcher:: Keyboard access to agenda views
520 * Built-in agenda views:: What is available out of the box?
521 * Presentation and sorting:: How agenda items are prepared for display
522 * Agenda commands:: Remote editing of Org trees
523 * Custom agenda views:: Defining special searches and views
524 * Exporting Agenda Views:: Writing a view to a file
525 * Agenda column view:: Using column view for collected entries
527 The built-in agenda views
529 * Weekly/daily agenda:: The calendar page with current tasks
530 * Global TODO list:: All unfinished action items
531 * Matching tags and properties:: Structured information with fine-tuned search
532 * Timeline:: Time-sorted view for single file
533 * Search view:: Find entries by searching for text
534 * Stuck projects:: Find projects you need to review
536 Presentation and sorting
538 * Categories:: Not all tasks are equal
539 * Time-of-day specifications:: How the agenda knows the time
540 * Sorting agenda items:: The order of things
541 * Filtering/limiting agenda items:: Dynamically narrow the agenda
545 * Storing searches:: Type once, use often
546 * Block agenda:: All the stuff you need in a single buffer
547 * Setting Options:: Changing the rules
549 Markup for rich export
551 * Structural markup elements:: The basic structure as seen by the exporter
552 * Images and tables:: Images, tables and caption mechanism
553 * Literal examples:: Source code examples with special formatting
554 * Include files:: Include additional files into a document
555 * Index entries:: Making an index
556 * Macro replacement:: Use macros to create templates
557 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
558 * Special blocks:: Containers targeted at export back-ends
560 Structural markup elements
562 * Document title:: Where the title is taken from
563 * Headings and sections:: The document structure as seen by the exporter
564 * Table of contents:: The if and where of the table of contents
566 * Paragraphs:: Paragraphs
567 * Footnote markup:: Footnotes
568 * Emphasis and monospace:: Bold, italic, etc.
569 * Horizontal rules:: Make a line
570 * Comment lines:: What will *not* be exported
574 * Special symbols:: Greek letters and other symbols
575 * Subscripts and superscripts:: Simple syntax for raising/lowering text
576 * @LaTeX{} fragments:: Complex formulas made easy
577 * Previewing @LaTeX{} fragments:: What will this snippet look like?
578 * CDLaTeX mode:: Speed up entering of formulas
582 * The Export Dispatcher:: The main exporter interface
583 * Export back-ends:: Built-in export formats
584 * Export settings:: Generic export settings
585 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
586 * Beamer export:: Exporting as a Beamer presentation
587 * HTML export:: Exporting to HTML
588 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
589 * Markdown export:: Exporting to Markdown
590 * OpenDocument Text export:: Exporting to OpenDocument Text
591 * iCalendar export:: Exporting to iCalendar
592 * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org
593 * Export in foreign buffers:: Author tables in lists in Org syntax
594 * Advanced configuration:: Fine-tuning the export output
598 * HTML Export commands:: How to invoke HTML export
599 * HTML doctypes:: Org can export to various (X)HTML flavors
600 * HTML preamble and postamble:: How to insert a preamble and a postamble
601 * Quoting HTML tags:: Using direct HTML in Org mode
602 * Links in HTML export:: How links will be interpreted and formatted
603 * Tables in HTML export:: How to modify the formatting of tables
604 * Images in HTML export:: How to insert figures into HTML output
605 * Math formatting in HTML export:: Beautiful math also on the web
606 * Text areas in HTML export:: An alternative way to show an example
607 * CSS support:: Changing the appearance of the output
608 * JavaScript support:: Info and Folding in a web browser
610 @LaTeX{} and PDF export
612 * @LaTeX{} export commands:: How to export to LaTeX and PDF
613 * Header and sectioning:: Setting up the export file structure
614 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
615 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
617 OpenDocument Text export
619 * Pre-requisites for ODT export:: What packages ODT exporter relies on
620 * ODT export commands:: How to invoke ODT export
621 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
622 * Applying custom styles:: How to apply custom styles to the output
623 * Links in ODT export:: How links will be interpreted and formatted
624 * Tables in ODT export:: How Tables are exported
625 * Images in ODT export:: How to insert images
626 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
627 * Labels and captions in ODT export:: How captions are rendered
628 * Literal examples in ODT export:: How source and example blocks are formatted
629 * Advanced topics in ODT export:: Read this if you are a power user
631 Math formatting in ODT export
633 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
634 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
636 Advanced topics in ODT export
638 * Configuring a document converter:: How to register a document converter
639 * Working with OpenDocument style files:: Explore the internals
640 * Creating one-off styles:: How to produce custom highlighting etc
641 * Customizing tables in ODT export:: How to define and use Table templates
642 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
646 * Configuration:: Defining projects
647 * Uploading files:: How to get files up on the server
648 * Sample configuration:: Example projects
649 * Triggering publication:: Publication commands
653 * Project alist:: The central configuration variable
654 * Sources and destinations:: From here to there
655 * Selecting files:: What files are part of the project?
656 * Publishing action:: Setting the function doing the publishing
657 * Publishing options:: Tweaking HTML/@LaTeX{} export
658 * Publishing links:: Which links keep working after publishing?
659 * Sitemap:: Generating a list of all pages
660 * Generating an index:: An index that reaches across pages
664 * Simple example:: One-component publishing
665 * Complex example:: A multi-component publishing example
667 Working with source code
669 * Structure of code blocks:: Code block syntax described
670 * Editing source code:: Language major-mode editing
671 * Exporting code blocks:: Export contents and/or results
672 * Extracting source code:: Create pure source code files
673 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
674 * Library of Babel:: Use and contribute to a library of useful code blocks
675 * Languages:: List of supported code block languages
676 * Header arguments:: Configure code block functionality
677 * Results of evaluation:: How evaluation results are handled
678 * Noweb reference syntax:: Literate programming in Org mode
679 * Key bindings and useful functions:: Work quickly with code blocks
680 * Batch execution:: Call functions from the command line
684 * Using header arguments:: Different ways to set header arguments
685 * Specific header arguments:: List of header arguments
687 Using header arguments
689 * System-wide header arguments:: Set global default values
690 * Language-specific header arguments:: Set default values by language
691 * Buffer-wide header arguments:: Set default values for a specific buffer
692 * Header arguments in Org mode properties:: Set default values for a buffer or heading
693 * Code block specific header arguments:: The most common way to set values
694 * Header arguments in function calls:: The most specific level
696 Specific header arguments
698 * var:: Pass arguments to code blocks
699 * results:: Specify the type of results and how they will
700 be collected and handled
701 * file:: Specify a path for file output
702 * file-desc:: Specify a description for file results
703 * dir:: Specify the default (possibly remote)
704 directory for code block execution
705 * exports:: Export code and/or results
706 * tangle:: Toggle tangling and specify file name
707 * mkdirp:: Toggle creation of parent directories of target
708 files during tangling
709 * comments:: Toggle insertion of comments in tangled
711 * padline:: Control insertion of padding lines in tangled
713 * no-expand:: Turn off variable assignment and noweb
714 expansion during tangling
715 * session:: Preserve the state of code evaluation
716 * noweb:: Toggle expansion of noweb references
717 * noweb-ref:: Specify block's noweb reference resolution target
718 * noweb-sep:: String used to separate noweb references
719 * cache:: Avoid re-evaluating unchanged code blocks
720 * sep:: Delimiter for writing tabular results outside Org
721 * hlines:: Handle horizontal lines in tables
722 * colnames:: Handle column names in tables
723 * rownames:: Handle row names in tables
724 * shebang:: Make tangled files executable
725 * tangle-mode:: Set permission of tangled files
726 * eval:: Limit evaluation of specific code blocks
727 * wrap:: Mark source block evaluation results
728 * post:: Post processing of code block results
732 * Completion:: M-TAB knows what you need
733 * Easy Templates:: Quick insertion of structural elements
734 * Speed keys:: Electric commands at the beginning of a headline
735 * Code evaluation security:: Org mode files evaluate inline code
736 * Customization:: Adapting Org to your taste
737 * In-buffer settings:: Overview of the #+KEYWORDS
738 * The very busy C-c C-c key:: When in doubt, press C-c C-c
739 * Clean view:: Getting rid of leading stars in the outline
740 * TTY keys:: Using Org on a tty
741 * Interaction:: Other Emacs packages
742 * org-crypt.el:: Encrypting Org files
744 Interaction with other packages
746 * Cooperation:: Packages Org cooperates with
747 * Conflicts:: Packages that lead to conflicts
751 * Hooks:: How to reach into Org's internals
752 * Add-on packages:: Available extensions
753 * Adding hyperlink types:: New custom link types
754 * Adding export back-ends:: How to write new export back-ends
755 * Context-sensitive commands:: How to add functionality to such commands
756 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
757 * Dynamic blocks:: Automatically filled blocks
758 * Special agenda views:: Customized views
759 * Speeding up your agendas:: Tips on how to speed up your agendas
760 * Extracting agenda information:: Post-processing of agenda information
761 * Using the property API:: Writing programs that use entry properties
762 * Using the mapping API:: Mapping over all or selected entries
764 Tables and lists in arbitrary syntax
766 * Radio tables:: Sending and receiving radio tables
767 * A @LaTeX{} example:: Step by step, almost a tutorial
768 * Translator functions:: Copy and modify
769 * Radio lists:: Sending and receiving lists
773 * Setting up the staging area:: Where to interact with the mobile device
774 * Pushing to MobileOrg:: Uploading Org files and agendas
775 * Pulling from MobileOrg:: Integrating captured and flagged items
780 @node Introduction, Document Structure, Top, Top
781 @chapter Introduction
785 * Summary:: Brief summary of what Org does
786 * Installation:: Installing Org
787 * Activation:: How to activate Org for certain buffers
788 * Feedback:: Bug reports, ideas, patches etc.
789 * Conventions:: Typesetting conventions in the manual
792 @node Summary, Installation, Introduction, Introduction
796 Org is a mode for keeping notes, maintaining TODO lists, and doing
797 project planning with a fast and effective plain-text system.
799 Org develops organizational tasks around NOTES files that contain
800 lists or information about projects as plain text. Org is
801 implemented on top of Outline mode, which makes it possible to keep the
802 content of large files well structured. Visibility cycling and
803 structure editing help to work with the tree. Tables are easily created
804 with a built-in table editor. Org supports TODO items, deadlines,
805 timestamps, and scheduling. It dynamically compiles entries into an
806 agenda that utilizes and smoothly integrates much of the Emacs calendar
807 and diary. Plain text URL-like links connect to websites, emails,
808 Usenet messages, BBDB entries, and any files related to the projects.
809 For printing and sharing notes, an Org file can be exported as a
810 structured ASCII file, as HTML, or (TODO and agenda items only) as an
811 iCalendar file. It can also serve as a publishing tool for a set of
814 As a project planning environment, Org works by adding metadata to outline
815 nodes. Based on this data, specific entries can be extracted in queries and
816 create dynamic @i{agenda views}.
818 Org mode contains the Org Babel environment which allows you to work with
819 embedded source code blocks in a file, to facilitate code evaluation,
820 documentation, and literate programming techniques.
822 Org's automatic, context-sensitive table editor with spreadsheet
823 capabilities can be integrated into any major mode by activating the
824 minor Orgtbl mode. Using a translation step, it can be used to maintain
825 tables in arbitrary file types, for example in @LaTeX{}. The structure
826 editing and list creation capabilities can be used outside Org with
827 the minor Orgstruct mode.
829 Org keeps simple things simple. When first fired up, it should
830 feel like a straightforward, easy to use outliner. Complexity is not
831 imposed, but a large amount of functionality is available when you need
832 it. Org is a toolbox and can be used in different ways and for different
836 @r{@bullet{} an outline extension with visibility cycling and structure editing}
837 @r{@bullet{} an ASCII system and table editor for taking structured notes}
838 @r{@bullet{} a TODO list editor}
839 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
840 @pindex GTD, Getting Things Done
841 @r{@bullet{} an environment in which to implement David Allen's GTD system}
842 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
843 @r{@bullet{} a publishing tool to create a set of interlinked web pages}
844 @r{@bullet{} an environment for literate programming}
848 There is a website for Org which provides links to the newest
849 version of Org, as well as additional information, frequently asked
850 questions (FAQ), links to tutorials, etc. This page is located at
851 @uref{http://orgmode.org}.
853 @cindex print edition
854 The version 7.3 of this manual is available as a
855 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
861 @node Installation, Activation, Summary, Introduction
862 @section Installation
866 Org is part of recent distributions of GNU Emacs, so you normally don't need
867 to install it. If, for one reason or another, you want to install Org on top
868 of this pre-packaged version, there are three ways to do it:
871 @item By using Emacs package system.
872 @item By downloading Org as an archive.
873 @item By using Org's git repository.
876 We @b{strongly recommend} to stick to a single installation method.
878 @subsubheading Using Emacs packaging system
880 Recent Emacs distributions include a packaging system which lets you install
881 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
882 You need to do this in a session where no @code{.org} file has been visited.
883 Then, to make sure your Org configuration is taken into account, initialize
884 the package system with @code{(package-initialize)} in your @file{.emacs}
885 before setting any Org option. If you want to use Org's package repository,
886 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
888 @subsubheading Downloading Org as an archive
890 You can download Org latest release from @uref{http://orgmode.org/, Org's
891 website}. In this case, make sure you set the load-path correctly in your
895 (add-to-list 'load-path "~/path/to/orgdir/lisp")
898 The downloaded archive contains contributed libraries that are not included
899 in Emacs. If you want to use them, add the @file{contrib} directory to your
903 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
906 Optionally, you can compile the files and/or install them in your system.
907 Run @code{make help} to list compilation and installation options.
909 @subsubheading Using Org's git repository
911 You can clone Org's repository and install Org like this:
915 $ git clone git://orgmode.org/org-mode.git
919 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
920 version in @file{org-version.el} and Org's autoloads in
921 @file{org-loaddefs.el}.
923 Remember to add the correct load-path as described in the method above.
925 You can also compile with @code{make}, generate the documentation with
926 @code{make doc}, create a local configuration with @code{make config} and
927 install Org with @code{make install}. Please run @code{make help} to get
928 the list of compilation/installation options.
930 For more detailed explanations on Org's build system, please check the Org
931 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
934 @node Activation, Feedback, Installation, Introduction
939 @cindex global key bindings
940 @cindex key bindings, global
943 @findex org-store-link
946 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
947 default. If you are using an earlier version of Emacs, add this line to your
951 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
954 Org mode buffers need font-lock to be turned on: this is the default in
955 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
956 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
958 There are compatibility issues between Org mode and some other Elisp
959 packages, please take the time to check the list (@pxref{Conflicts}).
961 The four Org commands @command{org-store-link}, @command{org-capture},
962 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
963 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
964 suggested bindings for these keys, please modify the keys to your own
967 (global-set-key "\C-cl" 'org-store-link)
968 (global-set-key "\C-cc" 'org-capture)
969 (global-set-key "\C-ca" 'org-agenda)
970 (global-set-key "\C-cb" 'org-iswitchb)
973 @cindex Org mode, turning on
974 With this setup, all files with extension @samp{.org} will be put
975 into Org mode. As an alternative, make the first line of a file look
979 MY PROJECTS -*- mode: org; -*-
982 @vindex org-insert-mode-line-in-empty-file
983 @noindent which will select Org mode for this buffer no matter what
984 the file's name is. See also the variable
985 @code{org-insert-mode-line-in-empty-file}.
987 Many commands in Org work on the region if the region is @i{active}. To make
988 use of this, you need to have @code{transient-mark-mode}
989 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
990 in Emacs 22 you need to do this yourself with
992 (transient-mark-mode 1)
994 @noindent If you do not like @code{transient-mark-mode}, you can create an
995 active region by using the mouse to select a region, or pressing
996 @kbd{C-@key{SPC}} twice before moving the cursor.
998 @node Feedback, Conventions, Activation, Introduction
1005 If you find problems with Org, or if you have questions, remarks, or ideas
1006 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1007 If you are not a member of the mailing list, your mail will be passed to the
1008 list after a moderator has approved it@footnote{Please consider subscribing
1009 to the mailing list, in order to minimize the work the mailing list
1010 moderators have to do.}.
1012 For bug reports, please first try to reproduce the bug with the latest
1013 version of Org available---if you are running an outdated version, it is
1014 quite possible that the bug has been fixed already. If the bug persists,
1015 prepare a report and provide as much information as possible, including the
1016 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1017 (@kbd{M-x org-version RET}), as well as the Org related setup in
1018 @file{.emacs}. The easiest way to do this is to use the command
1020 @kbd{M-x org-submit-bug-report RET}
1022 @noindent which will put all this information into an Emacs mail buffer so
1023 that you only need to add your description. If you re not sending the Email
1024 from within Emacs, please copy and paste the content into your Email program.
1026 Sometimes you might face a problem due to an error in your Emacs or Org mode
1027 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1028 customizations and reproduce the problem. Doing so often helps you determine
1029 if the problem is with your customization or with Org mode itself. You can
1030 start a typical minimal session with a command like the example below.
1033 $ emacs -Q -l /path/to/minimal-org.el
1036 However if you are using Org mode as distributed with Emacs, a minimal setup
1037 is not necessary. In that case it is sufficient to start Emacs as
1038 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1042 ;;; Minimal setup to load latest `org-mode'
1044 ;; activate debugging
1045 (setq debug-on-error t
1049 ;; add latest org-mode to load path
1050 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1051 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1054 If an error occurs, a backtrace can be very useful (see below on how to
1055 create one). Often a small example file helps, along with clear information
1059 @item What exactly did you do?
1060 @item What did you expect to happen?
1061 @item What happened instead?
1063 @noindent Thank you for helping to improve this program.
1065 @subsubheading How to create a useful backtrace
1067 @cindex backtrace of an error
1068 If working with Org produces an error with a message you don't
1069 understand, you may have hit a bug. The best way to report this is by
1070 providing, in addition to what was mentioned above, a @emph{backtrace}.
1071 This is information from the built-in debugger about where and how the
1072 error occurred. Here is how to produce a useful backtrace:
1076 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1077 contains much more information if it is produced with uncompiled code.
1080 @kbd{C-u M-x org-reload RET}
1083 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1086 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1087 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1089 Do whatever you have to do to hit the error. Don't forget to
1090 document the steps you take.
1092 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1093 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1094 attach it to your bug report.
1097 @node Conventions, , Feedback, Introduction
1098 @section Typesetting conventions used in this manual
1100 @subsubheading TODO keywords, tags, properties, etc.
1102 Org mainly uses three types of keywords: TODO keywords, tags and property
1103 names. In this manual we use the following conventions:
1108 TODO keywords are written with all capitals, even if they are
1112 User-defined tags are written in lowercase; built-in tags with special
1113 meaning are written with all capitals.
1116 User-defined properties are capitalized; built-in properties with
1117 special meaning are written with all capitals.
1120 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1121 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1122 environment). They are written in uppercase in the manual to enhance its
1123 readability, but you can use lowercase in your Org files@footnote{Easy
1124 templates insert lowercase keywords and Babel dynamically inserts
1127 @subsubheading Keybindings and commands
1133 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1134 and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the
1135 rest of the manual assumes that you are using these keybindings.
1137 Also, the manual lists both the keys and the corresponding commands for
1138 accessing a functionality. Org mode often uses the same key for different
1139 functions, depending on context. The command that is bound to such keys has
1140 a generic name, like @code{org-metaright}. In the manual we will, wherever
1141 possible, give the function that is internally called by the generic command.
1142 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1143 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1144 will be listed to call @code{org-table-move-column-right}. If you prefer,
1145 you can compile the manual without the command names by unsetting the flag
1146 @code{cmdnames} in @file{org.texi}.
1148 @node Document Structure, Tables, Introduction, Top
1149 @chapter Document structure
1150 @cindex document structure
1151 @cindex structure of document
1153 Org is based on Outline mode and provides flexible commands to
1154 edit the structure of the document.
1157 * Outlines:: Org is based on Outline mode
1158 * Headlines:: How to typeset Org tree headlines
1159 * Visibility cycling:: Show and hide, much simplified
1160 * Motion:: Jumping to other headlines
1161 * Structure editing:: Changing sequence and level of headlines
1162 * Sparse trees:: Matches embedded in context
1163 * Plain lists:: Additional structure within an entry
1164 * Drawers:: Tucking stuff away
1165 * Blocks:: Folding blocks
1166 * Footnotes:: How footnotes are defined in Org's syntax
1167 * Orgstruct mode:: Structure editing outside Org
1168 * Org syntax:: Formal description of Org's syntax
1171 @node Outlines, Headlines, Document Structure, Document Structure
1174 @cindex Outline mode
1176 Org is implemented on top of Outline mode. Outlines allow a
1177 document to be organized in a hierarchical structure, which (at least
1178 for me) is the best representation of notes and thoughts. An overview
1179 of this structure is achieved by folding (hiding) large parts of the
1180 document to show only the general document structure and the parts
1181 currently being worked on. Org greatly simplifies the use of
1182 outlines by compressing the entire show/hide functionality into a single
1183 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1185 @node Headlines, Visibility cycling, Outlines, Document Structure
1188 @cindex outline tree
1189 @vindex org-special-ctrl-a/e
1190 @vindex org-special-ctrl-k
1191 @vindex org-ctrl-k-protect-subtree
1193 Headlines define the structure of an outline tree. The headlines in Org
1194 start with one or more stars, on the left margin@footnote{See the variables
1195 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1196 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1197 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1198 headings indented less then 30 stars.}. For example:
1201 * Top level headline
1208 * Another top level headline
1211 @noindent Some people find the many stars too noisy and would prefer an
1212 outline that has whitespace followed by a single star as headline
1213 starters. @ref{Clean view}, describes a setup to realize this.
1215 @vindex org-cycle-separator-lines
1216 An empty line after the end of a subtree is considered part of it and
1217 will be hidden when the subtree is folded. However, if you leave at
1218 least two empty lines, one empty line will remain visible after folding
1219 the subtree, in order to structure the collapsed view. See the
1220 variable @code{org-cycle-separator-lines} to modify this behavior.
1222 @node Visibility cycling, Motion, Headlines, Document Structure
1223 @section Visibility cycling
1224 @cindex cycling, visibility
1225 @cindex visibility cycling
1226 @cindex trees, visibility
1227 @cindex show hidden text
1231 * Global and local cycling:: Cycling through various visibility states
1232 * Initial visibility:: Setting the initial visibility state
1233 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1236 @node Global and local cycling, Initial visibility, Visibility cycling, Visibility cycling
1237 @subsection Global and local cycling
1239 Outlines make it possible to hide parts of the text in the buffer.
1240 Org uses just two commands, bound to @key{TAB} and
1241 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1243 @cindex subtree visibility states
1244 @cindex subtree cycling
1245 @cindex folded, subtree visibility state
1246 @cindex children, subtree visibility state
1247 @cindex subtree, subtree visibility state
1249 @orgcmd{@key{TAB},org-cycle}
1250 @emph{Subtree cycling}: Rotate current subtree among the states
1253 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1254 '-----------------------------------'
1257 @vindex org-cycle-emulate-tab
1258 @vindex org-cycle-global-at-bob
1259 The cursor must be on a headline for this to work@footnote{see, however,
1260 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1261 beginning of the buffer and the first line is not a headline, then
1262 @key{TAB} actually runs global cycling (see below)@footnote{see the
1263 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1264 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1266 @cindex global visibility states
1267 @cindex global cycling
1268 @cindex overview, global visibility state
1269 @cindex contents, global visibility state
1270 @cindex show all, global visibility state
1271 @orgcmd{S-@key{TAB},org-global-cycle}
1272 @itemx C-u @key{TAB}
1273 @emph{Global cycling}: Rotate the entire buffer among the states
1276 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1277 '--------------------------------------'
1280 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1281 CONTENTS view up to headlines of level N will be shown. Note that inside
1282 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1284 @cindex show all, command
1285 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1286 Show all, including drawers.
1287 @cindex revealing context
1288 @orgcmd{C-c C-r,org-reveal}
1289 Reveal context around point, showing the current entry, the following heading
1290 and the hierarchy above. Useful for working near a location that has been
1291 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1292 (@pxref{Agenda commands}). With a prefix argument show, on each
1293 level, all sibling headings. With a double prefix argument, also show the
1294 entire subtree of the parent.
1295 @cindex show branches, command
1296 @orgcmd{C-c C-k,show-branches}
1297 Expose all the headings of the subtree, CONTENT view for just one subtree.
1298 @cindex show children, command
1299 @orgcmd{C-c @key{TAB},show-children}
1300 Expose all direct children of the subtree. With a numeric prefix argument N,
1301 expose all children down to level N@.
1302 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1303 Show the current subtree in an indirect buffer@footnote{The indirect
1306 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1309 (see the Emacs manual for more information about indirect buffers)
1311 will contain the entire buffer, but will be narrowed to the current
1312 tree. Editing the indirect buffer will also change the original buffer,
1313 but without affecting visibility in that buffer.}. With a numeric
1314 prefix argument N, go up to level N and then take that tree. If N is
1315 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1316 the previously used indirect buffer.
1317 @orgcmd{C-c C-x v,org-copy-visible}
1318 Copy the @i{visible} text in the region into the kill ring.
1322 * Initial visibility:: Setting the initial visibility state
1323 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1326 @node Initial visibility, Catching invisible edits, Global and local cycling, Visibility cycling
1327 @subsection Initial visibility
1329 @cindex visibility, initialize
1330 @vindex org-startup-folded
1331 @vindex org-agenda-inhibit-startup
1332 @cindex @code{overview}, STARTUP keyword
1333 @cindex @code{content}, STARTUP keyword
1334 @cindex @code{showall}, STARTUP keyword
1335 @cindex @code{showeverything}, STARTUP keyword
1337 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1338 i.e., only the top level headlines are visible@footnote{When
1339 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1340 visibility state when first opening a file for the agenda (@pxref{Speeding up
1341 your agendas}).} This can be configured through the variable
1342 @code{org-startup-folded}, or on a per-file basis by adding one of the
1343 following lines anywhere in the buffer:
1349 #+STARTUP: showeverything
1352 The startup visibility options are ignored when the file is open for the
1353 first time during the agenda generation: if you want the agenda to honor
1354 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1356 @cindex property, VISIBILITY
1358 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1359 and Columns}) will get their visibility adapted accordingly. Allowed values
1360 for this property are @code{folded}, @code{children}, @code{content}, and
1364 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1365 Switch back to the startup visibility of the buffer, i.e., whatever is
1366 requested by startup options and @samp{VISIBILITY} properties in individual
1370 @node Catching invisible edits, , Initial visibility, Visibility cycling
1371 @subsection Catching invisible edits
1373 @vindex org-catch-invisible-edits
1374 @cindex edits, catching invisible
1375 Sometimes you may inadvertently edit an invisible part of the buffer and be
1376 confused on what as been edited and how to undo the mistake. Setting
1377 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
1378 docstring of this option on how Org should catch invisible edits and process
1381 @node Motion, Structure editing, Visibility cycling, Document Structure
1383 @cindex motion, between headlines
1384 @cindex jumping, to headlines
1385 @cindex headline navigation
1386 The following commands jump to other headlines in the buffer.
1389 @orgcmd{C-c C-n,outline-next-visible-heading}
1391 @orgcmd{C-c C-p,outline-previous-visible-heading}
1393 @orgcmd{C-c C-f,org-forward-same-level}
1394 Next heading same level.
1395 @orgcmd{C-c C-b,org-backward-same-level}
1396 Previous heading same level.
1397 @orgcmd{C-c C-u,outline-up-heading}
1398 Backward to higher level heading.
1399 @orgcmd{C-c C-j,org-goto}
1400 Jump to a different place without changing the current outline
1401 visibility. Shows the document structure in a temporary buffer, where
1402 you can use the following keys to find your destination:
1403 @vindex org-goto-auto-isearch
1405 @key{TAB} @r{Cycle visibility.}
1406 @key{down} / @key{up} @r{Next/previous visible headline.}
1407 @key{RET} @r{Select this location.}
1408 @kbd{/} @r{Do a Sparse-tree search}
1409 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1410 n / p @r{Next/previous visible headline.}
1411 f / b @r{Next/previous headline same level.}
1413 0-9 @r{Digit argument.}
1416 @vindex org-goto-interface
1418 See also the option @code{org-goto-interface}.
1421 @node Structure editing, Sparse trees, Motion, Document Structure
1422 @section Structure editing
1423 @cindex structure editing
1424 @cindex headline, promotion and demotion
1425 @cindex promotion, of subtrees
1426 @cindex demotion, of subtrees
1427 @cindex subtree, cut and paste
1428 @cindex pasting, of subtrees
1429 @cindex cutting, of subtrees
1430 @cindex copying, of subtrees
1431 @cindex sorting, of subtrees
1432 @cindex subtrees, cut and paste
1435 @orgcmd{M-@key{RET},org-insert-heading}
1436 @vindex org-M-RET-may-split-line
1437 Insert a new heading/item with the same level than the one at point.
1438 If the cursor is in a plain list item, a new item is created
1439 (@pxref{Plain lists}). To prevent this behavior in lists, call the
1440 command with a prefix argument. When this command is used in the
1441 middle of a line, the line is split and the rest of the line becomes
1442 the new item or headline@footnote{If you do not want the line to be
1443 split, customize the variable @code{org-M-RET-may-split-line}.}. If
1444 the command is used at the @emph{beginning} of a headline, the new
1445 headline is created before the current line. If the command is used
1446 at the @emph{end} of a folded subtree (i.e., behind the ellipses at
1447 the end of a headline), then a headline will be
1448 inserted after the end of the subtree. Calling this command with
1449 @kbd{C-u C-u} will unconditionally respect the headline's content and
1450 create a new item at the end of the parent subtree.
1451 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1452 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1453 current heading, the new heading is placed after the body instead of before
1454 it. This command works from anywhere in the entry.
1455 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1456 @vindex org-treat-insert-todo-heading-as-state-change
1457 Insert new TODO entry with same level as current heading. See also the
1458 variable @code{org-treat-insert-todo-heading-as-state-change}.
1459 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1460 Insert new TODO entry with same level as current heading. Like
1461 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1463 @orgcmd{@key{TAB},org-cycle}
1464 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1465 become a child of the previous one. The next @key{TAB} makes it a parent,
1466 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1467 to the initial level.
1468 @orgcmd{M-@key{left},org-do-promote}
1469 Promote current heading by one level.
1470 @orgcmd{M-@key{right},org-do-demote}
1471 Demote current heading by one level.
1472 @orgcmd{M-S-@key{left},org-promote-subtree}
1473 Promote the current subtree by one level.
1474 @orgcmd{M-S-@key{right},org-demote-subtree}
1475 Demote the current subtree by one level.
1476 @orgcmd{M-S-@key{up},org-move-subtree-up}
1477 Move subtree up (swap with previous subtree of same
1479 @orgcmd{M-S-@key{down},org-move-subtree-down}
1480 Move subtree down (swap with next subtree of same level).
1481 @orgcmd{M-h,org-mark-element}
1482 Mark the element at point. Hitting repeatedly will mark subsequent elements
1483 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1484 hitting @key{M-h} immediately again will mark the next one.
1485 @orgcmd{C-c @@,org-mark-subtree}
1486 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1487 of the same level than the marked subtree.
1488 @orgcmd{C-c C-x C-w,org-cut-subtree}
1489 Kill subtree, i.e., remove it from buffer but save in kill ring.
1490 With a numeric prefix argument N, kill N sequential subtrees.
1491 @orgcmd{C-c C-x M-w,org-copy-subtree}
1492 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1493 sequential subtrees.
1494 @orgcmd{C-c C-x C-y,org-paste-subtree}
1495 Yank subtree from kill ring. This does modify the level of the subtree to
1496 make sure the tree fits in nicely at the yank position. The yank level can
1497 also be specified with a numeric prefix argument, or by yanking after a
1498 headline marker like @samp{****}.
1499 @orgcmd{C-y,org-yank}
1500 @vindex org-yank-adjusted-subtrees
1501 @vindex org-yank-folded-subtrees
1502 Depending on the options @code{org-yank-adjusted-subtrees} and
1503 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1504 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1505 C-x C-y}. With the default settings, no level adjustment will take place,
1506 but the yanked tree will be folded unless doing so would swallow text
1507 previously visible. Any prefix argument to this command will force a normal
1508 @code{yank} to be executed, with the prefix passed along. A good way to
1509 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1510 yank, it will yank previous kill items plainly, without adjustment and
1512 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1513 Clone a subtree by making a number of sibling copies of it. You will be
1514 prompted for the number of copies to make, and you can also specify if any
1515 timestamps in the entry should be shifted. This can be useful, for example,
1516 to create a number of tasks related to a series of lectures to prepare. For
1517 more details, see the docstring of the command
1518 @code{org-clone-subtree-with-time-shift}.
1519 @orgcmd{C-c C-w,org-refile}
1520 Refile entry or region to a different location. @xref{Refile and copy}.
1521 @orgcmd{C-c ^,org-sort}
1522 Sort same-level entries. When there is an active region, all entries in the
1523 region will be sorted. Otherwise the children of the current headline are
1524 sorted. The command prompts for the sorting method, which can be
1525 alphabetically, numerically, by time (first timestamp with active preferred,
1526 creation time, scheduled time, deadline time), by priority, by TODO keyword
1527 (in the sequence the keywords have been defined in the setup) or by the value
1528 of a property. Reverse sorting is possible as well. You can also supply
1529 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1530 sorting will be case-sensitive.
1531 @orgcmd{C-x n s,org-narrow-to-subtree}
1532 Narrow buffer to current subtree.
1533 @orgcmd{C-x n b,org-narrow-to-block}
1534 Narrow buffer to current block.
1535 @orgcmd{C-x n w,widen}
1536 Widen buffer to remove narrowing.
1537 @orgcmd{C-c *,org-toggle-heading}
1538 Turn a normal line or plain list item into a headline (so that it becomes a
1539 subheading at its location). Also turn a headline into a normal line by
1540 removing the stars. If there is an active region, turn all lines in the
1541 region into headlines. If the first line in the region was an item, turn
1542 only the item lines into headlines. Finally, if the first line is a
1543 headline, remove the stars from all headlines in the region.
1546 @cindex region, active
1547 @cindex active region
1548 @cindex transient mark mode
1549 When there is an active region (Transient Mark mode), promotion and
1550 demotion work on all headlines in the region. To select a region of
1551 headlines, it is best to place both point and mark at the beginning of a
1552 line, mark at the beginning of the first headline, and point at the line
1553 just after the last headline to change. Note that when the cursor is
1554 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1558 @node Sparse trees, Plain lists, Structure editing, Document Structure
1559 @section Sparse trees
1560 @cindex sparse trees
1561 @cindex trees, sparse
1562 @cindex folding, sparse trees
1563 @cindex occur, command
1565 @vindex org-show-hierarchy-above
1566 @vindex org-show-following-heading
1567 @vindex org-show-siblings
1568 @vindex org-show-entry-below
1569 An important feature of Org mode is the ability to construct @emph{sparse
1570 trees} for selected information in an outline tree, so that the entire
1571 document is folded as much as possible, but the selected information is made
1572 visible along with the headline structure above it@footnote{See also the
1573 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1574 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1575 control on how much context is shown around each match.}. Just try it out
1576 and you will see immediately how it works.
1578 Org mode contains several commands creating such trees, all these
1579 commands can be accessed through a dispatcher:
1582 @orgcmd{C-c /,org-sparse-tree}
1583 This prompts for an extra key to select a sparse-tree creating command.
1584 @orgcmd{C-c / r,org-occur}
1585 @vindex org-remove-highlights-with-change
1586 Prompts for a regexp and shows a sparse tree with all matches. If
1587 the match is in a headline, the headline is made visible. If the match is in
1588 the body of an entry, headline and body are made visible. In order to
1589 provide minimal context, also the full hierarchy of headlines above the match
1590 is shown, as well as the headline following the match. Each match is also
1591 highlighted; the highlights disappear when the buffer is changed by an
1592 editing command@footnote{This depends on the option
1593 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1594 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1595 so several calls to this command can be stacked.
1596 @orgcmdkkc{M-g n,M-g M-n,next-error}
1597 Jump to the next sparse tree match in this buffer.
1598 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1599 Jump to the previous sparse tree match in this buffer.
1604 @vindex org-agenda-custom-commands
1605 For frequently used sparse trees of specific search strings, you can
1606 use the option @code{org-agenda-custom-commands} to define fast
1607 keyboard access to specific sparse trees. These commands will then be
1608 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1612 (setq org-agenda-custom-commands
1613 '(("f" occur-tree "FIXME")))
1616 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1617 a sparse tree matching the string @samp{FIXME}.
1619 The other sparse tree commands select headings based on TODO keywords,
1620 tags, or properties and will be discussed later in this manual.
1623 @cindex printing sparse trees
1624 @cindex visible text, printing
1625 To print a sparse tree, you can use the Emacs command
1626 @code{ps-print-buffer-with-faces} which does not print invisible parts
1627 of the document @footnote{This does not work under XEmacs, because
1628 XEmacs uses selective display for outlining, not text properties.}.
1629 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1630 the document and print the resulting file.
1632 @node Plain lists, Drawers, Sparse trees, Document Structure
1633 @section Plain lists
1635 @cindex lists, plain
1636 @cindex lists, ordered
1637 @cindex ordered lists
1639 Within an entry of the outline tree, hand-formatted lists can provide
1640 additional structure. They also provide a way to create lists of checkboxes
1641 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1642 (@pxref{Exporting}) can parse and format them.
1644 Org knows ordered lists, unordered lists, and description lists.
1647 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1648 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1649 they will be seen as top-level headlines. Also, when you are hiding leading
1650 stars to get a clean outline view, plain list items starting with a star may
1651 be hard to distinguish from true headlines. In short: even though @samp{*}
1652 is supported, it may be better to not use it for plain list items.} as
1655 @vindex org-plain-list-ordered-item-terminator
1656 @vindex org-list-allow-alphabetical
1657 @emph{Ordered} list items start with a numeral followed by either a period or
1658 a right parenthesis@footnote{You can filter out any of them by configuring
1659 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1660 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1661 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1662 confusion with normal text, those are limited to one character only. Beyond
1663 that limit, bullets will automatically fallback to numbers.}. If you want a
1664 list to start with a different value (e.g., 20), start the text of the item
1665 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1666 must be put @emph{before} the checkbox. If you have activated alphabetical
1667 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1668 be used in any item of the list in order to enforce a particular numbering.
1670 @emph{Description} list items are unordered list items, and contain the
1671 separator @samp{ :: } to distinguish the description @emph{term} from the
1675 Items belonging to the same list must have the same indentation on the first
1676 line. In particular, if an ordered list reaches number @samp{10.}, then the
1677 2--digit numbers must be written left-aligned with the other numbers in the
1678 list. An item ends before the next line that is less or equally indented
1679 than its bullet/number.
1681 @vindex org-list-empty-line-terminates-plain-lists
1682 A list ends whenever every item has ended, which means before any line less
1683 or equally indented than items at top level. It also ends before two blank
1684 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1685 In that case, all items are closed. Here is an example:
1689 ** Lord of the Rings
1690 My favorite scenes are (in this order)
1691 1. The attack of the Rohirrim
1692 2. Eowyn's fight with the witch king
1693 + this was already my favorite scene in the book
1694 + I really like Miranda Otto.
1695 3. Peter Jackson being shot by Legolas
1697 He makes a really funny face when it happens.
1698 But in the end, no individual scenes matter but the film as a whole.
1699 Important actors in this film are:
1700 - @b{Elijah Wood} :: He plays Frodo
1701 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1702 him very well from his role as Mikey Walsh in @i{The Goonies}.
1706 Org supports these lists by tuning filling and wrapping commands to deal with
1707 them correctly@footnote{Org only changes the filling settings for Emacs. For
1708 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1709 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1710 properly (@pxref{Exporting}). Since indentation is what governs the
1711 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1712 blocks can be indented to signal that they belong to a particular item.
1714 @vindex org-list-demote-modify-bullet
1715 @vindex org-list-indent-offset
1716 If you find that using a different bullet for a sub-list (than that used for
1717 the current list-level) improves readability, customize the variable
1718 @code{org-list-demote-modify-bullet}. To get a greater difference of
1719 indentation between items and theirs sub-items, customize
1720 @code{org-list-indent-offset}.
1722 @vindex org-list-automatic-rules
1723 The following commands act on items when the cursor is in the first line of
1724 an item (the line with the bullet or number). Some of them imply the
1725 application of automatic rules to keep list structure intact. If some of
1726 these actions get in your way, configure @code{org-list-automatic-rules}
1727 to disable them individually.
1730 @orgcmd{@key{TAB},org-cycle}
1731 @cindex cycling, in plain lists
1732 @vindex org-cycle-include-plain-lists
1733 Items can be folded just like headline levels. Normally this works only if
1734 the cursor is on a plain list item. For more details, see the variable
1735 @code{org-cycle-include-plain-lists}. If this variable is set to
1736 @code{integrate}, plain list items will be treated like low-level
1737 headlines. The level of an item is then given by the indentation of the
1738 bullet/number. Items are always subordinate to real headlines, however; the
1739 hierarchies remain completely separated. In a new item with no text yet, the
1740 first @key{TAB} demotes the item to become a child of the previous
1741 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1742 and eventually get it back to its initial position.
1743 @orgcmd{M-@key{RET},org-insert-heading}
1744 @vindex org-M-RET-may-split-line
1745 @vindex org-list-automatic-rules
1746 Insert new item at current level. With a prefix argument, force a new
1747 heading (@pxref{Structure editing}). If this command is used in the middle
1748 of an item, that item is @emph{split} in two, and the second part becomes the
1749 new item@footnote{If you do not want the item to be split, customize the
1750 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1751 @emph{before item's body}, the new item is created @emph{before} the current
1756 @kindex M-S-@key{RET}
1758 Insert a new item with a checkbox (@pxref{Checkboxes}).
1759 @kindex S-@key{down}
1762 @cindex shift-selection-mode
1763 @vindex org-support-shift-select
1764 @vindex org-list-use-circular-motion
1765 Jump to the previous/next item in the current list@footnote{If you want to
1766 cycle around items that way, you may customize
1767 @code{org-list-use-circular-motion}.}, but only if
1768 @code{org-support-shift-select} is off. If not, you can still use paragraph
1769 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1772 @kindex M-@key{down}
1775 Move the item including subitems up/down@footnote{See
1776 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1777 previous/next item of same indentation). If the list is ordered, renumbering
1779 @kindex M-@key{left}
1780 @kindex M-@key{right}
1783 Decrease/increase the indentation of an item, leaving children alone.
1784 @kindex M-S-@key{left}
1785 @kindex M-S-@key{right}
1788 Decrease/increase the indentation of the item, including subitems.
1789 Initially, the item tree is selected based on current indentation. When
1790 these commands are executed several times in direct succession, the initially
1791 selected region is used, even if the new indentation would imply a different
1792 hierarchy. To use the new hierarchy, break the command chain with a cursor
1795 As a special case, using this command on the very first item of a list will
1796 move the whole list. This behavior can be disabled by configuring
1797 @code{org-list-automatic-rules}. The global indentation of a list has no
1798 influence on the text @emph{after} the list.
1801 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1802 state of the checkbox. In any case, verify bullets and indentation
1803 consistency in the whole list.
1805 @vindex org-plain-list-ordered-item-terminator
1807 Cycle the entire list level through the different itemize/enumerate bullets
1808 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1809 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1810 and its indentation. With a numeric prefix argument N, select the Nth bullet
1811 from this list. If there is an active region when calling this, selected
1812 text will be changed into an item. With a prefix argument, all lines will be
1813 converted to list items. If the first line already was a list item, any item
1814 marker will be removed from the list. Finally, even without an active
1815 region, a normal line will be converted into a list item.
1818 Turn a plain list item into a headline (so that it becomes a subheading at
1819 its location). @xref{Structure editing}, for a detailed explanation.
1822 Turn the whole plain list into a subtree of the current heading. Checkboxes
1823 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1825 @kindex S-@key{left}
1826 @kindex S-@key{right}
1828 @vindex org-support-shift-select
1829 This command also cycles bullet styles when the cursor in on the bullet or
1830 anywhere in an item line, details depending on
1831 @code{org-support-shift-select}.
1834 Sort the plain list. You will be prompted for the sorting method:
1835 numerically, alphabetically, by time, or by custom function.
1838 @node Drawers, Blocks, Plain lists, Document Structure
1842 @cindex visibility cycling, drawers
1845 @cindex org-insert-drawer
1847 Sometimes you want to keep information associated with an entry, but you
1848 normally don't want to see it. For this, Org mode has @emph{drawers}.
1849 Drawers need to be configured with the option @code{org-drawers}@footnote{You
1850 can define additional drawers on a per-file basis with a line like
1851 @code{#+DRAWERS: HIDDEN STATE}}. Drawers look like this:
1854 ** This is a headline
1855 Still outside the drawer
1857 This is inside the drawer.
1862 You can interactively insert drawers at point by calling
1863 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1864 region, this command will put the region inside the drawer. With a prefix
1865 argument, this command calls @code{org-insert-property-drawer} and add a
1866 property drawer right below the current headline. Completion over drawer
1867 keywords is also possible using @key{M-TAB}.
1869 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1870 show the entry, but keep the drawer collapsed to a single line. In order to
1871 look inside the drawer, you need to move the cursor to the drawer line and
1872 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1873 storing properties (@pxref{Properties and Columns}), and you can also arrange
1874 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1875 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1876 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1881 Add a time-stamped note to the LOGBOOK drawer.
1884 @vindex org-export-with-drawers
1885 You can select the name of the drawers which should be exported with
1886 @code{org-export-with-drawers}. In that case, drawer contents will appear in
1887 export output. Property drawers are not affected by this variable and are
1890 @node Blocks, Footnotes, Drawers, Document Structure
1893 @vindex org-hide-block-startup
1894 @cindex blocks, folding
1895 Org mode uses begin...end blocks for various purposes from including source
1896 code examples (@pxref{Literal examples}) to capturing time logging
1897 information (@pxref{Clocking work time}). These blocks can be folded and
1898 unfolded by pressing TAB in the begin line. You can also get all blocks
1899 folded at startup by configuring the option @code{org-hide-block-startup}
1900 or on a per-file basis by using
1902 @cindex @code{hideblocks}, STARTUP keyword
1903 @cindex @code{nohideblocks}, STARTUP keyword
1905 #+STARTUP: hideblocks
1906 #+STARTUP: nohideblocks
1909 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1913 Org mode supports the creation of footnotes. In contrast to the
1914 @file{footnote.el} package, Org mode's footnotes are designed for work on
1915 a larger document, not only for one-off documents like emails.
1917 A footnote is started by a footnote marker in square brackets in column 0, no
1918 indentation allowed. It ends at the next footnote definition, headline, or
1919 after two consecutive empty lines. The footnote reference is simply the
1920 marker in square brackets, inside text. For example:
1923 The Org homepage[fn:1] now looks a lot better than it used to.
1925 [fn:1] The link is: http://orgmode.org
1928 Org mode extends the number-based syntax to @emph{named} footnotes and
1929 optional inline definition. Using plain numbers as markers (as
1930 @file{footnote.el} does) is supported for backward compatibility, but not
1931 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1932 @LaTeX{}}). Here are the valid references:
1936 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1937 recommended because something like @samp{[1]} could easily be part of a code
1940 A named footnote reference, where @code{name} is a unique label word, or, for
1941 simplicity of automatic creation, a number.
1942 @item [fn:: This is the inline definition of this footnote]
1943 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1945 @item [fn:name: a definition]
1946 An inline definition of a footnote, which also specifies a name for the note.
1947 Since Org allows multiple references to the same note, you can then use
1948 @code{[fn:name]} to create additional references.
1951 @vindex org-footnote-auto-label
1952 Footnote labels can be created automatically, or you can create names yourself.
1953 This is handled by the variable @code{org-footnote-auto-label} and its
1954 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1957 @noindent The following command handles footnotes:
1962 The footnote action command.
1964 When the cursor is on a footnote reference, jump to the definition. When it
1965 is at a definition, jump to the (first) reference.
1967 @vindex org-footnote-define-inline
1968 @vindex org-footnote-section
1969 @vindex org-footnote-auto-adjust
1970 Otherwise, create a new footnote. Depending on the option
1971 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1972 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1973 definition will be placed right into the text as part of the reference, or
1974 separately into the location determined by the option
1975 @code{org-footnote-section}.
1977 When this command is called with a prefix argument, a menu of additional
1980 s @r{Sort the footnote definitions by reference sequence. During editing,}
1981 @r{Org makes no effort to sort footnote definitions into a particular}
1982 @r{sequence. If you want them sorted, use this command, which will}
1983 @r{also move entries according to @code{org-footnote-section}. Automatic}
1984 @r{sorting after each insertion/deletion can be configured using the}
1985 @r{option @code{org-footnote-auto-adjust}.}
1986 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1987 @r{after each insertion/deletion can be configured using the option}
1988 @r{@code{org-footnote-auto-adjust}.}
1989 S @r{Short for first @code{r}, then @code{s} action.}
1990 n @r{Normalize the footnotes by collecting all definitions (including}
1991 @r{inline definitions) into a special section, and then numbering them}
1992 @r{in sequence. The references will then also be numbers. This is}
1993 @r{meant to be the final step before finishing a document (e.g., sending}
1995 d @r{Delete the footnote at point, and all definitions of and references}
1998 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1999 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
2000 renumbering and sorting footnotes can be automatic after each insertion or
2005 If the cursor is on a footnote reference, jump to the definition. If it is a
2006 the definition, jump back to the reference. When called at a footnote
2007 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2011 @item C-c C-o @r{or} mouse-1/2
2012 Footnote labels are also links to the corresponding definition/reference, and
2013 you can use the usual commands to follow these links.
2016 @node Orgstruct mode, Org syntax, Footnotes, Document Structure
2017 @section The Orgstruct minor mode
2018 @cindex Orgstruct mode
2019 @cindex minor mode for structure editing
2021 If you like the intuitive way the Org mode structure editing and list
2022 formatting works, you might want to use these commands in other modes like
2023 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2024 this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2025 turn it on by default, for example in Message mode, with one of:
2028 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2029 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2032 When this mode is active and the cursor is on a line that looks to Org like a
2033 headline or the first line of a list item, most structure editing commands
2034 will work, even if the same keys normally have different functionality in the
2035 major mode you are using. If the cursor is not in one of those special
2036 lines, Orgstruct mode lurks silently in the shadows.
2038 When you use @code{orgstruct++-mode}, Org will also export indentation and
2039 autofill settings into that mode, and detect item context after the first
2042 @vindex orgstruct-heading-prefix-regexp
2043 You can also use Org structure editing to fold and unfold headlines in
2044 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2045 the regular expression must match the local prefix to use before Org's
2046 headlines. For example, if you set this variable to @code{";; "} in Emacs
2047 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2048 commented lines. Some commands like @code{org-demote} are disabled when the
2049 prefix is set, but folding/unfolding will work correctly.
2051 @node Org syntax, , Orgstruct mode, Document Structure
2055 A reference document providing a formal description of Org's syntax is
2056 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2057 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2058 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2059 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2060 file falls into one of the categories above.
2062 To explore the abstract structure of an Org buffer, run this in a buffer:
2065 M-: (org-element-parse-buffer) RET
2068 It will output a list containing the buffer's content represented as an
2069 abstract structure. The export engine relies on the information stored in
2070 this list. Most interactive commands (e.g., for structure editing) also
2071 rely on the syntactic meaning of the surrounding context.
2073 @node Tables, Hyperlinks, Document Structure, Top
2076 @cindex editing tables
2078 Org comes with a fast and intuitive table editor. Spreadsheet-like
2079 calculations are supported using the Emacs @file{calc} package
2080 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2083 * Built-in table editor:: Simple tables
2084 * Column width and alignment:: Overrule the automatic settings
2085 * Column groups:: Grouping to trigger vertical lines
2086 * Orgtbl mode:: The table editor as minor mode
2087 * The spreadsheet:: The table editor has spreadsheet capabilities
2088 * Org-Plot:: Plotting from org tables
2091 @node Built-in table editor, Column width and alignment, Tables, Tables
2092 @section The built-in table editor
2093 @cindex table editor, built-in
2095 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2096 the first non-whitespace character is considered part of a table. @samp{|}
2097 is also the column separator@footnote{To insert a vertical bar into a table
2098 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2099 might look like this:
2102 | Name | Phone | Age |
2103 |-------+-------+-----|
2104 | Peter | 1234 | 17 |
2105 | Anna | 4321 | 25 |
2108 A table is re-aligned automatically each time you press @key{TAB} or
2109 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2110 the next field (@key{RET} to the next row) and creates new table rows
2111 at the end of the table or before horizontal lines. The indentation
2112 of the table is set by the first line. Any line starting with
2113 @samp{|-} is considered as a horizontal separator line and will be
2114 expanded on the next re-align to span the whole table width. So, to
2115 create the above table, you would only type
2122 @noindent and then press @key{TAB} to align the table and start filling in
2123 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2124 @kbd{C-c @key{RET}}.
2126 @vindex org-enable-table-editor
2127 @vindex org-table-auto-blank-field
2128 When typing text into a field, Org treats @key{DEL},
2129 @key{Backspace}, and all character keys in a special way, so that
2130 inserting and deleting avoids shifting other fields. Also, when
2131 typing @emph{immediately after the cursor was moved into a new field
2132 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2133 field is automatically made blank. If this behavior is too
2134 unpredictable for you, configure the options
2135 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2138 @tsubheading{Creation and conversion}
2139 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2140 Convert the active region to table. If every line contains at least one
2141 TAB character, the function assumes that the material is tab separated.
2142 If every line contains a comma, comma-separated values (CSV) are assumed.
2143 If not, lines are split at whitespace into fields. You can use a prefix
2144 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2145 C-u} forces TAB, and a numeric argument N indicates that at least N
2146 consecutive spaces, or alternatively a TAB will be the separator.
2148 If there is no active region, this command creates an empty Org
2149 table. But it is easier just to start typing, like
2150 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2152 @tsubheading{Re-aligning and field motion}
2153 @orgcmd{C-c C-c,org-table-align}
2154 Re-align the table and don't move to another field.
2156 @orgcmd{<TAB>,org-table-next-field}
2157 Re-align the table, move to the next field. Creates a new row if
2160 @orgcmd{S-@key{TAB},org-table-previous-field}
2161 Re-align, move to previous field.
2163 @orgcmd{@key{RET},org-table-next-row}
2164 Re-align the table and move down to next row. Creates a new row if
2165 necessary. At the beginning or end of a line, @key{RET} still does
2166 NEWLINE, so it can be used to split a table.
2168 @orgcmd{M-a,org-table-beginning-of-field}
2169 Move to beginning of the current table field, or on to the previous field.
2170 @orgcmd{M-e,org-table-end-of-field}
2171 Move to end of the current table field, or on to the next field.
2173 @tsubheading{Column and row editing}
2174 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2175 Move the current column left/right.
2177 @orgcmd{M-S-@key{left},org-table-delete-column}
2178 Kill the current column.
2180 @orgcmd{M-S-@key{right},org-table-insert-column}
2181 Insert a new column to the left of the cursor position.
2183 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2184 Move the current row up/down.
2186 @orgcmd{M-S-@key{up},org-table-kill-row}
2187 Kill the current row or horizontal line.
2189 @orgcmd{M-S-@key{down},org-table-insert-row}
2190 Insert a new row above the current row. With a prefix argument, the line is
2191 created below the current one.
2193 @orgcmd{C-c -,org-table-insert-hline}
2194 Insert a horizontal line below current row. With a prefix argument, the line
2195 is created above the current line.
2197 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2198 Insert a horizontal line below current row, and move the cursor into the row
2201 @orgcmd{C-c ^,org-table-sort-lines}
2202 Sort the table lines in the region. The position of point indicates the
2203 column to be used for sorting, and the range of lines is the range
2204 between the nearest horizontal separator lines, or the entire table. If
2205 point is before the first column, you will be prompted for the sorting
2206 column. If there is an active region, the mark specifies the first line
2207 and the sorting column, while point should be in the last line to be
2208 included into the sorting. The command prompts for the sorting type
2209 (alphabetically, numerically, or by time). When called with a prefix
2210 argument, alphabetic sorting will be case-sensitive.
2212 @tsubheading{Regions}
2213 @orgcmd{C-c C-x M-w,org-table-copy-region}
2214 Copy a rectangular region from a table to a special clipboard. Point and
2215 mark determine edge fields of the rectangle. If there is no active region,
2216 copy just the current field. The process ignores horizontal separator lines.
2218 @orgcmd{C-c C-x C-w,org-table-cut-region}
2219 Copy a rectangular region from a table to a special clipboard, and
2220 blank all fields in the rectangle. So this is the ``cut'' operation.
2222 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2223 Paste a rectangular region into a table.
2224 The upper left corner ends up in the current field. All involved fields
2225 will be overwritten. If the rectangle does not fit into the present table,
2226 the table is enlarged as needed. The process ignores horizontal separator
2229 @orgcmd{M-@key{RET},org-table-wrap-region}
2230 Split the current field at the cursor position and move the rest to the line
2231 below. If there is an active region, and both point and mark are in the same
2232 column, the text in the column is wrapped to minimum width for the given
2233 number of lines. A numeric prefix argument may be used to change the number
2234 of desired lines. If there is no region, but you specify a prefix argument,
2235 the current field is made blank, and the content is appended to the field
2238 @tsubheading{Calculations}
2239 @cindex formula, in tables
2240 @cindex calculations, in tables
2241 @cindex region, active
2242 @cindex active region
2243 @cindex transient mark mode
2244 @orgcmd{C-c +,org-table-sum}
2245 Sum the numbers in the current column, or in the rectangle defined by
2246 the active region. The result is shown in the echo area and can
2247 be inserted with @kbd{C-y}.
2249 @orgcmd{S-@key{RET},org-table-copy-down}
2250 @vindex org-table-copy-increment
2251 When current field is empty, copy from first non-empty field above. When not
2252 empty, copy current field down to next row and move cursor along with it.
2253 Depending on the option @code{org-table-copy-increment}, integer field
2254 values will be incremented during copy. Integers that are too large will not
2255 be incremented. Also, a @code{0} prefix argument temporarily disables the
2256 increment. This key is also used by shift-selection and related modes
2257 (@pxref{Conflicts}).
2259 @tsubheading{Miscellaneous}
2260 @orgcmd{C-c `,org-table-edit-field}
2261 Edit the current field in a separate window. This is useful for fields that
2262 are not fully visible (@pxref{Column width and alignment}). When called with
2263 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2264 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2265 window follow the cursor through the table and always show the current
2266 field. The follow mode exits automatically when the cursor leaves the table,
2267 or when you repeat this command with @kbd{C-u C-u C-c `}.
2269 @item M-x org-table-import RET
2270 Import a file as a table. The table should be TAB or whitespace
2271 separated. Use, for example, to import a spreadsheet table or data
2272 from a database, because these programs generally can write
2273 TAB-separated text files. This command works by inserting the file into
2274 the buffer and then converting the region to a table. Any prefix
2275 argument is passed on to the converter, which uses it to determine the
2277 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2278 Tables can also be imported by pasting tabular text into the Org
2279 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2280 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2282 @item M-x org-table-export RET
2283 @findex org-table-export
2284 @vindex org-table-export-default-format
2285 Export the table, by default as a TAB-separated file. Use for data
2286 exchange with, for example, spreadsheet or database programs. The format
2287 used to export the file can be configured in the option
2288 @code{org-table-export-default-format}. You may also use properties
2289 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2290 name and the format for table export in a subtree. Org supports quite
2291 general formats for exported tables. The exporter format is the same as the
2292 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2293 detailed description.
2296 If you don't like the automatic table editor because it gets in your
2297 way on lines which you would like to start with @samp{|}, you can turn
2301 (setq org-enable-table-editor nil)
2304 @noindent Then the only table command that still works is
2305 @kbd{C-c C-c} to do a manual re-align.
2307 @node Column width and alignment, Column groups, Built-in table editor, Tables
2308 @section Column width and alignment
2309 @cindex narrow columns in tables
2310 @cindex alignment in tables
2312 The width of columns is automatically determined by the table editor. And
2313 also the alignment of a column is determined automatically from the fraction
2314 of number-like versus non-number fields in the column.
2316 Sometimes a single field or a few fields need to carry more text, leading to
2317 inconveniently wide columns. Or maybe you want to make a table with several
2318 columns having a fixed width, regardless of content. To set@footnote{This
2319 feature does not work on XEmacs.} the width of a column, one field anywhere
2320 in the column may contain just the string @samp{<N>} where @samp{N} is an
2321 integer specifying the width of the column in characters. The next re-align
2322 will then set the width of this column to this value.
2326 |---+------------------------------| |---+--------|
2328 | 1 | one | | 1 | one |
2329 | 2 | two | ----\ | 2 | two |
2330 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2331 | 4 | four | | 4 | four |
2332 |---+------------------------------| |---+--------|
2337 Fields that are wider become clipped and end in the string @samp{=>}.
2338 Note that the full text is still in the buffer but is hidden.
2339 To see the full text, hold the mouse over the field---a tool-tip window
2340 will show the full content. To edit such a field, use the command
2341 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2342 open a new window with the full field. Edit it and finish with @kbd{C-c
2345 @vindex org-startup-align-all-tables
2346 When visiting a file containing a table with narrowed columns, the
2347 necessary character hiding has not yet happened, and the table needs to
2348 be aligned before it looks nice. Setting the option
2349 @code{org-startup-align-all-tables} will realign all tables in a file
2350 upon visiting, but also slow down startup. You can also set this option
2351 on a per-file basis with:
2358 If you would like to overrule the automatic alignment of number-rich columns
2359 to the right and of string-rich column to the left, you can use @samp{<r>},
2360 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2361 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2362 also combine alignment and field width like this: @samp{<r10>}.
2364 Lines which only contain these formatting cookies will be removed
2365 automatically when exporting the document.
2367 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2368 @section Column groups
2369 @cindex grouping columns in tables
2371 When Org exports tables, it does so by default without vertical
2372 lines because that is visually more satisfying in general. Occasionally
2373 however, vertical lines can be useful to structure a table into groups
2374 of columns, much like horizontal lines can do for groups of rows. In
2375 order to specify column groups, you can use a special row where the
2376 first field contains only @samp{/}. The further fields can either
2377 contain @samp{<} to indicate that this column should start a group,
2378 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2379 and @samp{>}) to make a column
2380 a group of its own. Boundaries between column groups will upon export be
2381 marked with vertical lines. Here is an example:
2384 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2385 |---+-----+-----+-----+---------+------------|
2386 | / | < | | > | < | > |
2387 | 1 | 1 | 1 | 1 | 1 | 1 |
2388 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2389 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2390 |---+-----+-----+-----+---------+------------|
2391 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2394 It is also sufficient to just insert the column group starters after
2395 every vertical line you would like to have:
2398 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2399 |----+-----+-----+-----+---------+------------|
2403 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2404 @section The Orgtbl minor mode
2406 @cindex minor mode for tables
2408 If you like the intuitive way the Org table editor works, you
2409 might also want to use it in other modes like Text mode or Mail mode.
2410 The minor mode Orgtbl mode makes this possible. You can always toggle
2411 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2412 example in Message mode, use
2415 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2418 Furthermore, with some special setup, it is possible to maintain tables
2419 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2420 construct @LaTeX{} tables with the underlying ease and power of
2421 Orgtbl mode, including spreadsheet capabilities. For details, see
2422 @ref{Tables in arbitrary syntax}.
2424 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2425 @section The spreadsheet
2426 @cindex calculations, in tables
2427 @cindex spreadsheet capabilities
2428 @cindex @file{calc} package
2430 The table editor makes use of the Emacs @file{calc} package to implement
2431 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2432 derive fields from other fields. While fully featured, Org's implementation
2433 is not identical to other spreadsheets. For example, Org knows the concept
2434 of a @emph{column formula} that will be applied to all non-header fields in a
2435 column without having to copy the formula to each relevant field. There is
2436 also a formula debugger, and a formula editor with features for highlighting
2437 fields in the table corresponding to the references at the point in the
2438 formula, moving these references by arrow keys
2441 * References:: How to refer to another field or range
2442 * Formula syntax for Calc:: Using Calc to compute stuff
2443 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2444 * Durations and time values:: How to compute durations and time values
2445 * Field and range formulas:: Formula for specific (ranges of) fields
2446 * Column formulas:: Formulas valid for an entire column
2447 * Lookup functions:: Lookup functions for searching tables
2448 * Editing and debugging formulas:: Fixing formulas
2449 * Updating the table:: Recomputing all dependent fields
2450 * Advanced features:: Field and column names, parameters and automatic recalc
2453 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2454 @subsection References
2457 To compute fields in the table from other fields, formulas must
2458 reference other fields or ranges. In Org, fields can be referenced
2459 by name, by absolute coordinates, and by relative coordinates. To find
2460 out what the coordinates of a field are, press @kbd{C-c ?} in that
2461 field, or press @kbd{C-c @}} to toggle the display of a grid.
2463 @subsubheading Field references
2464 @cindex field references
2465 @cindex references, to fields
2467 Formulas can reference the value of another field in two ways. Like in
2468 any other spreadsheet, you may reference fields with a letter/number
2469 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2470 @vindex org-table-use-standard-references
2471 However, Org prefers@footnote{Org will understand references typed by the
2472 user as @samp{B4}, but it will not use this syntax when offering a formula
2473 for editing. You can customize this behavior using the option
2474 @code{org-table-use-standard-references}.} to use another, more general
2475 representation that looks like this:
2477 @@@var{row}$@var{column}
2480 Column specifications can be absolute like @code{$1},
2481 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2482 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2483 @code{$<} and @code{$>} are immutable references to the first and last
2484 column, respectively, and you can use @code{$>>>} to indicate the third
2485 column from the right.
2487 The row specification only counts data lines and ignores horizontal separator
2488 lines (hlines). Like with columns, you can use absolute row numbers
2489 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2490 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2491 immutable references the first and last@footnote{For backward compatibility
2492 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2493 a stable way to the 5th and 12th field in the last row of the table.
2494 However, this syntax is deprecated, it should not be used for new documents.
2495 Use @code{@@>$} instead.} row in the table, respectively. You may also
2496 specify the row relative to one of the hlines: @code{@@I} refers to the first
2497 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2498 line above the current line, @code{@@+I} to the first such line below the
2499 current line. You can also write @code{@@III+2} which is the second data line
2500 after the third hline in the table.
2502 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2503 i.e., to the row/column for the field being computed. Also, if you omit
2504 either the column or the row part of the reference, the current row/column is
2507 Org's references with @emph{unsigned} numbers are fixed references
2508 in the sense that if you use the same reference in the formula for two
2509 different fields, the same field will be referenced each time.
2510 Org's references with @emph{signed} numbers are floating
2511 references because the same reference operator can reference different
2512 fields depending on the field being calculated by the formula.
2514 Here are a few examples:
2517 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2518 $5 @r{column 5 in the current row (same as @code{E&})}
2519 @@2 @r{current column, row 2}
2520 @@-1$-3 @r{the field one row up, three columns to the left}
2521 @@-I$2 @r{field just under hline above current row, column 2}
2522 @@>$5 @r{field in the last row, in column 5}
2525 @subsubheading Range references
2526 @cindex range references
2527 @cindex references, to ranges
2529 You may reference a rectangular range of fields by specifying two field
2530 references connected by two dots @samp{..}. If both fields are in the
2531 current row, you may simply use @samp{$2..$7}, but if at least one field
2532 is in a different row, you need to use the general @code{@@row$column}
2533 format at least for the first field (i.e the reference must start with
2534 @samp{@@} in order to be interpreted correctly). Examples:
2537 $1..$3 @r{first three fields in the current row}
2538 $P..$Q @r{range, using column names (see under Advanced)}
2539 $<<<..$>> @r{start in third column, continue to the one but last}
2540 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2541 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2542 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2545 @noindent Range references return a vector of values that can be fed
2546 into Calc vector functions. Empty fields in ranges are normally suppressed,
2547 so that the vector contains only the non-empty fields. For other options
2548 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2551 @subsubheading Field coordinates in formulas
2552 @cindex field coordinates
2553 @cindex coordinates, of field
2554 @cindex row, of field coordinates
2555 @cindex column, of field coordinates
2557 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2558 get the row or column number of the field where the formula result goes.
2559 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2560 and @code{org-table-current-column}. Examples:
2563 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2564 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2565 @r{column 3 of the current table}
2568 @noindent For the second example, table FOO must have at least as many rows
2569 as the current table. Note that this is inefficient@footnote{The computation time scales as
2570 O(N^2) because table FOO is parsed for each field to be copied.} for large
2573 @subsubheading Named references
2574 @cindex named references
2575 @cindex references, named
2576 @cindex name, of column or field
2577 @cindex constants, in calculations
2580 @vindex org-table-formula-constants
2581 @samp{$name} is interpreted as the name of a column, parameter or
2582 constant. Constants are defined globally through the option
2583 @code{org-table-formula-constants}, and locally (for the file) through a
2587 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2591 @vindex constants-unit-system
2592 @pindex constants.el
2593 Also properties (@pxref{Properties and Columns}) can be used as
2594 constants in table formulas: for a property @samp{:Xyz:} use the name
2595 @samp{$PROP_Xyz}, and the property will be searched in the current
2596 outline entry and in the hierarchy above it. If you have the
2597 @file{constants.el} package, it will also be used to resolve constants,
2598 including natural constants like @samp{$h} for Planck's constant, and
2599 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2600 supply the values of constants in two different unit systems, @code{SI}
2601 and @code{cgs}. Which one is used depends on the value of the variable
2602 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2603 @code{constSI} and @code{constcgs} to set this value for the current
2604 buffer.}. Column names and parameters can be specified in special table
2605 lines. These are described below, see @ref{Advanced features}. All
2606 names must start with a letter, and further consist of letters and
2609 @subsubheading Remote references
2610 @cindex remote references
2611 @cindex references, remote
2612 @cindex references, to a different table
2613 @cindex name, of column or field
2614 @cindex constants, in calculations
2615 @cindex #+NAME, for table
2617 You may also reference constants, fields and ranges from a different table,
2618 either in the current file or even in a different file. The syntax is
2621 remote(NAME-OR-ID,REF)
2625 where NAME can be the name of a table in the current file as set by a
2626 @code{#+NAME: Name} line before the table. It can also be the ID of an
2627 entry, even in a different file, and the reference then refers to the first
2628 table in that entry. REF is an absolute field or range reference as
2629 described above for example @code{@@3$3} or @code{$somename}, valid in the
2632 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2633 @subsection Formula syntax for Calc
2634 @cindex formula syntax, Calc
2635 @cindex syntax, of formulas
2637 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2638 package. Note that @file{calc} has the non-standard convention that @samp{/}
2639 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2640 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2641 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2642 GNU Emacs Calc Manual}), variable substitution takes place according to the
2643 rules described above.
2644 @cindex vectors, in table calculations
2645 The range vectors can be directly fed into the Calc vector functions
2646 like @samp{vmean} and @samp{vsum}.
2648 @cindex format specifier
2649 @cindex mode, for @file{calc}
2650 @vindex org-calc-default-modes
2651 A formula can contain an optional mode string after a semicolon. This
2652 string consists of flags to influence Calc and other modes during
2653 execution. By default, Org uses the standard Calc modes (precision
2654 12, angular units degrees, fraction and symbolic modes off). The display
2655 format, however, has been changed to @code{(float 8)} to keep tables
2656 compact. The default settings can be configured using the option
2657 @code{org-calc-default-modes}.
2659 @noindent List of modes:
2663 Set the internal Calc calculation precision to 20 digits.
2664 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2665 Normal, scientific, engineering or fixed format of the result of Calc passed
2666 back to Org. Calc formatting is unlimited in precision as long as the Calc
2667 calculation precision is greater.
2668 @item @code{D}, @code{R}
2669 Degree and radian angle modes of Calc.
2670 @item @code{F}, @code{S}
2671 Fraction and symbolic modes of Calc.
2672 @item @code{T}, @code{t}
2673 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2675 If and how to consider empty fields. Without @samp{E} empty fields in range
2676 references are suppressed so that the Calc vector or Lisp list contains only
2677 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2678 fields in ranges or empty field references the value @samp{nan} (not a
2679 number) is used in Calc formulas and the empty string is used for Lisp
2680 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2681 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2683 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2684 to see how this is essential for computations with Lisp formulas. In Calc
2685 formulas it is used only occasionally because there number strings are
2686 already interpreted as numbers without @samp{N}.
2688 Literal, for Lisp formulas only. See the next section.
2692 Unless you use large integer numbers or high-precision-calculation and
2693 -display for floating point numbers you may alternatively provide a
2694 @samp{printf} format specifier to reformat the Calc result after it has been
2695 passed back to Org instead of letting Calc already do the
2696 formatting@footnote{The @samp{printf} reformatting is limited in precision
2697 because the value passed to it is converted into an @samp{integer} or
2698 @samp{double}. The @samp{integer} is limited in size by truncating the
2699 signed value to 32 bits. The @samp{double} is limited in precision to 64
2700 bits overall which leaves approximately 16 significant decimal digits.}. A
2704 $1+$2 @r{Sum of first and second field}
2705 $1+$2;%.2f @r{Same, format result to two decimals}
2706 exp($2)+exp($1) @r{Math functions can be used}
2707 $0;%.1f @r{Reformat current cell to 1 decimal}
2708 ($3-32)*5/9 @r{Degrees F -> C conversion}
2709 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2710 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2711 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2712 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2715 Calc also contains a complete set of logical operations, (@pxref{Logical
2716 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2719 @item if($1 < 20, teen, string(""))
2720 "teen" if age $1 is less than 20, else the Org table result field is set to
2721 empty with the empty string.
2722 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E
2723 Sum of the first two columns. When at least one of the input fields is empty
2724 the Org table result field is set to empty.
2725 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2726 Mean value of a range unless there is any empty field. Every field in the
2727 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2728 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2729 @samp{vmean} and the Org table result field is set to empty. Use this when
2730 the sample set is expected to never have missing values.
2731 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2732 Mean value of a range with empty fields skipped. Every field in the range
2733 that is empty is skipped. When all fields in the range are empty the mean
2734 value is not defined and the Org table result field is set to empty. Use
2735 this when the sample set can have a variable size.
2736 @item vmean($1..$7); EN
2737 To complete the example before: Mean value of a range with empty fields
2738 counting as samples with value 0. Use this only when incomplete sample sets
2739 should be padded with 0 to the full size.
2742 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2743 and use them in formula syntax for Calc.
2745 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2746 @subsection Emacs Lisp forms as formulas
2747 @cindex Lisp forms, as table formulas
2749 It is also possible to write a formula in Emacs Lisp. This can be useful
2750 for string manipulation and control structures, if Calc's functionality is
2753 If a formula starts with a single-quote followed by an opening parenthesis,
2754 then it is evaluated as a Lisp form. The evaluation should return either a
2755 string or a number. Just as with @file{calc} formulas, you can specify modes
2756 and a printf format after a semicolon.
2758 With Emacs Lisp forms, you need to be conscious about the way field
2759 references are interpolated into the form. By default, a reference will be
2760 interpolated as a Lisp string (in double-quotes) containing the field. If
2761 you provide the @samp{N} mode switch, all referenced elements will be numbers
2762 (non-number fields will be zero) and interpolated as Lisp numbers, without
2763 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2764 literally, without quotes. I.e., if you want a reference to be interpreted
2765 as a string by the Lisp form, enclose the reference operator itself in
2766 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2767 fields, so you can embed them in list or vector syntax.
2769 Here are a few examples---note how the @samp{N} mode is used when we do
2770 computations in Lisp:
2773 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2774 Swap the first two characters of the content of column 1.
2776 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2777 @item '(apply '+ '($1..$4));N
2778 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2781 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2782 @subsection Durations and time values
2783 @cindex Duration, computing
2784 @cindex Time, computing
2785 @vindex org-table-duration-custom-format
2787 If you want to compute time values use the @code{T} flag, either in Calc
2788 formulas or Elisp formulas:
2792 | Task 1 | Task 2 | Total |
2793 |---------+----------+----------|
2794 | 2:12 | 1:47 | 03:59:00 |
2795 | 3:02:20 | -2:07:00 | 0.92 |
2796 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2800 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2801 are optional. With the @code{T} flag, computed durations will be displayed
2802 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2803 computed durations will be displayed according to the value of the option
2804 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2805 will display the result as a fraction of hours (see the second formula in the
2808 Negative duration values can be manipulated as well, and integers will be
2809 considered as seconds in addition and subtraction.
2811 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2812 @subsection Field and range formulas
2813 @cindex field formula
2814 @cindex range formula
2815 @cindex formula, for individual table field
2816 @cindex formula, for range of fields
2818 To assign a formula to a particular field, type it directly into the field,
2819 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2820 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2821 the formula will be stored as the formula for this field, evaluated, and the
2822 current field will be replaced with the result.
2825 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2826 below the table. If you type the equation in the 4th field of the 3rd data
2827 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2828 inserting/deleting/swapping column and rows with the appropriate commands,
2829 @i{absolute references} (but not relative ones) in stored formulas are
2830 modified in order to still reference the same field. To avoid this from
2831 happening, in particular in range references, anchor ranges at the table
2832 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2833 using the @code{@@I} notation. Automatic adaptation of field references does
2834 of course not happen if you edit the table structure with normal editing
2835 commands---then you must fix the equations yourself.
2837 Instead of typing an equation into the field, you may also use the following
2841 @orgcmd{C-u C-c =,org-table-eval-formula}
2842 Install a new formula for the current field. The command prompts for a
2843 formula with default taken from the @samp{#+TBLFM:} line, applies
2844 it to the current field, and stores it.
2847 The left-hand side of a formula can also be a special expression in order to
2848 assign the formula to a number of different fields. There is no keyboard
2849 shortcut to enter such range formulas. To add them, use the formula editor
2850 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2855 Column formula, valid for the entire column. This is so common that Org
2856 treats these formulas in a special way, see @ref{Column formulas}.
2858 Row formula, applies to all fields in the specified row. @code{@@>=} means
2861 Range formula, applies to all fields in the given rectangular range. This
2862 can also be used to assign a formula to some but not all fields in a row.
2864 Named field, see @ref{Advanced features}.
2867 @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
2868 @subsection Column formulas
2869 @cindex column formula
2870 @cindex formula, for table column
2872 When you assign a formula to a simple column reference like @code{$3=}, the
2873 same formula will be used in all fields of that column, with the following
2874 very convenient exceptions: (i) If the table contains horizontal separator
2875 hlines with rows above and below, everything before the first such hline is
2876 considered part of the table @emph{header} and will not be modified by column
2877 formulas. Therefore a header is mandatory when you use column formulas and
2878 want to add hlines to group rows, like for example to separate a total row at
2879 the bottom from the summand rows above. (ii) Fields that already get a value
2880 from a field/range formula will be left alone by column formulas. These
2881 conditions make column formulas very easy to use.
2883 To assign a formula to a column, type it directly into any field in the
2884 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2885 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2886 the formula will be stored as the formula for the current column, evaluated
2887 and the current field replaced with the result. If the field contains only
2888 @samp{=}, the previously stored formula for this column is used. For each
2889 column, Org will only remember the most recently used formula. In the
2890 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2891 left-hand side of a column formula can not be the name of column, it must be
2892 the numeric column reference or @code{$>}.
2894 Instead of typing an equation into the field, you may also use the
2898 @orgcmd{C-c =,org-table-eval-formula}
2899 Install a new formula for the current column and replace current field with
2900 the result of the formula. The command prompts for a formula, with default
2901 taken from the @samp{#+TBLFM} line, applies it to the current field and
2902 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2903 will apply it to that many consecutive fields in the current column.
2906 @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
2907 @subsection Lookup functions
2908 @cindex lookup functions in tables
2909 @cindex table lookup functions
2911 Org has three predefined Emacs Lisp functions for lookups in tables.
2913 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2914 @findex org-lookup-first
2915 Searches for the first element @code{S} in list @code{S-LIST} for which
2919 is @code{t}; returns the value from the corresponding position in list
2920 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2921 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2922 order as the corresponding parameters are in the call to
2923 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2924 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2926 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2927 @findex org-lookup-last
2928 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2929 element for which @code{PREDICATE} is @code{t}.
2930 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2931 @findex org-lookup-all
2932 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2933 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2934 values. This function can not be used by itself in a formula, because it
2935 returns a list of values. However, powerful lookups can be built when this
2936 function is combined with other Emacs Lisp functions.
2939 If the ranges used in these functions contain empty fields, the @code{E} mode
2940 for the formula should usually be specified: otherwise empty fields will not be
2941 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2942 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2943 element of @code{R-LIST}.
2945 These three functions can be used to implement associative arrays, count
2946 matching cells, rank results, group data etc. For practical examples
2947 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2950 @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
2951 @subsection Editing and debugging formulas
2952 @cindex formula editing
2953 @cindex editing, of table formulas
2955 @vindex org-table-use-standard-references
2956 You can edit individual formulas in the minibuffer or directly in the field.
2957 Org can also prepare a special buffer with all active formulas of a table.
2958 When offering a formula for editing, Org converts references to the standard
2959 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2960 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2961 option @code{org-table-use-standard-references}.
2964 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2965 Edit the formula associated with the current column/field in the
2966 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2967 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2968 Re-insert the active formula (either a
2969 field formula, or a column formula) into the current field, so that you
2970 can edit it directly in the field. The advantage over editing in the
2971 minibuffer is that you can use the command @kbd{C-c ?}.
2972 @orgcmd{C-c ?,org-table-field-info}
2973 While editing a formula in a table field, highlight the field(s)
2974 referenced by the reference at the cursor position in the formula.
2976 @findex org-table-toggle-coordinate-overlays
2978 Toggle the display of row and column numbers for a table, using overlays
2979 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2980 time the table is aligned; you can force it with @kbd{C-c C-c}.
2982 @findex org-table-toggle-formula-debugger
2984 Toggle the formula debugger on and off
2985 (@command{org-table-toggle-formula-debugger}). See below.
2986 @orgcmd{C-c ',org-table-edit-formulas}
2987 Edit all formulas for the current table in a special buffer, where the
2988 formulas will be displayed one per line. If the current field has an
2989 active formula, the cursor in the formula editor will mark it.
2990 While inside the special buffer, Org will automatically highlight
2991 any field or range reference at the cursor position. You may edit,
2992 remove and add formulas, and use the following commands:
2995 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2996 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2997 prefix, also apply the new formulas to the entire table.
2998 @orgcmd{C-c C-q,org-table-fedit-abort}
2999 Exit the formula editor without installing changes.
3000 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3001 Toggle all references in the formula editor between standard (like
3002 @code{B3}) and internal (like @code{@@3$2}).
3003 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3004 Pretty-print or indent Lisp formula at point. When in a line containing
3005 a Lisp formula, format the formula according to Emacs Lisp rules.
3006 Another @key{TAB} collapses the formula back again. In the open
3007 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3008 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3009 Complete Lisp symbols, just like in Emacs Lisp mode.
3011 @kindex S-@key{down}
3012 @kindex S-@key{left}
3013 @kindex S-@key{right}
3014 @findex org-table-fedit-ref-up
3015 @findex org-table-fedit-ref-down
3016 @findex org-table-fedit-ref-left
3017 @findex org-table-fedit-ref-right
3018 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3019 Shift the reference at point. For example, if the reference is
3020 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3021 This also works for relative references and for hline references.
3022 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3023 Move the test line for column formulas in the Org buffer up and
3025 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3026 Scroll the window displaying the table.
3028 @findex org-table-toggle-coordinate-overlays
3030 Turn the coordinate grid in the table on and off.
3034 Making a table field blank does not remove the formula associated with
3035 the field, because that is stored in a different line (the @samp{#+TBLFM}
3036 line)---during the next recalculation the field will be filled again.
3037 To remove a formula from a field, you have to give an empty reply when
3038 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3041 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3042 equations with @kbd{C-c C-c} in that line or with the normal
3043 recalculation commands in the table.
3045 @anchor{Using multiple #+TBLFM lines}
3046 @subsubheading Using multiple #+TBLFM lines
3047 @cindex #+TBLFM line, multiple
3049 @cindex #+TBLFM, switching
3052 You may apply the formula temporarily. This is useful when you
3053 switch the formula. Place multiple @samp{#+TBLFM} lines right
3054 after the table, and then press @kbd{C-c C-c} on the formula to
3055 apply. Here is an example:
3067 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3079 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3080 will get the following result of applying only the first @samp{#+TBLFM} line.
3091 @subsubheading Debugging formulas
3092 @cindex formula debugging
3093 @cindex debugging, of table formulas
3094 When the evaluation of a formula leads to an error, the field content
3095 becomes the string @samp{#ERROR}. If you would like see what is going
3096 on during variable substitution and calculation in order to find a bug,
3097 turn on formula debugging in the @code{Tbl} menu and repeat the
3098 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3099 field. Detailed information will be displayed.
3101 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
3102 @subsection Updating the table
3103 @cindex recomputing table fields
3104 @cindex updating, table
3106 Recalculation of a table is normally not automatic, but needs to be
3107 triggered by a command. See @ref{Advanced features}, for a way to make
3108 recalculation at least semi-automatic.
3110 In order to recalculate a line of a table or the entire table, use the
3114 @orgcmd{C-c *,org-table-recalculate}
3115 Recalculate the current row by first applying the stored column formulas
3116 from left to right, and all field/range formulas in the current row.
3122 Recompute the entire table, line by line. Any lines before the first
3123 hline are left alone, assuming that these are part of the table header.
3125 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3126 Iterate the table by recomputing it until no further changes occur.
3127 This may be necessary if some computed fields use the value of other
3128 fields that are computed @i{later} in the calculation sequence.
3129 @item M-x org-table-recalculate-buffer-tables RET
3130 @findex org-table-recalculate-buffer-tables
3131 Recompute all tables in the current buffer.
3132 @item M-x org-table-iterate-buffer-tables RET
3133 @findex org-table-iterate-buffer-tables
3134 Iterate all tables in the current buffer, in order to converge table-to-table
3138 @node Advanced features, , Updating the table, The spreadsheet
3139 @subsection Advanced features
3141 If you want the recalculation of fields to happen automatically, or if you
3142 want to be able to assign @i{names}@footnote{Such names must start by an
3143 alphabetic character and use only alphanumeric/underscore characters.} to
3144 fields and columns, you need to reserve the first column of the table for
3145 special marking characters.
3148 @orgcmd{C-#,org-table-rotate-recalc-marks}
3149 Rotate the calculation mark in first column through the states @samp{ },
3150 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3151 change all marks in the region.
3154 Here is an example of a table that collects exam results of students and
3155 makes use of these features:
3159 |---+---------+--------+--------+--------+-------+------|
3160 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3161 |---+---------+--------+--------+--------+-------+------|
3162 | ! | | P1 | P2 | P3 | Tot | |
3163 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3164 | ^ | | m1 | m2 | m3 | mt | |
3165 |---+---------+--------+--------+--------+-------+------|
3166 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3167 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3168 |---+---------+--------+--------+--------+-------+------|
3169 | | Average | | | | 25.0 | |
3170 | ^ | | | | | at | |
3171 | $ | max=50 | | | | | |
3172 |---+---------+--------+--------+--------+-------+------|
3173 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3177 @noindent @b{Important}: please note that for these special tables,
3178 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3179 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3180 to the field itself. The column formulas are not applied in rows with
3183 @cindex marking characters, tables
3184 The marking characters have the following meaning:
3188 The fields in this line define names for the columns, so that you may
3189 refer to a column as @samp{$Tot} instead of @samp{$6}.
3191 This row defines names for the fields @emph{above} the row. With such
3192 a definition, any formula in the table may use @samp{$m1} to refer to
3193 the value @samp{10}. Also, if you assign a formula to a names field, it
3194 will be stored as @samp{$name=...}.
3196 Similar to @samp{^}, but defines names for the fields in the row
3199 Fields in this row can define @emph{parameters} for formulas. For
3200 example, if a field in a @samp{$} row contains @samp{max=50}, then
3201 formulas in this table can refer to the value 50 using @samp{$max}.
3202 Parameters work exactly like constants, only that they can be defined on
3205 Fields in this row are automatically recalculated when pressing
3206 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3207 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3208 lines will be left alone by this command.
3210 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3211 not for automatic recalculation. Use this when automatic
3212 recalculation slows down editing too much.
3214 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3215 All lines that should be recalculated should be marked with @samp{#}
3218 Do not export this line. Useful for lines that contain the narrowing
3219 @samp{<N>} markers or column group markers.
3222 Finally, just to whet your appetite for what can be done with the
3223 fantastic @file{calc.el} package, here is a table that computes the Taylor
3224 series of degree @code{n} at location @code{x} for a couple of
3229 |---+-------------+---+-----+--------------------------------------|
3230 | | Func | n | x | Result |
3231 |---+-------------+---+-----+--------------------------------------|
3232 | # | exp(x) | 1 | x | 1 + x |
3233 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3234 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3235 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3236 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3237 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3238 |---+-------------+---+-----+--------------------------------------|
3239 #+TBLFM: $5=taylor($2,$4,$3);n3
3243 @node Org-Plot, , The spreadsheet, Tables
3245 @cindex graph, in tables
3246 @cindex plot tables using Gnuplot
3249 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3250 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3251 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3252 that you have both Gnuplot and Gnuplot mode installed on your system, then
3253 call @code{org-plot/gnuplot} on the following table.
3257 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3258 | Sede | Max cites | H-index |
3259 |-----------+-----------+---------|
3260 | Chile | 257.72 | 21.39 |
3261 | Leeds | 165.77 | 19.68 |
3262 | Sao Paolo | 71.00 | 11.50 |
3263 | Stockholm | 134.19 | 14.33 |
3264 | Morelia | 257.56 | 17.67 |
3268 Notice that Org Plot is smart enough to apply the table's headers as labels.
3269 Further control over the labels, type, content, and appearance of plots can
3270 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3271 for a complete list of Org-plot options. For more information and examples
3272 see the Org-plot tutorial at
3273 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3275 @subsubheading Plot Options
3279 Specify any @command{gnuplot} option to be set when graphing.
3282 Specify the title of the plot.
3285 Specify which column of the table to use as the @code{x} axis.
3288 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3289 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3290 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3294 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3297 Specify a @code{with} option to be inserted for every col being plotted
3298 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3299 Defaults to @code{lines}.
3302 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3305 List of labels to be used for the @code{deps} (defaults to the column headers
3309 Specify an entire line to be inserted in the Gnuplot script.
3312 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3313 flat mapping rather than a @code{3d} slope.
3316 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3317 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3320 If you want total control, you can specify a script file (place the file name
3321 between double-quotes) which will be used to plot. Before plotting, every
3322 instance of @code{$datafile} in the specified script will be replaced with
3323 the path to the generated data file. Note: even if you set this option, you
3324 may still want to specify the plot type, as that can impact the content of
3328 @node Hyperlinks, TODO Items, Tables, Top
3332 Like HTML, Org provides links inside a file, external links to
3333 other files, Usenet articles, emails, and much more.
3336 * Link format:: How links in Org are formatted
3337 * Internal links:: Links to other places in the current file
3338 * External links:: URL-like links to the world
3339 * Handling links:: Creating, inserting and following
3340 * Using links outside Org:: Linking from my C source code?
3341 * Link abbreviations:: Shortcuts for writing complex links
3342 * Search options:: Linking to a specific location
3343 * Custom searches:: When the default search is not enough
3346 @node Link format, Internal links, Hyperlinks, Hyperlinks
3347 @section Link format
3349 @cindex format, of links
3351 Org will recognize plain URL-like links and activate them as
3352 clickable links. The general link format, however, looks like this:
3355 [[link][description]] @r{or alternatively} [[link]]
3359 Once a link in the buffer is complete (all brackets present), Org
3360 will change the display so that @samp{description} is displayed instead
3361 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3362 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3363 which by default is an underlined face. You can directly edit the
3364 visible part of a link. Note that this can be either the @samp{link}
3365 part (if there is no description) or the @samp{description} part. To
3366 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3369 If you place the cursor at the beginning or just behind the end of the
3370 displayed text and press @key{BACKSPACE}, you will remove the
3371 (invisible) bracket at that location. This makes the link incomplete
3372 and the internals are again displayed as plain text. Inserting the
3373 missing bracket hides the link internals again. To show the
3374 internal structure of all links, use the menu entry
3375 @code{Org->Hyperlinks->Literal links}.
3377 @node Internal links, External links, Link format, Hyperlinks
3378 @section Internal links
3379 @cindex internal links
3380 @cindex links, internal
3381 @cindex targets, for links
3383 @cindex property, CUSTOM_ID
3384 If the link does not look like a URL, it is considered to be internal in the
3385 current file. The most important case is a link like
3386 @samp{[[#my-custom-id]]} which will link to the entry with the
3387 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3388 to make sure these custom IDs are unique in a file.
3390 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3391 lead to a text search in the current file.
3393 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3394 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3395 point to the corresponding headline. The preferred match for a text link is
3396 a @i{dedicated target}: the same string in double angular brackets, like
3397 @samp{<<My Target>>}.
3400 If no dedicated target exists, the link will then try to match the exact name
3401 of an element within the buffer. Naming is done with the @code{#+NAME}
3402 keyword, which has to be put the line before the element it refers to, as in
3403 the following example
3412 If none of the above succeeds, Org will search for a headline that is exactly
3413 the link text but may also include a TODO keyword and tags@footnote{To insert
3414 a link targeting a headline, in-buffer completion can be used. Just type
3415 a star followed by a few optional letters into the buffer and press
3416 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3419 During export, internal links will be used to mark objects and assign them
3420 a number. Marked objects will then be referenced by links pointing to them.
3421 In particular, links without a description will appear as the number assigned
3422 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3423 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3424 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3428 - <<target>>another item
3429 Here we refer to item [[target]].
3433 The last sentence will appear as @samp{Here we refer to item 2} when
3436 In non-Org files, the search will look for the words in the link text. In
3437 the above example the search would be for @samp{my target}.
3439 Following a link pushes a mark onto Org's own mark ring. You can
3440 return to the previous position with @kbd{C-c &}. Using this command
3441 several times in direct succession goes back to positions recorded
3445 * Radio targets:: Make targets trigger links in plain text
3448 @node Radio targets, , Internal links, Internal links
3449 @subsection Radio targets
3450 @cindex radio targets
3451 @cindex targets, radio
3452 @cindex links, radio targets
3454 Org can automatically turn any occurrences of certain target names
3455 in normal text into a link. So without explicitly creating a link, the
3456 text connects to the target radioing its position. Radio targets are
3457 enclosed by triple angular brackets. For example, a target @samp{<<<My
3458 Target>>>} causes each occurrence of @samp{my target} in normal text to
3459 become activated as a link. The Org file is scanned automatically
3460 for radio targets only when the file is first loaded into Emacs. To
3461 update the target list during editing, press @kbd{C-c C-c} with the
3462 cursor on or at a target.
3464 @node External links, Handling links, Internal links, Hyperlinks
3465 @section External links
3466 @cindex links, external
3467 @cindex external links
3475 @cindex USENET links
3480 Org supports links to files, websites, Usenet and email messages, BBDB
3481 database entries and links to both IRC conversations and their logs.
3482 External links are URL-like locators. They start with a short identifying
3483 string followed by a colon. There can be no space after the colon. The
3484 following list shows examples for each link type.
3487 http://www.astro.uva.nl/~dominik @r{on the web}
3488 doi:10.1000/182 @r{DOI for an electronic resource}
3489 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3490 /home/dominik/images/jupiter.jpg @r{same as above}
3491 file:papers/last.pdf @r{file, relative path}
3492 ./papers/last.pdf @r{same as above}
3493 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3494 /myself@@some.where:papers/last.pdf @r{same as above}
3495 file:sometextfile::NNN @r{file, jump to line number}
3496 file:projects.org @r{another Org file}
3497 file:projects.org::some words @r{text search in Org file}@footnote{
3498 The actual behavior of the search will depend on the value of
3499 the option @code{org-link-search-must-match-exact-headline}. If its value
3500 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3501 exact headline will be matched. If the value is @code{'query-to-create},
3502 then an exact headline will be searched; if it is not found, then the user
3503 will be queried to create it.}
3504 file:projects.org::*task title @r{heading search in Org file}
3505 file+sys:/path/to/file @r{open via OS, like double-click}
3506 file+emacs:/path/to/file @r{force opening by Emacs}
3507 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3508 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3509 news:comp.emacs @r{Usenet link}
3510 mailto:adent@@galaxy.net @r{Mail link}
3511 mhe:folder @r{MH-E folder link}
3512 mhe:folder#id @r{MH-E message link}
3513 rmail:folder @r{RMAIL folder link}
3514 rmail:folder#id @r{RMAIL message link}
3515 gnus:group @r{Gnus group link}
3516 gnus:group#id @r{Gnus article link}
3517 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3518 irc:/irc.com/#emacs/bob @r{IRC link}
3519 info:org#External links @r{Info node link}
3520 shell:ls *.org @r{A shell command}
3521 elisp:org-agenda @r{Interactive Elisp command}
3522 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3526 @cindex WANDERLUST links
3527 On top of these built-in link types, some are available through the
3528 @code{contrib/} directory (@pxref{Installation}). For example, these links
3529 to VM or Wanderlust messages are available when you load the corresponding
3530 libraries from the @code{contrib/} directory:
3533 vm:folder @r{VM folder link}
3534 vm:folder#id @r{VM message link}
3535 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3536 vm-imap:account:folder @r{VM IMAP folder link}
3537 vm-imap:account:folder#id @r{VM IMAP message link}
3538 wl:folder @r{WANDERLUST folder link}
3539 wl:folder#id @r{WANDERLUST message link}
3542 For customizing Org to add new link types @ref{Adding hyperlink types}.
3544 A link should be enclosed in double brackets and may contain a descriptive
3545 text to be displayed instead of the URL (@pxref{Link format}), for example:
3548 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3552 If the description is a file name or URL that points to an image, HTML
3553 export (@pxref{HTML export}) will inline the image as a clickable
3554 button. If there is no description at all and the link points to an
3556 that image will be inlined into the exported HTML file.
3558 @cindex square brackets, around links
3559 @cindex plain text external links
3560 Org also finds external links in the normal text and activates them
3561 as links. If spaces must be part of the link (for example in
3562 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3563 about the end of the link, enclose them in square brackets.
3565 @node Handling links, Using links outside Org, External links, Hyperlinks
3566 @section Handling links
3567 @cindex links, handling
3569 Org provides methods to create a link in the correct syntax, to
3570 insert it into an Org file, and to follow the link.
3573 @orgcmd{C-c l,org-store-link}
3574 @cindex storing links
3575 Store a link to the current location. This is a @emph{global} command (you
3576 must create the key binding yourself) which can be used in any buffer to
3577 create a link. The link will be stored for later insertion into an Org
3578 buffer (see below). What kind of link will be created depends on the current
3581 @b{Org mode buffers}@*
3582 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3583 to the target. Otherwise it points to the current headline, which will also
3584 be the description@footnote{If the headline contains a timestamp, it will be
3585 removed from the link and result in a wrong link---you should avoid putting
3586 timestamp in the headline.}.
3588 @vindex org-id-link-to-org-use-id
3589 @cindex property, CUSTOM_ID
3590 @cindex property, ID
3591 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3592 will be stored. In addition or alternatively (depending on the value of
3593 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3594 be created and/or used to construct a link@footnote{The library
3595 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3596 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3597 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3598 potentially create two links: a human-readable from the custom ID, and one
3599 that is globally unique and works even if the entry is moved from file to
3600 file. Later, when inserting the link, you need to decide which one to use.
3602 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3603 Pretty much all Emacs mail clients are supported. The link will point to the
3604 current article, or, in some GNUS buffers, to the group. The description is
3605 constructed from the author and the subject.
3607 @b{Web browsers: W3 and W3M}@*
3608 Here the link will be the current URL, with the page title as description.
3610 @b{Contacts: BBDB}@*
3611 Links created in a BBDB buffer will point to the current entry.
3614 @vindex org-irc-link-to-logs
3615 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3616 a @samp{file:/} style link to the relevant point in the logs for the current
3617 conversation is created. Otherwise an @samp{irc:/} style link to the
3618 user/channel/server under the point will be stored.
3621 For any other files, the link will point to the file, with a search string
3622 (@pxref{Search options}) pointing to the contents of the current line. If
3623 there is an active region, the selected words will form the basis of the
3624 search string. If the automatically created link is not working correctly or
3625 accurately enough, you can write custom functions to select the search string
3626 and to do the search for particular file types---see @ref{Custom searches}.
3627 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3630 When the cursor is in an agenda view, the created link points to the
3631 entry referenced by the current line.
3634 @orgcmd{C-c C-l,org-insert-link}
3635 @cindex link completion
3636 @cindex completion, of links
3637 @cindex inserting links
3638 @vindex org-keep-stored-link-after-insertion
3639 Insert a link@footnote{ Note that you don't have to use this command to
3640 insert a link. Links in Org are plain text, and you can type or paste them
3641 straight into the buffer. By using this command, the links are automatically
3642 enclosed in double brackets, and you will be asked for the optional
3643 descriptive text.}. This prompts for a link to be inserted into the buffer.
3644 You can just type a link, using text for an internal link, or one of the link
3645 type prefixes mentioned in the examples above. The link will be inserted
3646 into the buffer@footnote{After insertion of a stored link, the link will be
3647 removed from the list of stored links. To keep it in the list later use, use
3648 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3649 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3650 If some text was selected when this command is called, the selected text
3651 becomes the default description.
3653 @b{Inserting stored links}@*
3654 All links stored during the
3655 current session are part of the history for this prompt, so you can access
3656 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3658 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3659 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3660 defined through link abbreviations (@pxref{Link abbreviations}). If you
3661 press @key{RET} after inserting only the @var{prefix}, Org will offer
3662 specific completion support for some link types@footnote{This works by
3663 calling a special function @code{org-PREFIX-complete-link}.} For
3664 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3665 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3666 @key{RET}} you can complete contact names.
3668 @cindex file name completion
3669 @cindex completion, of file names
3670 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3671 a file will be inserted and you may use file name completion to select
3672 the name of the file. The path to the file is inserted relative to the
3673 directory of the current Org file, if the linked file is in the current
3674 directory or in a sub-directory of it, or if the path is written relative
3675 to the current directory using @samp{../}. Otherwise an absolute path
3676 is used, if possible with @samp{~/} for your home directory. You can
3677 force an absolute path with two @kbd{C-u} prefixes.
3679 @item C-c C-l @ @r{(with cursor on existing link)}
3680 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3681 link and description parts of the link.
3683 @cindex following links
3684 @orgcmd{C-c C-o,org-open-at-point}
3685 @vindex org-file-apps
3686 @vindex org-link-frame-setup
3687 Open link at point. This will launch a web browser for URLs (using
3688 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3689 the corresponding links, and execute the command in a shell link. When the
3690 cursor is on an internal link, this command runs the corresponding search.
3691 When the cursor is on a TAG list in a headline, it creates the corresponding
3692 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3693 date. Furthermore, it will visit text and remote files in @samp{file:} links
3694 with Emacs and select a suitable application for local non-text files.
3695 Classification of files is based on file extension only. See option
3696 @code{org-file-apps}. If you want to override the default application and
3697 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3698 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3699 If the cursor is on a headline, but not on a link, offer all links in the
3700 headline and entry text. If you want to setup the frame configuration for
3701 following links, customize @code{org-link-frame-setup}.
3704 @vindex org-return-follows-link
3705 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3712 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3713 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3717 @vindex org-display-internal-link-with-indirect-buffer
3718 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3719 internal links to be displayed in another window@footnote{See the
3720 option @code{org-display-internal-link-with-indirect-buffer}}.
3722 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3723 @cindex inlining images
3724 @cindex images, inlining
3725 @vindex org-startup-with-inline-images
3726 @cindex @code{inlineimages}, STARTUP keyword
3727 @cindex @code{noinlineimages}, STARTUP keyword
3728 Toggle the inline display of linked images. Normally this will only inline
3729 images that have no description part in the link, i.e., images that will also
3730 be inlined during export. When called with a prefix argument, also display
3731 images that do have a link description. You can ask for inline images to be
3732 displayed at startup by configuring the variable
3733 @code{org-startup-with-inline-images}@footnote{with corresponding
3734 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3735 @orgcmd{C-c %,org-mark-ring-push}
3737 Push the current position onto the mark ring, to be able to return
3738 easily. Commands following an internal link do this automatically.
3740 @orgcmd{C-c &,org-mark-ring-goto}
3741 @cindex links, returning to
3742 Jump back to a recorded position. A position is recorded by the
3743 commands following internal links, and by @kbd{C-c %}. Using this
3744 command several times in direct succession moves through a ring of
3745 previously recorded positions.
3747 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3748 @cindex links, finding next/previous
3749 Move forward/backward to the next link in the buffer. At the limit of
3750 the buffer, the search fails once, and then wraps around. The key
3751 bindings for this are really too long; you might want to bind this also
3752 to @kbd{C-n} and @kbd{C-p}
3754 (add-hook 'org-load-hook
3756 (define-key org-mode-map "\C-n" 'org-next-link)
3757 (define-key org-mode-map "\C-p" 'org-previous-link)))
3761 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3762 @section Using links outside Org
3764 You can insert and follow links that have Org syntax not only in
3765 Org, but in any Emacs buffer. For this, you should create two
3766 global commands, like this (please select suitable global keys
3770 (global-set-key "\C-c L" 'org-insert-link-global)
3771 (global-set-key "\C-c o" 'org-open-at-point-global)
3774 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3775 @section Link abbreviations
3776 @cindex link abbreviations
3777 @cindex abbreviation, links
3779 Long URLs can be cumbersome to type, and often many similar links are
3780 needed in a document. For this you can use link abbreviations. An
3781 abbreviated link looks like this
3784 [[linkword:tag][description]]
3788 @vindex org-link-abbrev-alist
3789 where the tag is optional.
3790 The @i{linkword} must be a word, starting with a letter, followed by
3791 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3792 according to the information in the variable @code{org-link-abbrev-alist}
3793 that relates the linkwords to replacement text. Here is an example:
3797 (setq org-link-abbrev-alist
3798 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3799 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3800 ("google" . "http://www.google.com/search?q=")
3801 ("gmap" . "http://maps.google.com/maps?q=%s")
3802 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3803 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3807 If the replacement text contains the string @samp{%s}, it will be
3808 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3809 url-encode the tag (see the example above, where we need to encode
3810 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3811 to a custom function, and replace it by the resulting string.
3813 If the replacement text don't contain any specifier, it will simply
3814 be appended to the string in order to create the link.
3816 Instead of a string, you may also specify a function that will be
3817 called with the tag as the only argument to create the link.
3819 With the above setting, you could link to a specific bug with
3820 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3821 @code{[[google:OrgMode]]}, show the map location of the Free Software
3822 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3823 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3824 what the Org author is doing besides Emacs hacking with
3825 @code{[[ads:Dominik,C]]}.
3827 If you need special abbreviations just for a single Org buffer, you
3828 can define them in the file with
3832 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3833 #+LINK: google http://www.google.com/search?q=%s
3837 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3838 complete link abbreviations. You may also define a function
3839 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3840 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3841 not accept any arguments, and return the full link with prefix.
3843 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3844 @section Search options in file links
3845 @cindex search option in file links
3846 @cindex file links, searching
3848 File links can contain additional information to make Emacs jump to a
3849 particular location in the file when following a link. This can be a
3850 line number or a search option after a double@footnote{For backward
3851 compatibility, line numbers can also follow a single colon.} colon. For
3852 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3853 links}) to a file, it encodes the words in the current line as a search
3854 string that can be used to find this line back later when following the
3855 link with @kbd{C-c C-o}.
3857 Here is the syntax of the different ways to attach a search to a file
3858 link, together with an explanation:
3861 [[file:~/code/main.c::255]]
3862 [[file:~/xx.org::My Target]]
3863 [[file:~/xx.org::*My Target]]
3864 [[file:~/xx.org::#my-custom-id]]
3865 [[file:~/xx.org::/regexp/]]
3872 Search for a link target @samp{<<My Target>>}, or do a text search for
3873 @samp{my target}, similar to the search in internal links, see
3874 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3875 link will become a HTML reference to the corresponding named anchor in
3878 In an Org file, restrict search to headlines.
3880 Link to a heading with a @code{CUSTOM_ID} property
3882 Do a regular expression search for @code{regexp}. This uses the Emacs
3883 command @code{occur} to list all matches in a separate window. If the
3884 target file is in Org mode, @code{org-occur} is used to create a
3885 sparse tree with the matches.
3886 @c If the target file is a directory,
3887 @c @code{grep} will be used to search all files in the directory.
3890 As a degenerate case, a file link with an empty file name can be used
3891 to search the current file. For example, @code{[[file:::find me]]} does
3892 a search for @samp{find me} in the current file, just as
3893 @samp{[[find me]]} would.
3895 @node Custom searches, , Search options, Hyperlinks
3896 @section Custom Searches
3897 @cindex custom search strings
3898 @cindex search strings, custom
3900 The default mechanism for creating search strings and for doing the
3901 actual search related to a file link may not work correctly in all
3902 cases. For example, Bib@TeX{} database files have many entries like
3903 @samp{year="1993"} which would not result in good search strings,
3904 because the only unique identification for a Bib@TeX{} entry is the
3907 @vindex org-create-file-search-functions
3908 @vindex org-execute-file-search-functions
3909 If you come across such a problem, you can write custom functions to set
3910 the right search string for a particular file type, and to do the search
3911 for the string in the file. Using @code{add-hook}, these functions need
3912 to be added to the hook variables
3913 @code{org-create-file-search-functions} and
3914 @code{org-execute-file-search-functions}. See the docstring for these
3915 variables for more information. Org actually uses this mechanism
3916 for Bib@TeX{} database files, and you can use the corresponding code as
3917 an implementation example. See the file @file{org-bibtex.el}.
3919 @node TODO Items, Tags, Hyperlinks, Top
3923 Org mode does not maintain TODO lists as separate documents@footnote{Of
3924 course, you can make a document that contains only long lists of TODO items,
3925 but this is not required.}. Instead, TODO items are an integral part of the
3926 notes file, because TODO items usually come up while taking notes! With Org
3927 mode, simply mark any entry in a tree as being a TODO item. In this way,
3928 information is not duplicated, and the entire context from which the TODO
3929 item emerged is always present.
3931 Of course, this technique for managing TODO items scatters them
3932 throughout your notes file. Org mode compensates for this by providing
3933 methods to give you an overview of all the things that you have to do.
3936 * TODO basics:: Marking and displaying TODO entries
3937 * TODO extensions:: Workflow and assignments
3938 * Progress logging:: Dates and notes for progress
3939 * Priorities:: Some things are more important than others
3940 * Breaking down tasks:: Splitting a task into manageable pieces
3941 * Checkboxes:: Tick-off lists
3944 @node TODO basics, TODO extensions, TODO Items, TODO Items
3945 @section Basic TODO functionality
3947 Any headline becomes a TODO item when it starts with the word
3948 @samp{TODO}, for example:
3951 *** TODO Write letter to Sam Fortune
3955 The most important commands to work with TODO entries are:
3958 @orgcmd{C-c C-t,org-todo}
3959 @cindex cycling, of TODO states
3960 @vindex org-use-fast-todo-selection
3962 Rotate the TODO state of the current item among
3965 ,-> (unmarked) -> TODO -> DONE --.
3966 '--------------------------------'
3969 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3970 states}), you will be prompted for a TODO keyword through the fast selection
3971 interface; this is the default behavior when
3972 @code{org-use-fast-todo-selection} is non-@code{nil}.
3974 The same rotation can also be done ``remotely'' from the timeline and agenda
3975 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3977 @orgkey{C-u C-c C-t}
3978 When TODO keywords have no selection keys, select a specific keyword using
3979 completion; otherwise force cycling through TODO states with no prompt. When
3980 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3981 selection interface.
3983 @kindex S-@key{right}
3984 @kindex S-@key{left}
3985 @item S-@key{right} @ @r{/} @ S-@key{left}
3986 @vindex org-treat-S-cursor-todo-selection-as-state-change
3987 Select the following/preceding TODO state, similar to cycling. Useful
3988 mostly if more than two TODO states are possible (@pxref{TODO
3989 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3990 with @code{shift-selection-mode}. See also the variable
3991 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3992 @orgcmd{C-c / t,org-show-todo-tree}
3993 @cindex sparse tree, for TODO
3994 @vindex org-todo-keywords
3995 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3996 entire buffer, but shows all TODO items (with not-DONE state) and the
3997 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3998 / T}), search for a specific TODO@. You will be prompted for the keyword,
3999 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4000 entries that match any one of these keywords. With a numeric prefix argument
4001 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4002 With two prefix arguments, find all TODO states, both un-done and done.
4003 @orgcmd{C-c a t,org-todo-list}
4004 Show the global TODO list. Collects the TODO items (with not-DONE states)
4005 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
4006 buffer will be in @code{agenda-mode}, which provides commands to examine and
4007 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4008 @xref{Global TODO list}, for more information.
4009 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4010 Insert a new TODO entry below the current one.
4014 @vindex org-todo-state-tags-triggers
4015 Changing a TODO state can also trigger tag changes. See the docstring of the
4016 option @code{org-todo-state-tags-triggers} for details.
4018 @node TODO extensions, Progress logging, TODO basics, TODO Items
4019 @section Extended use of TODO keywords
4020 @cindex extended TODO keywords
4022 @vindex org-todo-keywords
4023 By default, marked TODO entries have one of only two states: TODO and
4024 DONE@. Org mode allows you to classify TODO items in more complex ways
4025 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
4026 special setup, the TODO keyword system can work differently in different
4029 Note that @i{tags} are another way to classify headlines in general and
4030 TODO items in particular (@pxref{Tags}).
4033 * Workflow states:: From TODO to DONE in steps
4034 * TODO types:: I do this, Fred does the rest
4035 * Multiple sets in one file:: Mixing it all, and still finding your way
4036 * Fast access to TODO states:: Single letter selection of a state
4037 * Per-file keywords:: Different files, different requirements
4038 * Faces for TODO keywords:: Highlighting states
4039 * TODO dependencies:: When one task needs to wait for others
4042 @node Workflow states, TODO types, TODO extensions, TODO extensions
4043 @subsection TODO keywords as workflow states
4044 @cindex TODO workflow
4045 @cindex workflow states as TODO keywords
4047 You can use TODO keywords to indicate different @emph{sequential} states
4048 in the process of working on an item, for example@footnote{Changing
4049 this variable only becomes effective after restarting Org mode in a
4053 (setq org-todo-keywords
4054 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4057 The vertical bar separates the TODO keywords (states that @emph{need
4058 action}) from the DONE states (which need @emph{no further action}). If
4059 you don't provide the separator bar, the last state is used as the DONE
4061 @cindex completion, of TODO keywords
4062 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4063 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4064 also use a numeric prefix argument to quickly select a specific state. For
4065 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4066 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4067 define many keywords, you can use in-buffer completion
4068 (@pxref{Completion}) or even a special one-key selection scheme
4069 (@pxref{Fast access to TODO states}) to insert these words into the
4070 buffer. Changing a TODO state can be logged with a timestamp, see
4071 @ref{Tracking TODO state changes}, for more information.
4073 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
4074 @subsection TODO keywords as types
4076 @cindex names as TODO keywords
4077 @cindex types as TODO keywords
4079 The second possibility is to use TODO keywords to indicate different
4080 @emph{types} of action items. For example, you might want to indicate
4081 that items are for ``work'' or ``home''. Or, when you work with several
4082 people on a single project, you might want to assign action items
4083 directly to persons, by using their names as TODO keywords. This would
4084 be set up like this:
4087 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4090 In this case, different keywords do not indicate a sequence, but rather
4091 different types. So the normal work flow would be to assign a task to a
4092 person, and later to mark it DONE@. Org mode supports this style by adapting
4093 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4094 @kbd{t} command in the timeline and agenda buffers.}. When used several
4095 times in succession, it will still cycle through all names, in order to first
4096 select the right type for a task. But when you return to the item after some
4097 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4098 to DONE@. Use prefix arguments or completion to quickly select a specific
4099 name. You can also review the items of a specific TODO type in a sparse tree
4100 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4101 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4102 from all agenda files into a single buffer, you would use the numeric prefix
4103 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4105 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
4106 @subsection Multiple keyword sets in one file
4107 @cindex TODO keyword sets
4109 Sometimes you may want to use different sets of TODO keywords in
4110 parallel. For example, you may want to have the basic
4111 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4112 separate state indicating that an item has been canceled (so it is not
4113 DONE, but also does not require action). Your setup would then look
4117 (setq org-todo-keywords
4118 '((sequence "TODO" "|" "DONE")
4119 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4120 (sequence "|" "CANCELED")))
4123 The keywords should all be different, this helps Org mode to keep track
4124 of which subsequence should be used for a given entry. In this setup,
4125 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4126 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4127 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4128 select the correct sequence. Besides the obvious ways like typing a
4129 keyword or using completion, you may also apply the following commands:
4132 @kindex C-S-@key{right}
4133 @kindex C-S-@key{left}
4134 @kindex C-u C-u C-c C-t
4135 @item C-u C-u C-c C-t
4136 @itemx C-S-@key{right}
4137 @itemx C-S-@key{left}
4138 These keys jump from one TODO subset to the next. In the above example,
4139 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4140 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4141 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4142 @code{shift-selection-mode} (@pxref{Conflicts}).
4143 @kindex S-@key{right}
4144 @kindex S-@key{left}
4147 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
4148 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
4149 from @code{DONE} to @code{REPORT} in the example above. See also
4150 @ref{Conflicts}, for a discussion of the interaction with
4151 @code{shift-selection-mode}.
4154 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
4155 @subsection Fast access to TODO states
4157 If you would like to quickly change an entry to an arbitrary TODO state
4158 instead of cycling through the states, you can set up keys for single-letter
4159 access to the states. This is done by adding the selection character after
4160 each keyword, in parentheses@footnote{All characters are allowed except
4161 @code{@@^!}, which have a special meaning here.}. For example:
4164 (setq org-todo-keywords
4165 '((sequence "TODO(t)" "|" "DONE(d)")
4166 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4167 (sequence "|" "CANCELED(c)")))
4170 @vindex org-fast-tag-selection-include-todo
4171 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4172 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4173 keyword from an entry.@footnote{Check also the option
4174 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4175 state through the tags interface (@pxref{Setting tags}), in case you like to
4176 mingle the two concepts. Note that this means you need to come up with
4177 unique keys across both sets of keywords.}
4179 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
4180 @subsection Setting up keywords for individual files
4181 @cindex keyword options
4182 @cindex per-file keywords
4187 It can be very useful to use different aspects of the TODO mechanism in
4188 different files. For file-local settings, you need to add special lines
4189 to the file which set the keywords and interpretation for that file
4190 only. For example, to set one of the two examples discussed above, you
4191 need one of the following lines, starting in column zero anywhere in the
4195 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4197 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4198 interpretation, but it means the same as @code{#+TODO}), or
4200 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4203 A setup for using several sets in parallel would be:
4207 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4211 @cindex completion, of option keywords
4213 @noindent To make sure you are using the correct keyword, type
4214 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4216 @cindex DONE, final TODO keyword
4217 Remember that the keywords after the vertical bar (or the last keyword
4218 if no bar is there) must always mean that the item is DONE (although you
4219 may use a different word). After changing one of these lines, use
4220 @kbd{C-c C-c} with the cursor still in the line to make the changes
4221 known to Org mode@footnote{Org mode parses these lines only when
4222 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4223 cursor in a line starting with @samp{#+} is simply restarting Org mode
4224 for the current buffer.}.
4226 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
4227 @subsection Faces for TODO keywords
4228 @cindex faces, for TODO keywords
4230 @vindex org-todo @r{(face)}
4231 @vindex org-done @r{(face)}
4232 @vindex org-todo-keyword-faces
4233 Org mode highlights TODO keywords with special faces: @code{org-todo}
4234 for keywords indicating that an item still has to be acted upon, and
4235 @code{org-done} for keywords indicating that an item is finished. If
4236 you are using more than 2 different states, you might want to use
4237 special faces for some of them. This can be done using the option
4238 @code{org-todo-keyword-faces}. For example:
4242 (setq org-todo-keyword-faces
4243 '(("TODO" . org-warning) ("STARTED" . "yellow")
4244 ("CANCELED" . (:foreground "blue" :weight bold))))
4248 While using a list with face properties as shown for CANCELED @emph{should}
4249 work, this does not always seem to be the case. If necessary, define a
4250 special face and use that. A string is interpreted as a color. The option
4251 @code{org-faces-easy-properties} determines if that color is interpreted as a
4252 foreground or a background color.
4254 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
4255 @subsection TODO dependencies
4256 @cindex TODO dependencies
4257 @cindex dependencies, of TODO states
4259 @vindex org-enforce-todo-dependencies
4260 @cindex property, ORDERED
4261 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4262 dependencies. Usually, a parent TODO task should not be marked DONE until
4263 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4264 there is a logical sequence to a number of (sub)tasks, so that one task
4265 cannot be acted upon before all siblings above it are done. If you customize
4266 the option @code{org-enforce-todo-dependencies}, Org will block entries
4267 from changing state to DONE while they have children that are not DONE@.
4268 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4269 will be blocked until all earlier siblings are marked DONE@. Here is an
4273 * TODO Blocked until (two) is done
4282 ** TODO b, needs to wait for (a)
4283 ** TODO c, needs to wait for (a) and (b)
4287 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4288 @vindex org-track-ordered-property-with-tag
4289 @cindex property, ORDERED
4290 Toggle the @code{ORDERED} property of the current entry. A property is used
4291 for this behavior because this should be local to the current entry, not
4292 inherited like a tag. However, if you would like to @i{track} the value of
4293 this property with a tag for better visibility, customize the option
4294 @code{org-track-ordered-property-with-tag}.
4295 @orgkey{C-u C-u C-u C-c C-t}
4296 Change TODO state, circumventing any state blocking.
4299 @vindex org-agenda-dim-blocked-tasks
4300 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4301 that cannot be closed because of such dependencies will be shown in a dimmed
4302 font or even made invisible in agenda views (@pxref{Agenda Views}).
4304 @cindex checkboxes and TODO dependencies
4305 @vindex org-enforce-todo-dependencies
4306 You can also block changes of TODO states by looking at checkboxes
4307 (@pxref{Checkboxes}). If you set the option
4308 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4309 checkboxes will be blocked from switching to DONE.
4311 If you need more complex dependency structures, for example dependencies
4312 between entries in different trees or files, check out the contributed
4313 module @file{org-depend.el}.
4316 @node Progress logging, Priorities, TODO extensions, TODO Items
4317 @section Progress logging
4318 @cindex progress logging
4319 @cindex logging, of progress
4321 Org mode can automatically record a timestamp and possibly a note when
4322 you mark a TODO item as DONE, or even each time you change the state of
4323 a TODO item. This system is highly configurable; settings can be on a
4324 per-keyword basis and can be localized to a file or even a subtree. For
4325 information on how to clock working time for a task, see @ref{Clocking
4329 * Closing items:: When was this entry marked DONE?
4330 * Tracking TODO state changes:: When did the status change?
4331 * Tracking your habits:: How consistent have you been?
4334 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4335 @subsection Closing items
4337 The most basic logging is to keep track of @emph{when} a certain TODO
4338 item was finished. This is achieved with@footnote{The corresponding
4339 in-buffer setting is: @code{#+STARTUP: logdone}}
4342 (setq org-log-done 'time)
4345 @vindex org-closed-keep-when-no-todo
4347 Then each time you turn an entry from a TODO (not-done) state into any of the
4348 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4349 the headline. If you turn the entry back into a TODO item through further
4350 state cycling, that line will be removed again. If you turn the entry back
4351 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4352 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4353 non-@code{nil}. If you want to record a note along with the timestamp,
4354 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4358 (setq org-log-done 'note)
4362 You will then be prompted for a note, and that note will be stored below
4363 the entry with a @samp{Closing Note} heading.
4365 In the timeline (@pxref{Timeline}) and in the agenda
4366 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4367 display the TODO items with a @samp{CLOSED} timestamp on each day,
4368 giving you an overview of what has been done.
4370 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4371 @subsection Tracking TODO state changes
4372 @cindex drawer, for state change recording
4374 @vindex org-log-states-order-reversed
4375 @vindex org-log-into-drawer
4376 @cindex property, LOG_INTO_DRAWER
4377 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4378 might want to keep track of when a state change occurred and maybe take a
4379 note about this change. You can either record just a timestamp, or a
4380 time-stamped note for a change. These records will be inserted after the
4381 headline as an itemized list, newest first@footnote{See the option
4382 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4383 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4384 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4385 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4386 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4387 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4388 overrule the setting of this variable for a subtree by setting a
4389 @code{LOG_INTO_DRAWER} property.
4391 Since it is normally too much to record a note for every state, Org mode
4392 expects configuration on a per-keyword basis for this. This is achieved by
4393 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4394 with timestamp) in parentheses after each keyword. For example, with the
4398 (setq org-todo-keywords
4399 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4402 To record a timestamp without a note for TODO keywords configured with
4403 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4406 @vindex org-log-done
4407 you not only define global TODO keywords and fast access keys, but also
4408 request that a time is recorded when the entry is set to
4409 DONE@footnote{It is possible that Org mode will record two timestamps
4410 when you are using both @code{org-log-done} and state change logging.
4411 However, it will never prompt for two notes---if you have configured
4412 both, the state change recording note will take precedence and cancel
4413 the @samp{Closing Note}.}, and that a note is recorded when switching to
4414 WAIT or CANCELED@. The setting for WAIT is even more special: the
4415 @samp{!} after the slash means that in addition to the note taken when
4416 entering the state, a timestamp should be recorded when @i{leaving} the
4417 WAIT state, if and only if the @i{target} state does not configure
4418 logging for entering it. So it has no effect when switching from WAIT
4419 to DONE, because DONE is configured to record a timestamp only. But
4420 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4421 setting now triggers a timestamp even though TODO has no logging
4424 You can use the exact same syntax for setting logging preferences local
4427 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4430 @cindex property, LOGGING
4431 In order to define logging settings that are local to a subtree or a
4432 single item, define a LOGGING property in this entry. Any non-empty
4433 LOGGING property resets all logging settings to @code{nil}. You may then turn
4434 on logging for this specific tree using STARTUP keywords like
4435 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4436 settings like @code{TODO(!)}. For example
4439 * TODO Log each state with only a time
4441 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4443 * TODO Only log when switching to WAIT, and when repeating
4445 :LOGGING: WAIT(@@) logrepeat
4447 * TODO No logging at all
4453 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4454 @subsection Tracking your habits
4457 Org has the ability to track the consistency of a special category of TODOs,
4458 called ``habits''. A habit has the following properties:
4462 You have enabled the @code{habits} module by customizing @code{org-modules}.
4464 The habit is a TODO item, with a TODO keyword representing an open state.
4466 The property @code{STYLE} is set to the value @code{habit}.
4468 The TODO has a scheduled date, usually with a @code{.+} style repeat
4469 interval. A @code{++} style may be appropriate for habits with time
4470 constraints, e.g., must be done on weekends, or a @code{+} style for an
4471 unusual habit that can have a backlog, e.g., weekly reports.
4473 The TODO may also have minimum and maximum ranges specified by using the
4474 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4475 three days, but at most every two days.
4477 You must also have state logging for the @code{DONE} state enabled
4478 (@pxref{Tracking TODO state changes}), in order for historical data to be
4479 represented in the consistency graph. If it is not enabled it is not an
4480 error, but the consistency graphs will be largely meaningless.
4483 To give you an idea of what the above rules look like in action, here's an
4484 actual habit with some history:
4488 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4489 - State "DONE" from "TODO" [2009-10-15 Thu]
4490 - State "DONE" from "TODO" [2009-10-12 Mon]
4491 - State "DONE" from "TODO" [2009-10-10 Sat]
4492 - State "DONE" from "TODO" [2009-10-04 Sun]
4493 - State "DONE" from "TODO" [2009-10-02 Fri]
4494 - State "DONE" from "TODO" [2009-09-29 Tue]
4495 - State "DONE" from "TODO" [2009-09-25 Fri]
4496 - State "DONE" from "TODO" [2009-09-19 Sat]
4497 - State "DONE" from "TODO" [2009-09-16 Wed]
4498 - State "DONE" from "TODO" [2009-09-12 Sat]
4501 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4505 What this habit says is: I want to shave at most every 2 days (given by the
4506 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4507 today is the 15th, then the habit first appears in the agenda on Oct 17,
4508 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4509 after four days have elapsed.
4511 What's really useful about habits is that they are displayed along with a
4512 consistency graph, to show how consistent you've been at getting that task
4513 done in the past. This graph shows every day that the task was done over the
4514 past three weeks, with colors for each day. The colors used are:
4518 If the task wasn't to be done yet on that day.
4520 If the task could have been done on that day.
4522 If the task was going to be overdue the next day.
4524 If the task was overdue on that day.
4527 In addition to coloring each day, the day is also marked with an asterisk if
4528 the task was actually done that day, and an exclamation mark to show where
4529 the current day falls in the graph.
4531 There are several configuration variables that can be used to change the way
4532 habits are displayed in the agenda.
4535 @item org-habit-graph-column
4536 The buffer column at which the consistency graph should be drawn. This will
4537 overwrite any text in that column, so it is a good idea to keep your habits'
4538 titles brief and to the point.
4539 @item org-habit-preceding-days
4540 The amount of history, in days before today, to appear in consistency graphs.
4541 @item org-habit-following-days
4542 The number of days after today that will appear in consistency graphs.
4543 @item org-habit-show-habits-only-for-today
4544 If non-@code{nil}, only show habits in today's agenda view. This is set to true by
4548 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4549 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4550 bring them back. They are also subject to tag filtering, if you have habits
4551 which should only be done in certain contexts, for example.
4553 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4557 If you use Org mode extensively, you may end up with enough TODO items that
4558 it starts to make sense to prioritize them. Prioritizing can be done by
4559 placing a @emph{priority cookie} into the headline of a TODO item, like this
4562 *** TODO [#A] Write letter to Sam Fortune
4566 @vindex org-priority-faces
4567 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4568 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4569 treated just like priority @samp{B}. Priorities make a difference only for
4570 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4571 have no inherent meaning to Org mode. The cookies can be highlighted with
4572 special faces by customizing @code{org-priority-faces}.
4574 Priorities can be attached to any outline node; they do not need to be TODO
4580 @findex org-priority
4581 Set the priority of the current headline (@command{org-priority}). The
4582 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4583 When you press @key{SPC} instead, the priority cookie is removed from the
4584 headline. The priorities can also be changed ``remotely'' from the timeline
4585 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4587 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4588 @vindex org-priority-start-cycle-with-default
4589 Increase/decrease priority of current headline@footnote{See also the option
4590 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4591 also used to modify timestamps (@pxref{Creating timestamps}). See also
4592 @ref{Conflicts}, for a discussion of the interaction with
4593 @code{shift-selection-mode}.
4596 @vindex org-highest-priority
4597 @vindex org-lowest-priority
4598 @vindex org-default-priority
4599 You can change the range of allowed priorities by setting the options
4600 @code{org-highest-priority}, @code{org-lowest-priority}, and
4601 @code{org-default-priority}. For an individual buffer, you may set
4602 these values (highest, lowest, default) like this (please make sure that
4603 the highest priority is earlier in the alphabet than the lowest
4606 @cindex #+PRIORITIES
4611 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4612 @section Breaking tasks down into subtasks
4613 @cindex tasks, breaking down
4614 @cindex statistics, for TODO items
4616 @vindex org-agenda-todo-list-sublevels
4617 It is often advisable to break down large tasks into smaller, manageable
4618 subtasks. You can do this by creating an outline tree below a TODO item,
4619 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4620 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4621 the overview over the fraction of subtasks that are already completed, insert
4622 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4623 be updated each time the TODO status of a child changes, or when pressing
4624 @kbd{C-c C-c} on the cookie. For example:
4627 * Organize Party [33%]
4628 ** TODO Call people [1/2]
4632 ** DONE Talk to neighbor
4635 @cindex property, COOKIE_DATA
4636 If a heading has both checkboxes and TODO children below it, the meaning of
4637 the statistics cookie become ambiguous. Set the property
4638 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4641 @vindex org-hierarchical-todo-statistics
4642 If you would like to have the statistics cookie count any TODO entries in the
4643 subtree (not just direct children), configure
4644 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4645 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4649 * Parent capturing statistics [2/20]
4651 :COOKIE_DATA: todo recursive
4655 If you would like a TODO entry to automatically change to DONE
4656 when all children are done, you can use the following setup:
4659 (defun org-summary-todo (n-done n-not-done)
4660 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4661 (let (org-log-done org-log-states) ; turn off logging
4662 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4664 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4668 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4669 large number of subtasks (@pxref{Checkboxes}).
4672 @node Checkboxes, , Breaking down tasks, TODO Items
4676 @vindex org-list-automatic-rules
4677 Every item in a plain list@footnote{With the exception of description
4678 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4679 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4680 it with the string @samp{[ ]}. This feature is similar to TODO items
4681 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4682 in the global TODO list, so they are often great to split a task into a
4683 number of simple steps. Or you can use them in a shopping list. To toggle a
4684 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4685 @file{org-mouse.el}).
4687 Here is an example of a checkbox list.
4690 * TODO Organize party [2/4]
4691 - [-] call people [1/3]
4696 - [ ] think about what music to play
4697 - [X] talk to the neighbors
4700 Checkboxes work hierarchically, so if a checkbox item has children that
4701 are checkboxes, toggling one of the children checkboxes will make the
4702 parent checkbox reflect if none, some, or all of the children are
4705 @cindex statistics, for checkboxes
4706 @cindex checkbox statistics
4707 @cindex property, COOKIE_DATA
4708 @vindex org-checkbox-hierarchical-statistics
4709 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4710 indicating how many checkboxes present in this entry have been checked off,
4711 and the total number of checkboxes present. This can give you an idea on how
4712 many checkboxes remain, even without opening a folded entry. The cookies can
4713 be placed into a headline or into (the first line of) a plain list item.
4714 Each cookie covers checkboxes of direct children structurally below the
4715 headline/item on which the cookie appears@footnote{Set the option
4716 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4717 count all checkboxes below the cookie, not just those belonging to direct
4718 children.}. You have to insert the cookie yourself by typing either
4719 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4720 result, as in the examples above. With @samp{[%]} you get information about
4721 the percentage of checkboxes checked (in the above example, this would be
4722 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4723 count either checkboxes below the heading or TODO states of children, and it
4724 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4725 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4727 @cindex blocking, of checkboxes
4728 @cindex checkbox blocking
4729 @cindex property, ORDERED
4730 If the current outline node has an @code{ORDERED} property, checkboxes must
4731 be checked off in sequence, and an error will be thrown if you try to check
4732 off a box while there are unchecked boxes above it.
4734 @noindent The following commands work with checkboxes:
4737 @orgcmd{C-c C-c,org-toggle-checkbox}
4738 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4739 With a single prefix argument, add an empty checkbox or remove the current
4740 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4741 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4742 considered to be an intermediate state.
4743 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4744 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4745 double prefix argument, set it to @samp{[-]}, which is considered to be an
4749 If there is an active region, toggle the first checkbox in the region
4750 and set all remaining boxes to the same status as the first. With a prefix
4751 arg, add or remove the checkbox for all items in the region.
4753 If the cursor is in a headline, toggle checkboxes in the region between
4754 this headline and the next (so @emph{not} the entire subtree).
4756 If there is no active region, just toggle the checkbox at point.
4758 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4759 Insert a new item with a checkbox. This works only if the cursor is already
4760 in a plain list item (@pxref{Plain lists}).
4761 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4762 @vindex org-track-ordered-property-with-tag
4763 @cindex property, ORDERED
4764 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4765 be checked off in sequence. A property is used for this behavior because
4766 this should be local to the current entry, not inherited like a tag.
4767 However, if you would like to @i{track} the value of this property with a tag
4768 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4769 @orgcmd{C-c #,org-update-statistics-cookies}
4770 Update the statistics cookie in the current outline entry. When called with
4771 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4772 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4773 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4774 changing TODO states. If you delete boxes/entries or add/change them by
4775 hand, use this command to get things back into sync.
4778 @node Tags, Properties and Columns, TODO Items, Top
4781 @cindex headline tagging
4782 @cindex matching, tags
4783 @cindex sparse tree, tag based
4785 An excellent way to implement labels and contexts for cross-correlating
4786 information is to assign @i{tags} to headlines. Org mode has extensive
4789 @vindex org-tag-faces
4790 Every headline can contain a list of tags; they occur at the end of the
4791 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4792 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4793 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4794 Tags will by default be in bold face with the same color as the headline.
4795 You may specify special faces for specific tags using the option
4796 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4797 (@pxref{Faces for TODO keywords}).
4800 * Tag inheritance:: Tags use the tree structure of the outline
4801 * Setting tags:: How to assign tags to a headline
4802 * Tag groups:: Use one tag to search for several tags
4803 * Tag searches:: Searching for combinations of tags
4806 @node Tag inheritance, Setting tags, Tags, Tags
4807 @section Tag inheritance
4808 @cindex tag inheritance
4809 @cindex inheritance, of tags
4810 @cindex sublevels, inclusion into tags match
4812 @i{Tags} make use of the hierarchical structure of outline trees. If a
4813 heading has a certain tag, all subheadings will inherit the tag as
4814 well. For example, in the list
4817 * Meeting with the French group :work:
4818 ** Summary by Frank :boss:notes:
4819 *** TODO Prepare slides for him :action:
4823 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4824 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4825 explicitly marked with those tags. You can also set tags that all entries in
4826 a file should inherit just as if these tags were defined in a hypothetical
4827 level zero that surrounds the entire file. Use a line like this@footnote{As
4828 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4829 changes in the line.}:
4833 #+FILETAGS: :Peter:Boss:Secret:
4837 @vindex org-use-tag-inheritance
4838 @vindex org-tags-exclude-from-inheritance
4839 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4840 To turn it off entirely, use @code{org-use-tag-inheritance}.
4842 @vindex org-tags-match-list-sublevels
4843 When a headline matches during a tags search while tag inheritance is turned
4844 on, all the sublevels in the same tree will (for a simple match form) match
4845 as well@footnote{This is only true if the search does not involve more
4846 complex tests including properties (@pxref{Property searches}).}. The list
4847 of matches may then become very long. If you only want to see the first tags
4848 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4851 @vindex org-agenda-use-tag-inheritance
4852 Tag inheritance is relevant when the agenda search tries to match a tag,
4853 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4854 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4855 have your tags correctly set in the agenda, so that tag filtering works fine,
4856 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4857 this: the default value includes all agenda types, but setting this to @code{nil}
4858 can really speed up agenda generation.
4860 @node Setting tags, Tag groups, Tag inheritance, Tags
4861 @section Setting tags
4862 @cindex setting tags
4863 @cindex tags, setting
4866 Tags can simply be typed into the buffer at the end of a headline.
4867 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4868 also a special command for inserting tags:
4871 @orgcmd{C-c C-q,org-set-tags-command}
4872 @cindex completion, of tags
4873 @vindex org-tags-column
4874 Enter new tags for the current headline. Org mode will either offer
4875 completion or a special single-key interface for setting tags, see
4876 below. After pressing @key{RET}, the tags will be inserted and aligned
4877 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4878 tags in the current buffer will be aligned to that column, just to make
4879 things look nice. TAGS are automatically realigned after promotion,
4880 demotion, and TODO state changes (@pxref{TODO basics}).
4882 @orgcmd{C-c C-c,org-set-tags-command}
4883 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4886 @vindex org-tag-alist
4887 Org supports tag insertion based on a @emph{list of tags}. By
4888 default this list is constructed dynamically, containing all tags
4889 currently used in the buffer. You may also globally specify a hard list
4890 of tags with the variable @code{org-tag-alist}. Finally you can set
4891 the default tags for a given file with lines like
4895 #+TAGS: @@work @@home @@tennisclub
4896 #+TAGS: laptop car pc sailboat
4899 If you have globally defined your preferred set of tags using the
4900 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4901 in a specific file, add an empty TAGS option line to that file:
4907 @vindex org-tag-persistent-alist
4908 If you have a preferred set of tags that you would like to use in every file,
4909 in addition to those defined on a per-file basis by TAGS option lines, then
4910 you may specify a list of tags with the variable
4911 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4912 by adding a STARTUP option line to that file:
4918 By default Org mode uses the standard minibuffer completion facilities for
4919 entering tags. However, it also implements another, quicker, tag selection
4920 method called @emph{fast tag selection}. This allows you to select and
4921 deselect tags with just a single key press. For this to work well you should
4922 assign unique letters to most of your commonly used tags. You can do this
4923 globally by configuring the variable @code{org-tag-alist} in your
4924 @file{.emacs} file. For example, you may find the need to tag many items in
4925 different files with @samp{:@@home:}. In this case you can set something
4929 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4932 @noindent If the tag is only relevant to the file you are working on, then you
4933 can instead set the TAGS option line as:
4936 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4939 @noindent The tags interface will show the available tags in a splash
4940 window. If you want to start a new line after a specific tag, insert
4941 @samp{\n} into the tag list
4944 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4947 @noindent or write them in two lines:
4950 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4951 #+TAGS: laptop(l) pc(p)
4955 You can also group together tags that are mutually exclusive by using
4959 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4962 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4963 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4965 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4966 these lines to activate any changes.
4969 To set these mutually exclusive groups in the variable @code{org-tag-alist},
4970 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4971 of the braces. Similarly, you can use @code{:newline} to indicate a line
4972 break. The previous example would be set globally by the following
4976 (setq org-tag-alist '((:startgroup . nil)
4977 ("@@work" . ?w) ("@@home" . ?h)
4978 ("@@tennisclub" . ?t)
4980 ("laptop" . ?l) ("pc" . ?p)))
4983 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4984 automatically present you with a special interface, listing inherited tags,
4985 the tags of the current headline, and a list of all valid tags with
4986 corresponding keys@footnote{Keys will automatically be assigned to tags which
4987 have no configured keys.}. In this interface, you can use the following
4992 Pressing keys assigned to tags will add or remove them from the list of
4993 tags in the current line. Selecting a tag in a group of mutually
4994 exclusive tags will turn off any other tags from that group.
4997 Enter a tag in the minibuffer, even if the tag is not in the predefined
4998 list. You will be able to complete on all tags present in the buffer.
4999 You can also add several tags: just separate them with a comma.
5003 Clear all tags for this line.
5006 Accept the modified set.
5008 Abort without installing changes.
5010 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5012 Turn off groups of mutually exclusive tags. Use this to (as an
5013 exception) assign several tags from such a group.
5015 Toggle auto-exit after the next change (see below).
5016 If you are using expert mode, the first @kbd{C-c} will display the
5021 This method lets you assign tags to a headline with very few keys. With
5022 the above setup, you could clear the current tags and set @samp{@@home},
5023 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5024 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
5025 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5026 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
5027 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5028 @key{RET} @key{RET}}.
5030 @vindex org-fast-tag-selection-single-key
5031 If you find that most of the time you need only a single key press to
5032 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5033 Then you no longer have to press @key{RET} to exit fast tag selection---it
5034 will immediately exit after the first change. If you then occasionally
5035 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5036 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5037 instead of @kbd{C-c C-c}). If you set the variable to the value
5038 @code{expert}, the special window is not even shown for single-key tag
5039 selection, it comes up only when you press an extra @kbd{C-c}.
5041 @node Tag groups, Tag searches, Setting tags, Tags
5045 @cindex tags, groups
5046 In a set of mutually exclusive tags, the first tag can be defined as a
5047 @emph{group tag}. When you search for a group tag, it will return matches
5048 for all members in the group. In an agenda view, filtering by a group tag
5049 will display headlines tagged with at least one of the members of the
5050 group. This makes tag searches and filters even more flexible.
5052 You can set group tags by inserting a colon between the group tag and other
5053 tags---beware that all whitespaces are mandatory so that Org can parse this
5057 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5060 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5061 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5063 You can also use the @code{:grouptags} keyword directly when setting
5064 @code{org-tag-alist}:
5067 (setq org-tag-alist '((:startgroup . nil)
5070 ("@@read_book" . nil)
5071 ("@@read_ebook" . nil)
5075 You cannot nest group tags or use a group tag as a tag in another group.
5078 @vindex org-group-tags
5079 If you want to ignore group tags temporarily, toggle group tags support
5080 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5081 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5083 @node Tag searches, , Tag groups, Tags
5084 @section Tag searches
5085 @cindex tag searches
5086 @cindex searching for tags
5088 Once a system of tags has been set up, it can be used to collect related
5089 information into special lists.
5092 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5093 Create a sparse tree with all headlines matching a tags search. With a
5094 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5095 @orgcmd{C-c a m,org-tags-view}
5096 Create a global list of tag matches from all agenda files.
5097 @xref{Matching tags and properties}.
5098 @orgcmd{C-c a M,org-tags-view}
5099 @vindex org-tags-match-list-sublevels
5100 Create a global list of tag matches from all agenda files, but check
5101 only TODO items and force checking subitems (see the option
5102 @code{org-tags-match-list-sublevels}).
5105 These commands all prompt for a match string which allows basic Boolean logic
5106 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5107 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5108 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5109 string is rich and allows also matching against TODO keywords, entry levels
5110 and properties. For a complete description with many examples, see
5111 @ref{Matching tags and properties}.
5114 @node Properties and Columns, Dates and Times, Tags, Top
5115 @chapter Properties and columns
5118 A property is a key-value pair associated with an entry. Properties can be
5119 set so they are associated with a single entry, with every entry in a tree,
5120 or with every entry in an Org mode file.
5122 There are two main applications for properties in Org mode. First,
5123 properties are like tags, but with a value. Imagine maintaining a file where
5124 you document bugs and plan releases for a piece of software. Instead of
5125 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5126 property, say @code{:Release:}, that in different subtrees has different
5127 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5128 implement (very basic) database capabilities in an Org buffer. Imagine
5129 keeping track of your music CDs, where properties could be things such as the
5130 album, artist, date of release, number of tracks, and so on.
5132 Properties can be conveniently edited and viewed in column view
5133 (@pxref{Column view}).
5136 * Property syntax:: How properties are spelled out
5137 * Special properties:: Access to other Org mode features
5138 * Property searches:: Matching property values
5139 * Property inheritance:: Passing values down the tree
5140 * Column view:: Tabular viewing and editing
5141 * Property API:: Properties for Lisp programmers
5144 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
5145 @section Property syntax
5146 @cindex property syntax
5147 @cindex drawer, for properties
5149 Properties are key-value pairs. When they are associated with a single entry
5150 or with a tree they need to be inserted into a special
5151 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
5152 is specified on a single line, with the key (surrounded by colons)
5153 first, and the value after it. Here is an example:
5158 *** Goldberg Variations
5160 :Title: Goldberg Variations
5161 :Composer: J.S. Bach
5163 :Publisher: Deutsche Grammophon
5168 Depending on the value of @code{org-use-property-inheritance}, a property set
5169 this way will either be associated with a single entry, or the sub-tree
5170 defined by the entry, see @ref{Property inheritance}.
5172 You may define the allowed values for a particular property @samp{:Xyz:}
5173 by setting a property @samp{:Xyz_ALL:}. This special property is
5174 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5175 the entire tree. When allowed values are defined, setting the
5176 corresponding property becomes easier and is less prone to typing
5177 errors. For the example with the CD collection, we can predefine
5178 publishers and the number of disks in a box like this:
5183 :NDisks_ALL: 1 2 3 4
5184 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5188 If you want to set properties that can be inherited by any entry in a
5189 file, use a line like
5190 @cindex property, _ALL
5193 #+PROPERTY: NDisks_ALL 1 2 3 4
5196 Contrary to properties set from a special drawer, you have to refresh the
5197 buffer with @kbd{C-c C-c} to activate this changes.
5199 If you want to add to the value of an existing property, append a @code{+} to
5200 the property name. The following results in the property @code{var} having
5201 the value ``foo=1 bar=2''.
5204 #+PROPERTY: var foo=1
5205 #+PROPERTY: var+ bar=2
5208 It is also possible to add to the values of inherited properties. The
5209 following results in the @code{genres} property having the value ``Classic
5210 Baroque'' under the @code{Goldberg Variations} subtree.
5218 *** Goldberg Variations
5220 :Title: Goldberg Variations
5221 :Composer: J.S. Bach
5223 :Publisher: Deutsche Grammophon
5228 Note that a property can only have one entry per Drawer.
5230 @vindex org-global-properties
5231 Property values set with the global variable
5232 @code{org-global-properties} can be inherited by all entries in all
5236 The following commands help to work with properties:
5239 @orgcmd{M-@key{TAB},pcomplete}
5240 After an initial colon in a line, complete property keys. All keys used
5241 in the current file will be offered as possible completions.
5242 @orgcmd{C-c C-x p,org-set-property}
5243 Set a property. This prompts for a property name and a value. If
5244 necessary, the property drawer is created as well.
5245 @item C-u M-x org-insert-drawer RET
5246 @cindex org-insert-drawer
5247 Insert a property drawer into the current entry. The drawer will be
5248 inserted early in the entry, but after the lines with planning
5249 information like deadlines.
5250 @orgcmd{C-c C-c,org-property-action}
5251 With the cursor in a property drawer, this executes property commands.
5252 @orgcmd{C-c C-c s,org-set-property}
5253 Set a property in the current entry. Both the property and the value
5254 can be inserted using completion.
5255 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5256 Switch property at point to the next/previous allowed value.
5257 @orgcmd{C-c C-c d,org-delete-property}
5258 Remove a property from the current entry.
5259 @orgcmd{C-c C-c D,org-delete-property-globally}
5260 Globally remove a property, from all entries in the current file.
5261 @orgcmd{C-c C-c c,org-compute-property-at-point}
5262 Compute the property at point, using the operator and scope from the
5263 nearest column format definition.
5266 @node Special properties, Property searches, Property syntax, Properties and Columns
5267 @section Special properties
5268 @cindex properties, special
5270 Special properties provide an alternative access method to Org mode features,
5271 like the TODO state or the priority of an entry, discussed in the previous
5272 chapters. This interface exists so that you can include these states in a
5273 column view (@pxref{Column view}), or to use them in queries. The following
5274 property names are special and (except for @code{:CATEGORY:}) should not be
5275 used as keys in the properties drawer:
5277 @cindex property, special, ID
5278 @cindex property, special, TODO
5279 @cindex property, special, TAGS
5280 @cindex property, special, ALLTAGS
5281 @cindex property, special, CATEGORY
5282 @cindex property, special, PRIORITY
5283 @cindex property, special, DEADLINE
5284 @cindex property, special, SCHEDULED
5285 @cindex property, special, CLOSED
5286 @cindex property, special, TIMESTAMP
5287 @cindex property, special, TIMESTAMP_IA
5288 @cindex property, special, CLOCKSUM
5289 @cindex property, special, CLOCKSUM_T
5290 @cindex property, special, BLOCKED
5291 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5292 @cindex property, special, ITEM
5293 @cindex property, special, FILE
5295 ID @r{A globally unique ID used for synchronization during}
5296 @r{iCalendar or MobileOrg export.}
5297 TODO @r{The TODO keyword of the entry.}
5298 TAGS @r{The tags defined directly in the headline.}
5299 ALLTAGS @r{All tags, including inherited ones.}
5300 CATEGORY @r{The category of an entry.}
5301 PRIORITY @r{The priority of the entry, a string with a single letter.}
5302 DEADLINE @r{The deadline time string, without the angular brackets.}
5303 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5304 CLOSED @r{When was this entry closed?}
5305 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5306 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5307 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5308 @r{must be run first to compute the values in the current buffer.}
5309 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5310 @r{@code{org-clock-sum-today} must be run first to compute the}
5311 @r{values in the current buffer.}
5312 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5313 ITEM @r{The headline of the entry.}
5314 FILE @r{The filename the entry is located in.}
5317 @node Property searches, Property inheritance, Special properties, Properties and Columns
5318 @section Property searches
5319 @cindex properties, searching
5320 @cindex searching, of properties
5322 To create sparse trees and special lists with selection based on properties,
5323 the same commands are used as for tag searches (@pxref{Tag searches}).
5326 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5327 Create a sparse tree with all matching entries. With a
5328 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5329 @orgcmd{C-c a m,org-tags-view}
5330 Create a global list of tag/property matches from all agenda files.
5331 @xref{Matching tags and properties}.
5332 @orgcmd{C-c a M,org-tags-view}
5333 @vindex org-tags-match-list-sublevels
5334 Create a global list of tag matches from all agenda files, but check
5335 only TODO items and force checking of subitems (see the option
5336 @code{org-tags-match-list-sublevels}).
5339 The syntax for the search string is described in @ref{Matching tags and
5342 There is also a special command for creating sparse trees based on a
5347 Create a sparse tree based on the value of a property. This first
5348 prompts for the name of a property, and then for a value. A sparse tree
5349 is created with all entries that define this property with the given
5350 value. If you enclose the value in curly braces, it is interpreted as
5351 a regular expression and matched against the property values.
5354 @node Property inheritance, Column view, Property searches, Properties and Columns
5355 @section Property Inheritance
5356 @cindex properties, inheritance
5357 @cindex inheritance, of properties
5359 @vindex org-use-property-inheritance
5360 The outline structure of Org mode documents lends itself to an
5361 inheritance model of properties: if the parent in a tree has a certain
5362 property, the children can inherit this property. Org mode does not
5363 turn this on by default, because it can slow down property searches
5364 significantly and is often not needed. However, if you find inheritance
5365 useful, you can turn it on by setting the variable
5366 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5367 all properties inherited from the parent, to a list of properties
5368 that should be inherited, or to a regular expression that matches
5369 inherited properties. If a property has the value @code{nil}, this is
5370 interpreted as an explicit undefine of the property, so that inheritance
5371 search will stop at this value and return @code{nil}.
5373 Org mode has a few properties for which inheritance is hard-coded, at
5374 least for the special applications for which they are used:
5376 @cindex property, COLUMNS
5379 The @code{:COLUMNS:} property defines the format of column view
5380 (@pxref{Column view}). It is inherited in the sense that the level
5381 where a @code{:COLUMNS:} property is defined is used as the starting
5382 point for a column view table, independently of the location in the
5383 subtree from where columns view is turned on.
5385 @cindex property, CATEGORY
5386 For agenda view, a category set through a @code{:CATEGORY:} property
5387 applies to the entire subtree.
5389 @cindex property, ARCHIVE
5390 For archiving, the @code{:ARCHIVE:} property may define the archive
5391 location for the entire subtree (@pxref{Moving subtrees}).
5393 @cindex property, LOGGING
5394 The LOGGING property may define logging settings for an entry or a
5395 subtree (@pxref{Tracking TODO state changes}).
5398 @node Column view, Property API, Property inheritance, Properties and Columns
5399 @section Column view
5401 A great way to view and edit properties in an outline tree is
5402 @emph{column view}. In column view, each outline node is turned into a
5403 table row. Columns in this table provide access to properties of the
5404 entries. Org mode implements columns by overlaying a tabular structure
5405 over the headline of each item. While the headlines have been turned
5406 into a table row, you can still change the visibility of the outline
5407 tree. For example, you get a compact table by switching to CONTENTS
5408 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5409 is active), but you can still open, read, and edit the entry below each
5410 headline. Or, you can switch to column view after executing a sparse
5411 tree command and in this way get a table only for the selected items.
5412 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5413 queries have collected selected items, possibly from a number of files.
5416 * Defining columns:: The COLUMNS format property
5417 * Using column view:: How to create and use column view
5418 * Capturing column view:: A dynamic block for column view
5421 @node Defining columns, Using column view, Column view, Column view
5422 @subsection Defining columns
5423 @cindex column view, for properties
5424 @cindex properties, column view
5426 Setting up a column view first requires defining the columns. This is
5427 done by defining a column format line.
5430 * Scope of column definitions:: Where defined, where valid?
5431 * Column attributes:: Appearance and content of a column
5434 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5435 @subsubsection Scope of column definitions
5437 To define a column format for an entire file, use a line like
5441 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5444 To specify a format that only applies to a specific tree, add a
5445 @code{:COLUMNS:} property to the top node of that tree, for example:
5448 ** Top node for columns view
5450 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5454 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5455 for the entry itself, and for the entire subtree below it. Since the
5456 column definition is part of the hierarchical structure of the document,
5457 you can define columns on level 1 that are general enough for all
5458 sublevels, and more specific columns further down, when you edit a
5459 deeper part of the tree.
5461 @node Column attributes, , Scope of column definitions, Defining columns
5462 @subsubsection Column attributes
5463 A column definition sets the attributes of a column. The general
5464 definition looks like this:
5467 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5471 Except for the percent sign and the property name, all items are
5472 optional. The individual parts have the following meaning:
5475 @var{width} @r{An integer specifying the width of the column in characters.}
5476 @r{If omitted, the width will be determined automatically.}
5477 @var{property} @r{The property that should be edited in this column.}
5478 @r{Special properties representing meta data are allowed here}
5479 @r{as well (@pxref{Special properties})}
5480 @var{title} @r{The header text for the column. If omitted, the property}
5482 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5483 @r{parent nodes are computed from the children.}
5484 @r{Supported summary types are:}
5485 @{+@} @r{Sum numbers in this column.}
5486 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5487 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5488 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5489 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5490 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5491 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5492 @{min@} @r{Smallest number in column.}
5493 @{max@} @r{Largest number.}
5494 @{mean@} @r{Arithmetic mean of numbers.}
5495 @{:min@} @r{Smallest time value in column.}
5496 @{:max@} @r{Largest time value.}
5497 @{:mean@} @r{Arithmetic mean of time values.}
5498 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5499 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5500 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5501 @{est+@} @r{Add low-high estimates.}
5505 Be aware that you can only have one summary type for any property you
5506 include. Subsequent columns referencing the same property will all display the
5507 same summary information.
5509 The @code{est+} summary type requires further explanation. It is used for
5510 combining estimates, expressed as low-high ranges. For example, instead
5511 of estimating a particular task will take 5 days, you might estimate it as
5512 5--6 days if you're fairly confident you know how much work is required, or
5513 1--10 days if you don't really know what needs to be done. Both ranges
5514 average at 5.5 days, but the first represents a more predictable delivery.
5516 When combining a set of such estimates, simply adding the lows and highs
5517 produces an unrealistically wide result. Instead, @code{est+} adds the
5518 statistical mean and variance of the sub-tasks, generating a final estimate
5519 from the sum. For example, suppose you had ten tasks, each of which was
5520 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5521 of 5 to 20 days, representing what to expect if everything goes either
5522 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5523 full job more realistically, at 10--15 days.
5525 Here is an example for a complete columns definition, along with allowed
5529 :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.}
5530 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5531 :Owner_ALL: Tammy Mark Karl Lisa Don
5532 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5533 :Approved_ALL: "[ ]" "[X]"
5537 The first column, @samp{%25ITEM}, means the first 25 characters of the
5538 item itself, i.e., of the headline. You probably always should start the
5539 column definition with the @samp{ITEM} specifier. The other specifiers
5540 create columns @samp{Owner} with a list of names as allowed values, for
5541 @samp{Status} with four different possible values, and for a checkbox
5542 field @samp{Approved}. When no width is given after the @samp{%}
5543 character, the column will be exactly as wide as it needs to be in order
5544 to fully display all values. The @samp{Approved} column does have a
5545 modified title (@samp{Approved?}, with a question mark). Summaries will
5546 be created for the @samp{Time_Estimate} column by adding time duration
5547 expressions like HH:MM, and for the @samp{Approved} column, by providing
5548 an @samp{[X]} status if all children have been checked. The
5549 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5550 sums of CLOCK intervals in the subtree, either for all clocks or just for
5553 @node Using column view, Capturing column view, Defining columns, Column view
5554 @subsection Using column view
5557 @tsubheading{Turning column view on and off}
5558 @orgcmd{C-c C-x C-c,org-columns}
5559 @vindex org-columns-default-format
5560 Turn on column view. If the cursor is before the first headline in the file,
5561 column view is turned on for the entire file, using the @code{#+COLUMNS}
5562 definition. If the cursor is somewhere inside the outline, this command
5563 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5564 defines a format. When one is found, the column view table is established
5565 for the tree starting at the entry that contains the @code{:COLUMNS:}
5566 property. If no such property is found, the format is taken from the
5567 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5568 and column view is established for the current entry and its subtree.
5569 @orgcmd{r,org-columns-redo}
5570 Recreate the column view, to include recent changes made in the buffer.
5571 @orgcmd{g,org-columns-redo}
5573 @orgcmd{q,org-columns-quit}
5575 @tsubheading{Editing values}
5576 @item @key{left} @key{right} @key{up} @key{down}
5577 Move through the column view from field to field.
5578 @kindex S-@key{left}
5579 @kindex S-@key{right}
5580 @item S-@key{left}/@key{right}
5581 Switch to the next/previous allowed value of the field. For this, you
5582 have to have specified allowed values for a property.
5584 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5585 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5586 Same as @kbd{S-@key{left}/@key{right}}
5587 @orgcmd{e,org-columns-edit-value}
5588 Edit the property at point. For the special properties, this will
5589 invoke the same interface that you normally use to change that
5590 property. For example, when editing a TAGS property, the tag completion
5591 or fast selection interface will pop up.
5592 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5593 When there is a checkbox at point, toggle it.
5594 @orgcmd{v,org-columns-show-value}
5595 View the full value of this property. This is useful if the width of
5596 the column is smaller than that of the value.
5597 @orgcmd{a,org-columns-edit-allowed}
5598 Edit the list of allowed values for this property. If the list is found
5599 in the hierarchy, the modified values is stored there. If no list is
5600 found, the new value is stored in the first entry that is part of the
5601 current column view.
5602 @tsubheading{Modifying the table structure}
5603 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5604 Make the column narrower/wider by one character.
5605 @orgcmd{S-M-@key{right},org-columns-new}
5606 Insert a new column, to the left of the current column.
5607 @orgcmd{S-M-@key{left},org-columns-delete}
5608 Delete the current column.
5611 @node Capturing column view, , Using column view, Column view
5612 @subsection Capturing column view
5614 Since column view is just an overlay over a buffer, it cannot be
5615 exported or printed directly. If you want to capture a column view, use
5616 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5617 of this block looks like this:
5619 @cindex #+BEGIN, columnview
5622 #+BEGIN: columnview :hlines 1 :id "label"
5627 @noindent This dynamic block has the following parameters:
5631 This is the most important parameter. Column view is a feature that is
5632 often localized to a certain (sub)tree, and the capture block might be
5633 at a different location in the file. To identify the tree whose view to
5634 capture, you can use 4 values:
5635 @cindex property, ID
5637 local @r{use the tree in which the capture block is located}
5638 global @r{make a global view, including all headings in the file}
5639 "file:@var{path-to-file}"
5640 @r{run column view at the top of this file}
5641 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5642 @r{property with the value @i{label}. You can use}
5643 @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5644 @r{the current entry and copy it to the kill-ring.}
5647 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5648 an hline before each headline with level @code{<= @var{N}}.
5650 When set to @code{t}, force column groups to get vertical lines.
5652 When set to a number, don't capture entries below this level.
5653 @item :skip-empty-rows
5654 When set to @code{t}, skip rows where the only non-empty specifier of the
5655 column view is @code{ITEM}.
5660 The following commands insert or update the dynamic block:
5663 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5664 Insert a dynamic block capturing a column view. You will be prompted
5665 for the scope or ID of the view.
5666 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5667 Update dynamic block at point. The cursor needs to be in the
5668 @code{#+BEGIN} line of the dynamic block.
5669 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5670 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5671 you have several clock table blocks, column-capturing blocks or other dynamic
5675 You can add formulas to the column view table and you may add plotting
5676 instructions in front of the table---these will survive an update of the
5677 block. If there is a @code{#+TBLFM:} after the table, the table will
5678 actually be recalculated automatically after an update.
5680 An alternative way to capture and process property values into a table is
5681 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5682 package@footnote{Contributed packages are not part of Emacs, but are
5683 distributed with the main distribution of Org (visit
5684 @uref{http://orgmode.org}).}. It provides a general API to collect
5685 properties from entries in a certain scope, and arbitrary Lisp expressions to
5686 process these values before inserting them into a table or a dynamic block.
5688 @node Property API, , Column view, Properties and Columns
5689 @section The Property API
5690 @cindex properties, API
5691 @cindex API, for properties
5693 There is a full API for accessing and changing properties. This API can
5694 be used by Emacs Lisp programs to work with properties and to implement
5695 features based on them. For more information see @ref{Using the
5698 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5699 @chapter Dates and times
5705 To assist project planning, TODO items can be labeled with a date and/or
5706 a time. The specially formatted string carrying the date and time
5707 information is called a @emph{timestamp} in Org mode. This may be a
5708 little confusing because timestamp is often used as indicating when
5709 something was created or last changed. However, in Org mode this term
5710 is used in a much wider sense.
5713 * Timestamps:: Assigning a time to a tree entry
5714 * Creating timestamps:: Commands which insert timestamps
5715 * Deadlines and scheduling:: Planning your work
5716 * Clocking work time:: Tracking how long you spend on a task
5717 * Effort estimates:: Planning work effort in advance
5718 * Relative timer:: Notes with a running timer
5719 * Countdown timer:: Starting a countdown timer for a task
5723 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5724 @section Timestamps, deadlines, and scheduling
5726 @cindex ranges, time
5731 A timestamp is a specification of a date (possibly with a time or a range of
5732 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5733 simplest form, the day name is optional when you type the date yourself.
5734 However, any dates inserted or modified by Org will add that day name, for
5735 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5736 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5737 date/time format. To use an alternative format, see @ref{Custom time
5738 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5739 tree entry. Its presence causes entries to be shown on specific dates in the
5740 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5743 @item Plain timestamp; Event; Appointment
5746 A simple timestamp just assigns a date/time to an item. This is just
5747 like writing down an appointment or event in a paper agenda. In the
5748 timeline and agenda displays, the headline of an entry associated with a
5749 plain timestamp will be shown exactly on that date.
5752 * Meet Peter at the movies
5753 <2006-11-01 Wed 19:15>
5754 * Discussion on climate change
5755 <2006-11-02 Thu 20:00-22:00>
5758 @item Timestamp with repeater interval
5759 @cindex timestamp, with repeater interval
5760 A timestamp may contain a @emph{repeater interval}, indicating that it
5761 applies not only on the given date, but again and again after a certain
5762 interval of N days (d), weeks (w), months (m), or years (y). The
5763 following will show up in the agenda every Wednesday:
5766 * Pick up Sam at school
5767 <2007-05-16 Wed 12:30 +1w>
5770 @item Diary-style sexp entries
5771 For more complex date specifications, Org mode supports using the special
5772 sexp diary entries implemented in the Emacs calendar/diary
5773 package@footnote{When working with the standard diary sexp functions, you
5774 need to be very careful with the order of the arguments. That order depend
5775 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5776 versions, @code{european-calendar-style}). For example, to specify a date
5777 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5778 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5779 the settings. This has been the source of much confusion. Org mode users
5780 can resort to special versions of these functions like @code{org-date} or
5781 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5782 functions, but with stable ISO order of arguments (year, month, day) wherever
5783 applicable, independent of the value of @code{calendar-date-style}.}. For
5784 example with optional time
5787 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5788 <%%(diary-float t 4 2)>
5791 @item Time/Date range
5794 Two timestamps connected by @samp{--} denote a range. The headline
5795 will be shown on the first and last day of the range, and on any dates
5796 that are displayed and fall in the range. Here is an example:
5799 ** Meeting in Amsterdam
5800 <2004-08-23 Mon>--<2004-08-26 Thu>
5803 @item Inactive timestamp
5804 @cindex timestamp, inactive
5805 @cindex inactive timestamp
5806 Just like a plain timestamp, but with square brackets instead of
5807 angular ones. These timestamps are inactive in the sense that they do
5808 @emph{not} trigger an entry to show up in the agenda.
5811 * Gillian comes late for the fifth time
5817 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5818 @section Creating timestamps
5819 @cindex creating timestamps
5820 @cindex timestamps, creating
5822 For Org mode to recognize timestamps, they need to be in the specific
5823 format. All commands listed below produce timestamps in the correct
5827 @orgcmd{C-c .,org-time-stamp}
5828 Prompt for a date and insert a corresponding timestamp. When the cursor is
5829 at an existing timestamp in the buffer, the command is used to modify this
5830 timestamp instead of inserting a new one. When this command is used twice in
5831 succession, a time range is inserted.
5833 @orgcmd{C-c !,org-time-stamp-inactive}
5834 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5841 @vindex org-time-stamp-rounding-minutes
5842 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5843 contains date and time. The default time can be rounded to multiples of 5
5844 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5847 Normalize timestamp, insert/fix day name if missing or wrong.
5849 @orgcmd{C-c <,org-date-from-calendar}
5850 Insert a timestamp corresponding to the cursor date in the Calendar.
5852 @orgcmd{C-c >,org-goto-calendar}
5853 Access the Emacs calendar for the current date. If there is a
5854 timestamp in the current line, go to the corresponding date
5857 @orgcmd{C-c C-o,org-open-at-point}
5858 Access the agenda for the date given by the timestamp or -range at
5859 point (@pxref{Weekly/daily agenda}).
5861 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5862 Change date at cursor by one day. These key bindings conflict with
5863 shift-selection and related modes (@pxref{Conflicts}).
5865 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5866 Change the item under the cursor in a timestamp. The cursor can be on a
5867 year, month, day, hour or minute. When the timestamp contains a time range
5868 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5869 shifting the time block with constant length. To change the length, modify
5870 the second time. Note that if the cursor is in a headline and not at a
5871 timestamp, these same keys modify the priority of an item.
5872 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5873 related modes (@pxref{Conflicts}).
5875 @orgcmd{C-c C-y,org-evaluate-time-range}
5876 @cindex evaluate time range
5877 Evaluate a time range by computing the difference between start and end.
5878 With a prefix argument, insert result after the time range (in a table: into
5879 the following column).
5884 * The date/time prompt:: How Org mode helps you entering date and time
5885 * Custom time format:: Making dates look different
5888 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5889 @subsection The date/time prompt
5890 @cindex date, reading in minibuffer
5891 @cindex time, reading in minibuffer
5893 @vindex org-read-date-prefer-future
5894 When Org mode prompts for a date/time, the default is shown in default
5895 date/time format, and the prompt therefore seems to ask for a specific
5896 format. But it will in fact accept date/time information in a variety of
5897 formats. Generally, the information should start at the beginning of the
5898 string. Org mode will find whatever information is in
5899 there and derive anything you have not specified from the @emph{default date
5900 and time}. The default is usually the current date and time, but when
5901 modifying an existing timestamp, or when entering the second stamp of a
5902 range, it is taken from the stamp in the buffer. When filling in
5903 information, Org mode assumes that most of the time you will want to enter a
5904 date in the future: if you omit the month/year and the given day/month is
5905 @i{before} today, it will assume that you mean a future date@footnote{See the
5906 variable @code{org-read-date-prefer-future}. You may set that variable to
5907 the symbol @code{time} to even make a time before now shift the date to
5908 tomorrow.}. If the date has been automatically shifted into the future, the
5909 time prompt will show this with @samp{(=>F).}
5911 For example, let's assume that today is @b{June 13, 2006}. Here is how
5912 various inputs will be interpreted, the items filled in by Org mode are
5916 3-2-5 @result{} 2003-02-05
5917 2/5/3 @result{} 2003-02-05
5918 14 @result{} @b{2006}-@b{06}-14
5919 12 @result{} @b{2006}-@b{07}-12
5920 2/5 @result{} @b{2007}-02-05
5921 Fri @result{} nearest Friday after the default date
5922 sep 15 @result{} @b{2006}-09-15
5923 feb 15 @result{} @b{2007}-02-15
5924 sep 12 9 @result{} 2009-09-12
5925 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5926 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5927 w4 @result{} ISO week for of the current year @b{2006}
5928 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5929 2012-w04-5 @result{} Same as above
5932 Furthermore you can specify a relative date by giving, as the @emph{first}
5933 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5934 indicate change in hours, days, weeks, months, or years. With a single plus
5935 or minus, the date is always relative to today. With a double plus or minus,
5936 it is relative to the default date. If instead of a single letter, you use
5937 the abbreviation of day name, the date will be the Nth such day, e.g.:
5942 +4d @result{} four days from today
5943 +4 @result{} same as above
5944 +2w @result{} two weeks from today
5945 ++5 @result{} five days from default date
5946 +2tue @result{} second Tuesday from now
5947 -wed @result{} last Wednesday
5950 @vindex parse-time-months
5951 @vindex parse-time-weekdays
5952 The function understands English month and weekday abbreviations. If
5953 you want to use unabbreviated names and/or other languages, configure
5954 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5956 @vindex org-read-date-force-compatible-dates
5957 Not all dates can be represented in a given Emacs implementation. By default
5958 Org mode forces dates into the compatibility range 1970--2037 which works on
5959 all Emacs implementations. If you want to use dates outside of this range,
5960 read the docstring of the variable
5961 @code{org-read-date-force-compatible-dates}.
5963 You can specify a time range by giving start and end times or by giving a
5964 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5965 separator in the former case and use '+' as the separator in the latter
5969 11am-1:15pm @result{} 11:00-13:15
5970 11am--1:15pm @result{} same as above
5971 11am+2:15 @result{} same as above
5974 @cindex calendar, for selecting date
5975 @vindex org-popup-calendar-for-date-prompt
5976 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5977 you don't need/want the calendar, configure the variable
5978 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5979 prompt, either by clicking on a date in the calendar, or by pressing
5980 @key{RET}, the date selected in the calendar will be combined with the
5981 information entered at the prompt. You can control the calendar fully
5982 from the minibuffer:
5989 @kindex S-@key{right}
5990 @kindex S-@key{left}
5991 @kindex S-@key{down}
5993 @kindex M-S-@key{right}
5994 @kindex M-S-@key{left}
5997 @key{RET} @r{Choose date at cursor in calendar.}
5998 mouse-1 @r{Select date by clicking on it.}
5999 S-@key{right}/@key{left} @r{One day forward/backward.}
6000 S-@key{down}/@key{up} @r{One week forward/backward.}
6001 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6002 > / < @r{Scroll calendar forward/backward by one month.}
6003 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
6006 @vindex org-read-date-display-live
6007 The actions of the date/time prompt may seem complex, but I assure you they
6008 will grow on you, and you will start getting annoyed by pretty much any other
6009 way of entering a date/time out there. To help you understand what is going
6010 on, the current interpretation of your input will be displayed live in the
6011 minibuffer@footnote{If you find this distracting, turn the display off with
6012 @code{org-read-date-display-live}.}.
6014 @node Custom time format, , The date/time prompt, Creating timestamps
6015 @subsection Custom time format
6016 @cindex custom date/time format
6017 @cindex time format, custom
6018 @cindex date format, custom
6020 @vindex org-display-custom-times
6021 @vindex org-time-stamp-custom-formats
6022 Org mode uses the standard ISO notation for dates and times as it is
6023 defined in ISO 8601. If you cannot get used to this and require another
6024 representation of date and time to keep you happy, you can get it by
6025 customizing the options @code{org-display-custom-times} and
6026 @code{org-time-stamp-custom-formats}.
6029 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6030 Toggle the display of custom formats for dates and times.
6034 Org mode needs the default format for scanning, so the custom date/time
6035 format does not @emph{replace} the default format---instead it is put
6036 @emph{over} the default format using text properties. This has the
6037 following consequences:
6040 You cannot place the cursor onto a timestamp anymore, only before or
6043 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6044 each component of a timestamp. If the cursor is at the beginning of
6045 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6046 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6047 time will be changed by one minute.
6049 If the timestamp contains a range of clock times or a repeater, these
6050 will not be overlaid, but remain in the buffer as they were.
6052 When you delete a timestamp character-by-character, it will only
6053 disappear from the buffer after @emph{all} (invisible) characters
6054 belonging to the ISO timestamp have been removed.
6056 If the custom timestamp format is longer than the default and you are
6057 using dates in tables, table alignment will be messed up. If the custom
6058 format is shorter, things do work as expected.
6062 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
6063 @section Deadlines and scheduling
6065 A timestamp may be preceded by special keywords to facilitate planning:
6069 @cindex DEADLINE keyword
6071 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6072 to be finished on that date.
6074 @vindex org-deadline-warning-days
6075 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6076 On the deadline date, the task will be listed in the agenda. In
6077 addition, the agenda for @emph{today} will carry a warning about the
6078 approaching or missed deadline, starting
6079 @code{org-deadline-warning-days} before the due date, and continuing
6080 until the entry is marked DONE@. An example:
6083 *** TODO write article about the Earth for the Guide
6084 DEADLINE: <2004-02-29 Sun>
6085 The editor in charge is [[bbdb:Ford Prefect]]
6088 You can specify a different lead time for warnings for a specific
6089 deadlines using the following syntax. Here is an example with a warning
6090 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6091 deactivated if the task get scheduled and you set
6092 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6095 @cindex SCHEDULED keyword
6097 Meaning: you are planning to start working on that task on the given
6100 @vindex org-agenda-skip-scheduled-if-done
6101 The headline will be listed under the given date@footnote{It will still
6102 be listed on that date after it has been marked DONE@. If you don't like
6103 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6104 addition, a reminder that the scheduled date has passed will be present
6105 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6106 the task will automatically be forwarded until completed.
6109 *** TODO Call Trillian for a date on New Years Eve.
6110 SCHEDULED: <2004-12-25 Sat>
6113 @vindex org-scheduled-delay-days
6114 @vindex org-agenda-skip-scheduled-delay-if-deadline
6115 If you want to @emph{delay} the display of this task in the agenda, use
6116 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6117 25th but will appear two days later. In case the task contains a repeater,
6118 the delay is considered to affect all occurrences; if you want the delay to
6119 only affect the first scheduled occurrence of the task, use @code{--2d}
6120 instead. See @code{org-scheduled-delay-days} and
6121 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6122 control this globally or per agenda.
6125 @b{Important:} Scheduling an item in Org mode should @i{not} be
6126 understood in the same way that we understand @i{scheduling a meeting}.
6127 Setting a date for a meeting is just a simple appointment, you should
6128 mark this entry with a simple plain timestamp, to get this item shown
6129 on the date where it applies. This is a frequent misunderstanding by
6130 Org users. In Org mode, @i{scheduling} means setting a date when you
6131 want to start working on an action item.
6134 You may use timestamps with repeaters in scheduling and deadline
6135 entries. Org mode will issue early and late warnings based on the
6136 assumption that the timestamp represents the @i{nearest instance} of
6137 the repeater. However, the use of diary sexp entries like
6139 @code{<%%(diary-float t 42)>}
6141 in scheduling and deadline timestamps is limited. Org mode does not
6142 know enough about the internals of each sexp function to issue early and
6143 late warnings. However, it will show the item on each day where the
6147 * Inserting deadline/schedule:: Planning items
6148 * Repeated tasks:: Items that show up again and again
6151 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
6152 @subsection Inserting deadlines or schedules
6154 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6155 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6156 any text between this line and the headline.} a deadline or to schedule
6161 @orgcmd{C-c C-d,org-deadline}
6162 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6163 in the line directly following the headline. Any CLOSED timestamp will be
6164 removed. When called with a prefix arg, an existing deadline will be removed
6165 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6166 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6167 and @code{nologredeadline}}, a note will be taken when changing an existing
6170 @orgcmd{C-c C-s,org-schedule}
6171 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6172 happen in the line directly following the headline. Any CLOSED timestamp
6173 will be removed. When called with a prefix argument, remove the scheduling
6174 date from the entry. Depending on the variable
6175 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6176 keywords @code{logreschedule}, @code{lognotereschedule}, and
6177 @code{nologreschedule}}, a note will be taken when changing an existing
6180 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
6183 Mark the current entry for agenda action. After you have marked the entry
6184 like this, you can open the agenda or the calendar to find an appropriate
6185 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
6186 schedule the marked item.
6188 @orgcmd{C-c / d,org-check-deadlines}
6189 @cindex sparse tree, for deadlines
6190 @vindex org-deadline-warning-days
6191 Create a sparse tree with all deadlines that are either past-due, or
6192 which will become due within @code{org-deadline-warning-days}.
6193 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6194 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6195 all deadlines due tomorrow.
6197 @orgcmd{C-c / b,org-check-before-date}
6198 Sparse tree for deadlines and scheduled items before a given date.
6200 @orgcmd{C-c / a,org-check-after-date}
6201 Sparse tree for deadlines and scheduled items after a given date.
6204 Note that @code{org-schedule} and @code{org-deadline} supports
6205 setting the date by indicating a relative time: e.g., +1d will set
6206 the date to the next day after today, and --1w will set the date
6207 to the previous week before any current timestamp.
6209 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
6210 @subsection Repeated tasks
6211 @cindex tasks, repeated
6212 @cindex repeated tasks
6214 Some tasks need to be repeated again and again. Org mode helps to
6215 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6216 or plain timestamp. In the following example
6218 ** TODO Pay the rent
6219 DEADLINE: <2005-10-01 Sat +1m>
6222 the @code{+1m} is a repeater; the intended interpretation is that the task
6223 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6224 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6225 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6226 and a special warning period in a deadline entry, the repeater should come
6227 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6229 @vindex org-todo-repeat-to-state
6230 Deadlines and scheduled items produce entries in the agenda when they are
6231 over-due, so it is important to be able to mark such an entry as completed
6232 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6233 keyword DONE, it will no longer produce entries in the agenda. The problem
6234 with this is, however, that then also the @emph{next} instance of the
6235 repeated entry will not be active. Org mode deals with this in the following
6236 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6237 shift the base date of the repeating timestamp by the repeater interval, and
6238 immediately set the entry state back to TODO@footnote{In fact, the target
6239 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6240 the variable @code{org-todo-repeat-to-state}. If neither of these is
6241 specified, the target state defaults to the first state of the TODO state
6242 sequence.}. In the example above, setting the state to DONE would actually
6243 switch the date like this:
6246 ** TODO Pay the rent
6247 DEADLINE: <2005-11-01 Tue +1m>
6250 @vindex org-log-repeat
6251 A timestamp@footnote{You can change this using the option
6252 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6253 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6254 will also be prompted for a note.} will be added under the deadline, to keep
6255 a record that you actually acted on the previous instance of this deadline.
6257 As a consequence of shifting the base date, this entry will no longer be
6258 visible in the agenda when checking past dates, but all future instances
6261 With the @samp{+1m} cookie, the date shift will always be exactly one
6262 month. So if you have not paid the rent for three months, marking this
6263 entry DONE will still keep it as an overdue deadline. Depending on the
6264 task, this may not be the best way to handle it. For example, if you
6265 forgot to call your father for 3 weeks, it does not make sense to call
6266 him 3 times in a single day to make up for it. Finally, there are tasks
6267 like changing batteries which should always repeat a certain time
6268 @i{after} the last time you did it. For these tasks, Org mode has
6269 special repeaters @samp{++} and @samp{.+}. For example:
6273 DEADLINE: <2008-02-10 Sun ++1w>
6274 Marking this DONE will shift the date by at least one week,
6275 but also by as many weeks as it takes to get this date into
6276 the future. However, it stays on a Sunday, even if you called
6277 and marked it done on Saturday.
6278 ** TODO Check the batteries in the smoke detectors
6279 DEADLINE: <2005-11-01 Tue .+1m>
6280 Marking this DONE will shift the date to one month after
6284 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6285 You may have both scheduling and deadline information for a specific task.
6286 If the repeater is set for the scheduling information only, you probably want
6287 the repeater to be ignored after the deadline. If so, set the variable
6288 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6289 @code{repeated-after-deadline}. If you want both scheduling and deadline
6290 information to repeat after the same interval, set the same repeater for both
6293 An alternative to using a repeater is to create a number of copies of a task
6294 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6295 created for this purpose, it is described in @ref{Structure editing}.
6298 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
6299 @section Clocking work time
6300 @cindex clocking time
6301 @cindex time clocking
6303 Org mode allows you to clock the time you spend on specific tasks in a
6304 project. When you start working on an item, you can start the clock. When
6305 you stop working on that task, or when you mark the task done, the clock is
6306 stopped and the corresponding time interval is recorded. It also computes
6307 the total time spent on each subtree@footnote{Clocking only works if all
6308 headings are indented with less than 30 stars. This is a hardcoded
6309 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6310 history or tasks recently clocked, to that you can jump quickly between a
6311 number of tasks absorbing your time.
6313 To save the clock history across Emacs sessions, use
6315 (setq org-clock-persist 'history)
6316 (org-clock-persistence-insinuate)
6318 When you clock into a new task after resuming Emacs, the incomplete
6319 clock@footnote{To resume the clock under the assumption that you have worked
6320 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6321 will be found (@pxref{Resolving idle time}) and you will be prompted about
6325 * Clocking commands:: Starting and stopping a clock
6326 * The clock table:: Detailed reports
6327 * Resolving idle time:: Resolving time when you've been idle
6330 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6331 @subsection Clocking commands
6334 @orgcmd{C-c C-x C-i,org-clock-in}
6335 @vindex org-clock-into-drawer
6336 @vindex org-clock-continuously
6337 @cindex property, LOG_INTO_DRAWER
6338 Start the clock on the current item (clock-in). This inserts the CLOCK
6339 keyword together with a timestamp. If this is not the first clocking of
6340 this item, the multiple CLOCK lines will be wrapped into a
6341 @code{:LOGBOOK:} drawer (see also the variable
6342 @code{org-clock-into-drawer}). You can also overrule
6343 the setting of this variable for a subtree by setting a
6344 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6345 When called with a @kbd{C-u} prefix argument,
6346 select the task from a list of recently clocked tasks. With two @kbd{C-u
6347 C-u} prefixes, clock into the task at point and mark it as the default task;
6348 the default task will then always be available with letter @kbd{d} when
6349 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6350 continuous clocking by starting the clock when the last clock stopped.@*
6351 @cindex property: CLOCK_MODELINE_TOTAL
6352 @cindex property: LAST_REPEAT
6353 @vindex org-clock-modeline-total
6354 While the clock is running, the current clocking time is shown in the mode
6355 line, along with the title of the task. The clock time shown will be all
6356 time ever clocked for this task and its children. If the task has an effort
6357 estimate (@pxref{Effort estimates}), the mode line displays the current
6358 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6359 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6360 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6361 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6362 will be shown. More control over what time is shown can be exercised with
6363 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6364 @code{current} to show only the current clocking instance, @code{today} to
6365 show all time clocked on this tasks today (see also the variable
6366 @code{org-extend-today-until}), @code{all} to include all time, or
6367 @code{auto} which is the default@footnote{See also the variable
6368 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6369 mode line entry will pop up a menu with clocking options.
6371 @orgcmd{C-c C-x C-o,org-clock-out}
6372 @vindex org-log-note-clock-out
6373 Stop the clock (clock-out). This inserts another timestamp at the same
6374 location where the clock was last started. It also directly computes
6375 the resulting time in inserts it after the time range as @samp{=>
6376 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6377 possibility to record an additional note together with the clock-out
6378 timestamp@footnote{The corresponding in-buffer setting is:
6379 @code{#+STARTUP: lognoteclock-out}}.
6380 @orgcmd{C-c C-x C-x,org-clock-in-last}
6381 @vindex org-clock-continuously
6382 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6383 select the task from the clock history. With two @kbd{C-u} prefixes,
6384 force continuous clocking by starting the clock when the last clock
6386 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6387 Update the effort estimate for the current clock task.
6390 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6391 Recompute the time interval after changing one of the timestamps. This
6392 is only necessary if you edit the timestamps directly. If you change
6393 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6394 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6395 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6396 clock duration keeps the same.
6397 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6398 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6399 the one of the previous (or the next clock) timestamp by the same duration.
6400 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6401 by five minutes, then the clocked-in timestamp of the next clock will be
6402 increased by five minutes.
6403 @orgcmd{C-c C-t,org-todo}
6404 Changing the TODO state of an item to DONE automatically stops the clock
6405 if it is running in this same item.
6406 @orgcmd{C-c C-x C-q,org-clock-cancel}
6407 Cancel the current clock. This is useful if a clock was started by
6408 mistake, or if you ended up working on something else.
6409 @orgcmd{C-c C-x C-j,org-clock-goto}
6410 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6411 prefix arg, select the target task from a list of recently clocked tasks.
6412 @orgcmd{C-c C-x C-d,org-clock-display}
6413 @vindex org-remove-highlights-with-change
6414 Display time summaries for each subtree in the current buffer. This puts
6415 overlays at the end of each headline, showing the total time recorded under
6416 that heading, including the time of any subheadings. You can use visibility
6417 cycling to study the tree, but the overlays disappear when you change the
6418 buffer (see variable @code{org-remove-highlights-with-change}) or press
6422 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6423 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6424 worked on or closed during a day.
6426 @strong{Important:} note that both @code{org-clock-out} and
6427 @code{org-clock-in-last} can have a global keybinding and will not
6428 modify the window disposition.
6430 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6431 @subsection The clock table
6432 @cindex clocktable, dynamic block
6433 @cindex report, of clocked time
6435 Org mode can produce quite complex reports based on the time clocking
6436 information. Such a report is called a @emph{clock table}, because it is
6437 formatted as one or several Org tables.
6440 @orgcmd{C-c C-x C-r,org-clock-report}
6441 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6442 report as an Org mode table into the current file. When the cursor is
6443 at an existing clock table, just update it. When called with a prefix
6444 argument, jump to the first clock report in the current document and
6445 update it. The clock table always includes also trees with
6446 @code{:ARCHIVE:} tag.
6447 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6448 Update dynamic block at point. The cursor needs to be in the
6449 @code{#+BEGIN} line of the dynamic block.
6450 @orgkey{C-u C-c C-x C-u}
6451 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6452 you have several clock table blocks in a buffer.
6453 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6454 Shift the current @code{:block} interval and update the table. The cursor
6455 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6456 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6460 Here is an example of the frame for a clock table as it is inserted into the
6461 buffer with the @kbd{C-c C-x C-r} command:
6463 @cindex #+BEGIN, clocktable
6465 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6469 @vindex org-clocktable-defaults
6470 The @samp{BEGIN} line and specify a number of options to define the scope,
6471 structure, and formatting of the report. Defaults for all these options can
6472 be configured in the variable @code{org-clocktable-defaults}.
6474 @noindent First there are options that determine which clock entries are to
6477 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6478 @r{Clocks at deeper levels will be summed into the upper level.}
6479 :scope @r{The scope to consider. This can be any of the following:}
6480 nil @r{the current buffer or narrowed region}
6481 file @r{the full current buffer}
6482 subtree @r{the subtree where the clocktable is located}
6483 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6484 tree @r{the surrounding level 1 tree}
6485 agenda @r{all agenda files}
6486 ("file"..) @r{scan these files}
6487 file-with-archives @r{current file and its archives}
6488 agenda-with-archives @r{all agenda files, including archives}
6489 :block @r{The time block to consider. This block is specified either}
6490 @r{absolute, or relative to the current time and may be any of}
6492 2007-12-31 @r{New year eve 2007}
6493 2007-12 @r{December 2007}
6494 2007-W50 @r{ISO-week 50 in 2007}
6495 2007-Q2 @r{2nd quarter in 2007}
6496 2007 @r{the year 2007}
6497 today, yesterday, today-@var{N} @r{a relative day}
6498 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6499 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6500 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6501 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6502 :tstart @r{A time string specifying when to start considering times.}
6503 @r{Relative times like @code{"<-2w>"} can also be used. See}
6504 @r{@ref{Matching tags and properties} for relative time syntax.}
6505 :tend @r{A time string specifying when to stop considering times.}
6506 @r{Relative times like @code{"<now>"} can also be used. See}
6507 @r{@ref{Matching tags and properties} for relative time syntax.}
6508 :wstart @r{The starting day of the week. The default is 1 for monday.}
6509 :mstart @r{The starting day of the month. The default 1 is for the first}
6510 @r{day of the month.}
6511 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6512 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6513 :stepskip0 @r{Do not show steps that have zero time.}
6514 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6515 :tags @r{A tags match to select entries that should contribute. See}
6516 @r{@ref{Matching tags and properties} for the match syntax.}
6519 Then there are options which determine the formatting of the table. There
6520 options are interpreted by the function @code{org-clocktable-write-default},
6521 but you can specify your own function using the @code{:formatter} parameter.
6523 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6524 :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".}
6525 :link @r{Link the item headlines in the table to their origins.}
6526 :narrow @r{An integer to limit the width of the headline column in}
6527 @r{the org table. If you write it like @samp{50!}, then the}
6528 @r{headline will also be shortened in export.}
6529 :indent @r{Indent each headline field according to its level.}
6530 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6531 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6532 :level @r{Should a level number column be included?}
6533 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6534 @r{All are overwritten except if there is an explicit @code{:narrow}}
6535 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6536 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6537 :properties @r{List of properties that should be shown in the table. Each}
6538 @r{property will get its own column.}
6539 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6540 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6541 @r{As a special case, @samp{:formula %} adds a column with % time.}
6542 @r{If you do not specify a formula here, any existing formula}
6543 @r{below the clock table will survive updates and be evaluated.}
6544 :formatter @r{A function to format clock data and insert it into the buffer.}
6546 To get a clock summary of the current level 1 tree, for the current
6547 day, you could write
6549 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6553 and to use a specific time range you could write@footnote{Note that all
6554 parameters must be specified in a single line---the line is broken here
6555 only to fit it into the manual.}
6557 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6558 :tend "<2006-08-10 Thu 12:00>"
6561 A range starting a week ago and ending right now could be written as
6563 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6566 A summary of the current subtree with % times would be
6568 #+BEGIN: clocktable :scope subtree :link t :formula %
6571 A horizontally compact representation of everything clocked during last week
6574 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6578 @node Resolving idle time, , The clock table, Clocking work time
6579 @subsection Resolving idle time and continuous clocking
6581 @subsubheading Resolving idle time
6582 @cindex resolve idle time
6583 @vindex org-clock-x11idle-program-name
6585 @cindex idle, resolve, dangling
6586 If you clock in on a work item, and then walk away from your
6587 computer---perhaps to take a phone call---you often need to ``resolve'' the
6588 time you were away by either subtracting it from the current clock, or
6589 applying it to another one.
6591 @vindex org-clock-idle-time
6592 By customizing the variable @code{org-clock-idle-time} to some integer, such
6593 as 10 or 15, Emacs can alert you when you get back to your computer after
6594 being idle for that many minutes@footnote{On computers using Mac OS X,
6595 idleness is based on actual user idleness, not just Emacs' idle time. For
6596 X11, you can install a utility program @file{x11idle.c}, available in the
6597 @code{contrib/scripts} directory of the Org git distribution, or install the
6598 @file{xprintidle} package and set it to the variable
6599 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6600 same general treatment of idleness. On other systems, idle time refers to
6601 Emacs idle time only.}, and ask what you want to do with the idle time.
6602 There will be a question waiting for you when you get back, indicating how
6603 much idle time has passed (constantly updated with the current amount), as
6604 well as a set of choices to correct the discrepancy:
6608 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6609 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6610 effectively changing nothing, or enter a number to keep that many minutes.
6612 If you use the shift key and press @kbd{K}, it will keep however many minutes
6613 you request and then immediately clock out of that task. If you keep all of
6614 the minutes, this is the same as just clocking out of the current task.
6616 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6617 the clock, and then check back in from the moment you returned.
6619 To keep none of the minutes and just clock out at the start of the away time,
6620 use the shift key and press @kbd{S}. Remember that using shift will always
6621 leave you clocked out, no matter which option you choose.
6623 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6624 canceling you subtract the away time, and the resulting clock amount is less
6625 than a minute, the clock will still be canceled rather than clutter up the
6626 log with an empty entry.
6629 What if you subtracted those away minutes from the current clock, and now
6630 want to apply them to a new clock? Simply clock in to any task immediately
6631 after the subtraction. Org will notice that you have subtracted time ``on
6632 the books'', so to speak, and will ask if you want to apply those minutes to
6633 the next task you clock in on.
6635 There is one other instance when this clock resolution magic occurs. Say you
6636 were clocked in and hacking away, and suddenly your cat chased a mouse who
6637 scared a hamster that crashed into your UPS's power button! You suddenly
6638 lose all your buffers, but thanks to auto-save you still have your recent Org
6639 mode changes, including your last clock in.
6641 If you restart Emacs and clock into any task, Org will notice that you have a
6642 dangling clock which was never clocked out from your last session. Using
6643 that clock's starting time as the beginning of the unaccounted-for period,
6644 Org will ask how you want to resolve that time. The logic and behavior is
6645 identical to dealing with away time due to idleness; it is just happening due
6646 to a recovery event rather than a set amount of idle time.
6648 You can also check all the files visited by your Org agenda for dangling
6649 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6651 @subsubheading Continuous clocking
6652 @cindex continuous clocking
6653 @vindex org-clock-continuously
6655 You may want to start clocking from the time when you clocked out the
6656 previous task. To enable this systematically, set @code{org-clock-continuously}
6657 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6658 last clocked entry for this session, and start the new clock from there.
6660 If you only want this from time to time, use three universal prefix arguments
6661 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6663 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6664 @section Effort estimates
6665 @cindex effort estimates
6667 @cindex property, Effort
6668 @vindex org-effort-property
6669 If you want to plan your work in a very detailed way, or if you need to
6670 produce offers with quotations of the estimated work effort, you may want to
6671 assign effort estimates to entries. If you are also clocking your work, you
6672 may later want to compare the planned effort with the actual working time, a
6673 great way to improve planning estimates. Effort estimates are stored in a
6674 special property @samp{Effort}@footnote{You may change the property being
6675 used with the variable @code{org-effort-property}.}. You can set the effort
6676 for an entry with the following commands:
6679 @orgcmd{C-c C-x e,org-set-effort}
6680 Set the effort estimate for the current entry. With a numeric prefix
6681 argument, set it to the Nth allowed value (see below). This command is also
6682 accessible from the agenda with the @kbd{e} key.
6683 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6684 Modify the effort estimate of the item currently being clocked.
6687 Clearly the best way to work with effort estimates is through column view
6688 (@pxref{Column view}). You should start by setting up discrete values for
6689 effort estimates, and a @code{COLUMNS} format that displays these values
6690 together with clock sums (if you want to clock your time). For a specific
6694 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6695 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6699 @vindex org-global-properties
6700 @vindex org-columns-default-format
6701 or, even better, you can set up these values globally by customizing the
6702 variables @code{org-global-properties} and @code{org-columns-default-format}.
6703 In particular if you want to use this setup also in the agenda, a global
6704 setup may be advised.
6706 The way to assign estimates to individual items is then to switch to column
6707 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6708 value. The values you enter will immediately be summed up in the hierarchy.
6709 In the column next to it, any clocked time will be displayed.
6711 @vindex org-agenda-columns-add-appointments-to-effort-sum
6712 If you switch to column view in the daily/weekly agenda, the effort column
6713 will summarize the estimated work effort for each day@footnote{Please note
6714 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6715 column view}).}, and you can use this to find space in your schedule. To get
6716 an overview of the entire part of the day that is committed, you can set the
6717 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6718 appointments on a day that take place over a specified time interval will
6719 then also be added to the load estimate of the day.
6721 Effort estimates can be used in secondary agenda filtering that is triggered
6722 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6723 these estimates defined consistently, two or three key presses will narrow
6724 down the list to stuff that fits into an available time slot.
6726 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6727 @section Taking notes with a relative timer
6728 @cindex relative timer
6730 When taking notes during, for example, a meeting or a video viewing, it can
6731 be useful to have access to times relative to a starting time. Org provides
6732 such a relative timer and make it easy to create timed notes.
6735 @orgcmd{C-c C-x .,org-timer}
6736 Insert a relative time into the buffer. The first time you use this, the
6737 timer will be started. When called with a prefix argument, the timer is
6739 @orgcmd{C-c C-x -,org-timer-item}
6740 Insert a description list item with the current relative time. With a prefix
6741 argument, first reset the timer to 0.
6742 @orgcmd{M-@key{RET},org-insert-heading}
6743 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6745 @c for key sequences with a comma, command name macros fail :(
6748 Pause the timer, or continue it if it is already paused
6749 (@command{org-timer-pause-or-continue}).
6750 @c removed the sentence because it is redundant to the following item
6751 @kindex C-u C-c C-x ,
6753 Stop the timer. After this, you can only start a new timer, not continue the
6754 old one. This command also removes the timer from the mode line.
6755 @orgcmd{C-c C-x 0,org-timer-start}
6756 Reset the timer without inserting anything into the buffer. By default, the
6757 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6758 specific starting offset. The user is prompted for the offset, with a
6759 default taken from a timer string at point, if any, So this can be used to
6760 restart taking notes after a break in the process. When called with a double
6761 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6762 by a certain amount. This can be used to fix timer strings if the timer was
6763 not started at exactly the right moment.
6766 @node Countdown timer, , Relative timer, Dates and Times
6767 @section Countdown timer
6768 @cindex Countdown timer
6772 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6773 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6775 @code{org-timer-set-timer} prompts the user for a duration and displays a
6776 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6777 default countdown value. Giving a prefix numeric argument overrides this
6780 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6781 @chapter Capture - Refile - Archive
6784 An important part of any organization system is the ability to quickly
6785 capture new ideas and tasks, and to associate reference material with them.
6786 Org does this using a process called @i{capture}. It also can store files
6787 related to a task (@i{attachments}) in a special directory. Once in the
6788 system, tasks and projects need to be moved around. Moving completed project
6789 trees to an archive file keeps the system compact and fast.
6792 * Capture:: Capturing new stuff
6793 * Attachments:: Add files to tasks
6794 * RSS Feeds:: Getting input from RSS feeds
6795 * Protocols:: External (e.g., Browser) access to Emacs and Org
6796 * Refile and copy:: Moving/copying a tree from one place to another
6797 * Archiving:: What to do with finished projects
6800 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6804 Capture lets you quickly store notes with little interruption of your work
6805 flow. Org's method for capturing new items is heavily inspired by John
6806 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6807 used a special setup for @file{remember.el}, then replaced it with
6808 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6809 been completely replaced by @file{org-capture.el}.
6811 If your configuration depends on @file{org-remember.el}, you need to update
6812 it and use the setup described below. To convert your
6813 @code{org-remember-templates}, run the command
6815 @kbd{M-x org-capture-import-remember-templates RET}
6817 @noindent and then customize the new variable with @kbd{M-x
6818 customize-variable org-capture-templates}, check the result, and save the
6822 * Setting up capture:: Where notes will be stored
6823 * Using capture:: Commands to invoke and terminate capture
6824 * Capture templates:: Define the outline of different note types
6827 @node Setting up capture, Using capture, Capture, Capture
6828 @subsection Setting up capture
6830 The following customization sets a default target file for notes, and defines
6831 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6832 suggestion.} for capturing new material.
6834 @vindex org-default-notes-file
6837 (setq org-default-notes-file (concat org-directory "/notes.org"))
6838 (define-key global-map "\C-cc" 'org-capture)
6842 @node Using capture, Capture templates, Setting up capture, Capture
6843 @subsection Using capture
6846 @orgcmd{C-c c,org-capture}
6847 Call the command @code{org-capture}. Note that this keybinding is global and
6848 not active by default: you need to install it. If you have templates
6850 defined @pxref{Capture templates}, it will offer these templates for
6851 selection or use a new Org outline node as the default template. It will
6852 insert the template into the target file and switch to an indirect buffer
6853 narrowed to this new node. You may then insert the information you want.
6855 @orgcmd{C-c C-c,org-capture-finalize}
6856 Once you have finished entering information into the capture buffer, @kbd{C-c
6857 C-c} will return you to the window configuration before the capture process,
6858 so that you can resume your work without further distraction. When called
6859 with a prefix arg, finalize and then jump to the captured item.
6861 @orgcmd{C-c C-w,org-capture-refile}
6862 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6863 a different place. Please realize that this is a normal refiling command
6864 that will be executed---so the cursor position at the moment you run this
6865 command is important. If you have inserted a tree with a parent and
6866 children, first move the cursor back to the parent. Any prefix argument
6867 given to this command will be passed on to the @code{org-refile} command.
6869 @orgcmd{C-c C-k,org-capture-kill}
6870 Abort the capture process and return to the previous state.
6874 You can also call @code{org-capture} in a special way from the agenda, using
6875 the @kbd{k c} key combination. With this access, any timestamps inserted by
6876 the selected capture template will default to the cursor date in the agenda,
6877 rather than to the current date.
6879 To find the locations of the last stored capture, use @code{org-capture} with
6884 Visit the target location of a capture template. You get to select the
6885 template in the usual way.
6886 @orgkey{C-u C-u C-c c}
6887 Visit the last stored capture item in its buffer.
6890 @vindex org-capture-bookmark
6891 @cindex org-capture-last-stored
6892 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6893 automatically be created unless you set @code{org-capture-bookmark} to
6896 To insert the capture at point in an Org buffer, call @code{org-capture} with
6897 a @code{C-0} prefix argument.
6899 @node Capture templates, , Using capture, Capture
6900 @subsection Capture templates
6901 @cindex templates, for Capture
6903 You can use templates for different types of capture items, and
6904 for different target locations. The easiest way to create such templates is
6905 through the customize interface.
6909 Customize the variable @code{org-capture-templates}.
6912 Before we give the formal description of template definitions, let's look at
6913 an example. Say you would like to use one template to create general TODO
6914 entries, and you want to put these entries under the heading @samp{Tasks} in
6915 your file @file{~/org/gtd.org}. Also, a date tree in the file
6916 @file{journal.org} should capture journal entries. A possible configuration
6921 (setq org-capture-templates
6922 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6923 "* TODO %?\n %i\n %a")
6924 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6925 "* %?\nEntered on %U\n %i\n %a")))
6929 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6933 [[file:@var{link to where you initiated capture}]]
6937 During expansion of the template, @code{%a} has been replaced by a link to
6938 the location from where you called the capture command. This can be
6939 extremely useful for deriving tasks from emails, for example. You fill in
6940 the task definition, press @kbd{C-c C-c} and Org returns you to the same
6941 place where you started the capture process.
6943 To define special keys to capture to a particular template without going
6944 through the interactive template selection, you can create your key binding
6948 (define-key global-map "\C-cx"
6949 (lambda () (interactive) (org-capture nil "x")))
6953 * Template elements:: What is needed for a complete template entry
6954 * Template expansion:: Filling in information about time and context
6955 * Templates in contexts:: Only show a template in a specific context
6958 @node Template elements, Template expansion, Capture templates, Capture templates
6959 @subsubsection Template elements
6961 Now lets look at the elements of a template definition. Each entry in
6962 @code{org-capture-templates} is a list with the following items:
6966 The keys that will select the template, as a string, characters
6967 only, for example @code{"a"} for a template to be selected with a
6968 single key, or @code{"bt"} for selection with two keys. When using
6969 several keys, keys using the same prefix key must be sequential
6970 in the list and preceded by a 2-element entry explaining the
6971 prefix key, for example
6973 ("b" "Templates for marking stuff to buy")
6975 @noindent If you do not define a template for the @kbd{C} key, this key will
6976 be used to open the customize buffer for this complex variable.
6979 A short string describing the template, which will be shown during
6983 The type of entry, a symbol. Valid values are:
6987 An Org mode node, with a headline. Will be filed as the child of the target
6988 entry or as a top-level entry. The target file should be an Org mode file.
6990 A plain list item, placed in the first plain list at the target
6991 location. Again the target file should be an Org file.
6993 A checkbox item. This only differs from the plain list item by the
6996 a new line in the first table at the target location. Where exactly the
6997 line will be inserted depends on the properties @code{:prepend} and
6998 @code{:table-line-pos} (see below).
7000 Text to be inserted as it is.
7004 @vindex org-default-notes-file
7005 Specification of where the captured item should be placed. In Org mode
7006 files, targets usually define a node. Entries will become children of this
7007 node. Other types will be added to the table or list in the body of this
7008 node. Most target specifications contain a file name. If that file name is
7009 the empty string, it defaults to @code{org-default-notes-file}. A file can
7010 also be given as a variable, function, or Emacs Lisp form.
7015 @item (file "path/to/file")
7016 Text will be placed at the beginning or end of that file.
7018 @item (id "id of existing org entry")
7019 Filing as child of this entry, or in the body of the entry.
7021 @item (file+headline "path/to/file" "node headline")
7022 Fast configuration if the target heading is unique in the file.
7024 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7025 For non-unique headings, the full path is safer.
7027 @item (file+regexp "path/to/file" "regexp to find location")
7028 Use a regular expression to position the cursor.
7030 @item (file+datetree "path/to/file")
7031 Will create a heading in a date tree for today's date@footnote{Datetree
7032 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7033 and @code{* 2013} in your file, the capture will refile the note to the first
7036 @item (file+datetree+prompt "path/to/file")
7037 Will create a heading in a date tree, but will prompt for the date.
7039 @item (file+function "path/to/file" function-finding-location)
7040 A function to find the right location in the file.
7043 File to the entry that is currently being clocked.
7045 @item (function function-finding-location)
7046 Most general way, write your own function to find both
7051 The template for creating the capture item. If you leave this empty, an
7052 appropriate default template will be used. Otherwise this is a string with
7053 escape codes, which will be replaced depending on time and context of the
7054 capture call. The string with escapes may be loaded from a template file,
7055 using the special syntax @code{(file "path/to/template")}. See below for
7059 The rest of the entry is a property list of additional options.
7060 Recognized properties are:
7064 Normally new captured information will be appended at
7065 the target location (last child, last table line, last list item...).
7066 Setting this property will change that.
7068 @item :immediate-finish
7069 When set, do not offer to edit the information, just
7070 file it away immediately. This makes sense if the template only needs
7071 information that can be added automatically.
7074 Set this to the number of lines to insert
7075 before and after the new item. Default 0, only common other value is 1.
7078 Start the clock in this item.
7081 Keep the clock running when filing the captured entry.
7084 If starting the capture interrupted a clock, restart that clock when finished
7085 with the capture. Note that @code{:clock-keep} has precedence over
7086 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7087 run and the previous one will not be resumed.
7090 Do not narrow the target buffer, simply show the full buffer. Default is to
7091 narrow it so that you only see the new material.
7093 @item :table-line-pos
7094 Specification of the location in the table where the new line should be
7095 inserted. It should be a string like @code{"II-3"} meaning that the new
7096 line should become the third line before the second horizontal separator
7100 If the target file was not yet visited when capture was invoked, kill the
7101 buffer again after capture is completed.
7105 @node Template expansion, Templates in contexts, Template elements, Capture templates
7106 @subsubsection Template expansion
7108 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7109 these sequences literally, escape the @kbd{%} with a backslash.} allow
7110 dynamic insertion of content. The templates are expanded in the order given here:
7113 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7114 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7115 @r{For convenience, %:keyword (see below) placeholders}
7116 @r{within the expression will be expanded prior to this.}
7117 @r{The sexp must return a string.}
7118 %<...> @r{The result of format-time-string on the ... format specification.}
7119 %t @r{Timestamp, date only.}
7120 %T @r{Timestamp, with date and time.}
7121 %u, %U @r{Like the above, but inactive timestamps.}
7122 %i @r{Initial content, the region when capture is called while the}
7123 @r{region is active.}
7124 @r{The entire text will be indented like @code{%i} itself.}
7125 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7126 %A @r{Like @code{%a}, but prompt for the description part.}
7127 %l @r{Like %a, but only insert the literal link.}
7128 %c @r{Current kill ring head.}
7129 %x @r{Content of the X clipboard.}
7130 %k @r{Title of the currently clocked task.}
7131 %K @r{Link to the currently clocked task.}
7132 %n @r{User name (taken from @code{user-full-name}).}
7133 %f @r{File visited by current buffer when org-capture was called.}
7134 %F @r{Full path of the file or directory visited by current buffer.}
7135 %:keyword @r{Specific information for certain link types, see below.}
7136 %^g @r{Prompt for tags, with completion on tags in target file.}
7137 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7138 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7139 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7140 %^C @r{Interactive selection of which kill or clip to use.}
7141 %^L @r{Like @code{%^C}, but insert as link.}
7142 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7143 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7144 @r{You may specify a default value and a completion table with}
7145 @r{%^@{prompt|default|completion2|completion3...@}.}
7146 @r{The arrow keys access a prompt-specific history.}
7147 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7148 @r{a number, starting from 1.}
7149 %? @r{After completing the template, position cursor here.}
7153 For specific link types, the following keywords will be
7154 defined@footnote{If you define your own link types (@pxref{Adding
7155 hyperlink types}), any property you store with
7156 @code{org-store-link-props} can be accessed in capture templates in a
7159 @vindex org-from-is-user-regexp
7161 Link type | Available keywords
7162 ---------------------------------+----------------------------------------------
7163 bbdb | %:name %:company
7164 irc | %:server %:port %:nick
7165 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
7166 | %:from %:fromname %:fromaddress
7167 | %:to %:toname %:toaddress
7168 | %:date @r{(message date header field)}
7169 | %:date-timestamp @r{(date as active timestamp)}
7170 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7171 | %: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}.}}
7172 gnus | %:group, @r{for messages also all email fields}
7174 info | %:file %:node
7179 To place the cursor after template expansion use:
7182 %? @r{After completing the template, position cursor here.}
7185 @node Templates in contexts, , Template expansion, Capture templates
7186 @subsubsection Templates in contexts
7188 @vindex org-capture-templates-contexts
7189 To control whether a capture template should be accessible from a specific
7190 context, you can customize @code{org-capture-templates-contexts}. Let's say
7191 for example that you have a capture template @code{"p"} for storing Gnus
7192 emails containing patches. Then you would configure this option like this:
7195 (setq org-capture-templates-contexts
7196 '(("p" (in-mode . "message-mode"))))
7199 You can also tell that the command key @code{"p"} should refer to another
7200 template. In that case, add this command key like this:
7203 (setq org-capture-templates-contexts
7204 '(("p" "q" (in-mode . "message-mode"))))
7207 See the docstring of the variable for more information.
7209 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
7210 @section Attachments
7213 @vindex org-attach-directory
7214 It is often useful to associate reference material with an outline node/task.
7215 Small chunks of plain text can simply be stored in the subtree of a project.
7216 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7217 files that live elsewhere on your computer or in the cloud, like emails or
7218 source code files belonging to a project. Another method is @i{attachments},
7219 which are files located in a directory belonging to an outline node. Org
7220 uses directories named by the unique ID of each entry. These directories are
7221 located in the @file{data} directory which lives in the same directory where
7222 your Org file lives@footnote{If you move entries or Org files from one
7223 directory to another, you may want to configure @code{org-attach-directory}
7224 to contain an absolute path.}. If you initialize this directory with
7225 @code{git init}, Org will automatically commit changes when it sees them.
7226 The attachment system has been contributed to Org by John Wiegley.
7228 In cases where it seems better to do so, you can also attach a directory of your
7229 choice to an entry. You can also make children inherit the attachment
7230 directory from a parent, so that an entire subtree uses the same attached
7233 @noindent The following commands deal with attachments:
7236 @orgcmd{C-c C-a,org-attach}
7237 The dispatcher for commands related to the attachment system. After these
7238 keys, a list of commands is displayed and you must press an additional key
7239 to select a command:
7242 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7243 @vindex org-attach-method
7244 Select a file and move it into the task's attachment directory. The file
7245 will be copied, moved, or linked, depending on @code{org-attach-method}.
7246 Note that hard links are not supported on all systems.
7252 Attach a file using the copy/move/link method.
7253 Note that hard links are not supported on all systems.
7255 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7256 Create a new attachment as an Emacs buffer.
7258 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7259 Synchronize the current task with its attachment directory, in case you added
7260 attachments yourself.
7262 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7263 @vindex org-file-apps
7264 Open current task's attachment. If there is more than one, prompt for a
7265 file name first. Opening will follow the rules set by @code{org-file-apps}.
7266 For more details, see the information on following hyperlinks
7267 (@pxref{Handling links}).
7269 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7270 Also open the attachment, but force opening the file in Emacs.
7272 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7273 Open the current task's attachment directory.
7275 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7276 Also open the directory, but force using @command{dired} in Emacs.
7278 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7279 Select and delete a single attachment.
7281 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7282 Delete all of a task's attachments. A safer way is to open the directory in
7283 @command{dired} and delete from there.
7285 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7286 @cindex property, ATTACH_DIR
7287 Set a specific directory as the entry's attachment directory. This works by
7288 putting the directory path into the @code{ATTACH_DIR} property.
7290 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7291 @cindex property, ATTACH_DIR_INHERIT
7292 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7293 same directory for attachments as the parent does.
7297 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
7302 Org can add and change entries based on information found in RSS feeds and
7303 Atom feeds. You could use this to make a task out of each new podcast in a
7304 podcast feed. Or you could use a phone-based note-creating service on the
7305 web to import tasks into Org. To access feeds, configure the variable
7306 @code{org-feed-alist}. The docstring of this variable has detailed
7307 information. Here is just an example:
7311 (setq org-feed-alist
7313 "http://rss.slashdot.org/Slashdot/slashdot"
7314 "~/txt/org/feeds.org" "Slashdot Entries")))
7319 will configure that new items from the feed provided by
7320 @code{rss.slashdot.org} will result in new entries in the file
7321 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7322 the following command is used:
7325 @orgcmd{C-c C-x g,org-feed-update-all}
7327 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7329 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7330 Prompt for a feed name and go to the inbox configured for this feed.
7333 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7334 it will store information about the status of items in the feed, to avoid
7335 adding the same item several times. You should add @samp{FEEDSTATUS} to the
7336 list of drawers in that file:
7339 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7342 For more information, including how to read atom feeds, see
7343 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7345 @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
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, Archiving, Protocols, Capture - Refile - Archive
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 Refile the entry or region at point. This command offers possible locations
7383 for refiling the entry and lets you select one with completion. The item (or
7384 all items in the region) is filed below the target heading as a subitem.
7385 Depending on @code{org-reverse-note-order}, it will be either the first or
7387 By default, all level 1 headlines in the current buffer are considered to be
7388 targets, but you can have more complex definitions across a number of files.
7389 See the variable @code{org-refile-targets} for details. If you would like to
7390 select a location via a file-path-like completion along the outline path, see
7391 the variables @code{org-refile-use-outline-path} and
7392 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7393 create new nodes as new parents for refiling on the fly, check the
7394 variable @code{org-refile-allow-creating-parent-nodes}.
7395 When the variable @code{org-log-refile}@footnote{with corresponding
7396 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7397 and @code{nologrefile}} is set, a timestamp or a note will be
7398 recorded when an entry has been refiled.
7399 @orgkey{C-u C-c C-w}
7400 Use the refile interface to jump to a heading.
7401 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7402 Jump to the location where @code{org-refile} last moved a tree to.
7404 Refile as the child of the item currently being clocked.
7405 @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}
7406 Clear the target cache. Caching of refile targets can be turned on by
7407 setting @code{org-refile-use-cache}. To make the command see new possible
7408 targets, you have to clear the cache with this command.
7411 @node Archiving, , Refile and copy, Capture - Refile - Archive
7415 When a project represented by a (sub)tree is finished, you may want
7416 to move the tree out of the way and to stop it from contributing to the
7417 agenda. Archiving is important to keep your working files compact and global
7418 searches like the construction of agenda views fast.
7421 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7422 @vindex org-archive-default-command
7423 Archive the current entry using the command specified in the variable
7424 @code{org-archive-default-command}.
7428 * Moving subtrees:: Moving a tree to an archive file
7429 * Internal archiving:: Switch off a tree but keep it in the file
7432 @node Moving subtrees, Internal archiving, Archiving, Archiving
7433 @subsection Moving a tree to the archive file
7434 @cindex external archiving
7436 The most common archiving action is to move a project tree to another file,
7440 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7441 @vindex org-archive-location
7442 Archive the subtree starting at the cursor position to the location
7443 given by @code{org-archive-location}.
7444 @orgkey{C-u C-c C-x C-s}
7445 Check if any direct children of the current headline could be moved to
7446 the archive. To do this, each subtree is checked for open TODO entries.
7447 If none are found, the command offers to move it to the archive
7448 location. If the cursor is @emph{not} on a headline when this command
7449 is invoked, the level 1 trees will be checked.
7452 @cindex archive locations
7453 The default archive location is a file in the same directory as the
7454 current file, with the name derived by appending @file{_archive} to the
7455 current file name. You can also choose what heading to file archived
7456 items under, with the possibility to add them to a datetree in a file.
7457 For information and examples on how to specify the file and the heading,
7458 see the documentation string of the variable
7459 @code{org-archive-location}.
7461 There is also an in-buffer option for setting this variable, for
7462 example@footnote{For backward compatibility, the following also works:
7463 If there are several such lines in a file, each specifies the archive
7464 location for the text below it. The first such line also applies to any
7465 text before its definition. However, using this method is
7466 @emph{strongly} deprecated as it is incompatible with the outline
7467 structure of the document. The correct method for setting multiple
7468 archive locations in a buffer is using properties.}:
7472 #+ARCHIVE: %s_done::
7475 @cindex property, ARCHIVE
7477 If you would like to have a special ARCHIVE location for a single entry
7478 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7479 location as the value (@pxref{Properties and Columns}).
7481 @vindex org-archive-save-context-info
7482 When a subtree is moved, it receives a number of special properties that
7483 record context information like the file from where the entry came, its
7484 outline path the archiving time etc. Configure the variable
7485 @code{org-archive-save-context-info} to adjust the amount of information
7489 @node Internal archiving, , Moving subtrees, Archiving
7490 @subsection Internal archiving
7492 If you want to just switch off (for agenda views) certain subtrees without
7493 moving them to a different file, you can use the @code{ARCHIVE tag}.
7495 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7496 its location in the outline tree, but behaves in the following way:
7499 @vindex org-cycle-open-archived-trees
7500 It does not open when you attempt to do so with a visibility cycling
7501 command (@pxref{Visibility cycling}). You can force cycling archived
7502 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7503 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7504 @code{show-all} will open archived subtrees.
7506 @vindex org-sparse-tree-open-archived-trees
7507 During sparse tree construction (@pxref{Sparse trees}), matches in
7508 archived subtrees are not exposed, unless you configure the option
7509 @code{org-sparse-tree-open-archived-trees}.
7511 @vindex org-agenda-skip-archived-trees
7512 During agenda view construction (@pxref{Agenda Views}), the content of
7513 archived trees is ignored unless you configure the option
7514 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7515 be included. In the agenda you can press @kbd{v a} to get archives
7516 temporarily included.
7518 @vindex org-export-with-archived-trees
7519 Archived trees are not exported (@pxref{Exporting}), only the headline
7520 is. Configure the details using the variable
7521 @code{org-export-with-archived-trees}.
7523 @vindex org-columns-skip-archived-trees
7524 Archived trees are excluded from column view unless the variable
7525 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7528 The following commands help manage the ARCHIVE tag:
7531 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7532 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7533 the headline changes to a shadowed face, and the subtree below it is
7535 @orgkey{C-u C-c C-x a}
7536 Check if any direct children of the current headline should be archived.
7537 To do this, each subtree is checked for open TODO entries. If none are
7538 found, the command offers to set the ARCHIVE tag for the child. If the
7539 cursor is @emph{not} on a headline when this command is invoked, the
7540 level 1 trees will be checked.
7541 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7542 Cycle a tree even if it is tagged with ARCHIVE.
7543 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7544 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7545 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7546 entry becomes a child of that sibling and in this way retains a lot of its
7547 original context, including inherited tags and approximate position in the
7552 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7553 @chapter Agenda views
7554 @cindex agenda views
7556 Due to the way Org works, TODO items, time-stamped items, and
7557 tagged headlines can be scattered throughout a file or even a number of
7558 files. To get an overview of open action items, or of events that are
7559 important for a particular date, this information must be collected,
7560 sorted and displayed in an organized way.
7562 Org can select items based on various criteria and display them
7563 in a separate buffer. Seven different view types are provided:
7567 an @emph{agenda} that is like a calendar and shows information
7570 a @emph{TODO list} that covers all unfinished
7573 a @emph{match view}, showings headlines based on the tags, properties, and
7574 TODO state associated with them,
7576 a @emph{timeline view} that shows all events in a single Org file,
7577 in time-sorted view,
7579 a @emph{text search view} that shows all entries from multiple files
7580 that contain specified keywords,
7582 a @emph{stuck projects view} showing projects that currently don't move
7585 @emph{custom views} that are special searches and combinations of different
7590 The extracted information is displayed in a special @emph{agenda
7591 buffer}. This buffer is read-only, but provides commands to visit the
7592 corresponding locations in the original Org files, and even to
7593 edit these files remotely.
7595 @vindex org-agenda-window-setup
7596 @vindex org-agenda-restore-windows-after-quit
7597 Two variables control how the agenda buffer is displayed and whether the
7598 window configuration is restored when the agenda exits:
7599 @code{org-agenda-window-setup} and
7600 @code{org-agenda-restore-windows-after-quit}.
7603 * Agenda files:: Files being searched for agenda information
7604 * Agenda dispatcher:: Keyboard access to agenda views
7605 * Built-in agenda views:: What is available out of the box?
7606 * Presentation and sorting:: How agenda items are prepared for display
7607 * Agenda commands:: Remote editing of Org trees
7608 * Custom agenda views:: Defining special searches and views
7609 * Exporting Agenda Views:: Writing a view to a file
7610 * Agenda column view:: Using column view for collected entries
7613 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7614 @section Agenda files
7615 @cindex agenda files
7616 @cindex files for agenda
7618 @vindex org-agenda-files
7619 The information to be shown is normally collected from all @emph{agenda
7620 files}, the files listed in the variable
7621 @code{org-agenda-files}@footnote{If the value of that variable is not a
7622 list, but a single file name, then the list of agenda files will be
7623 maintained in that external file.}. If a directory is part of this list,
7624 all files with the extension @file{.org} in this directory will be part
7627 Thus, even if you only work with a single Org file, that file should
7628 be put into the list@footnote{When using the dispatcher, pressing
7629 @kbd{<} before selecting a command will actually limit the command to
7630 the current file, and ignore @code{org-agenda-files} until the next
7631 dispatcher command.}. You can customize @code{org-agenda-files}, but
7632 the easiest way to maintain it is through the following commands
7634 @cindex files, adding to agenda list
7636 @orgcmd{C-c [,org-agenda-file-to-front}
7637 Add current file to the list of agenda files. The file is added to
7638 the front of the list. If it was already in the list, it is moved to
7639 the front. With a prefix argument, file is added/moved to the end.
7640 @orgcmd{C-c ],org-remove-file}
7641 Remove current file from the list of agenda files.
7643 @cindex cycling, of agenda files
7644 @orgcmd{C-',org-cycle-agenda-files}
7646 Cycle through agenda file list, visiting one file after the other.
7647 @kindex M-x org-iswitchb
7648 @item M-x org-iswitchb RET
7649 Command to use an @code{iswitchb}-like interface to switch to and between Org
7654 The Org menu contains the current list of files and can be used
7655 to visit any of them.
7657 If you would like to focus the agenda temporarily on a file not in
7658 this list, or on just one file in the list, or even on only a subtree in a
7659 file, then this can be done in different ways. For a single agenda command,
7660 you may press @kbd{<} once or several times in the dispatcher
7661 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7662 extended period, use the following commands:
7665 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7666 Permanently restrict the agenda to the current subtree. When with a
7667 prefix argument, or with the cursor before the first headline in a file,
7668 the agenda scope is set to the entire file. This restriction remains in
7669 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7670 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7671 agenda view, the new restriction takes effect immediately.
7672 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7673 Remove the permanent restriction created by @kbd{C-c C-x <}.
7677 When working with @file{speedbar.el}, you can use the following commands in
7681 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7682 Permanently restrict the agenda to the item---either an Org file or a subtree
7683 in such a file---at the cursor in the Speedbar frame.
7684 If there is a window displaying an agenda view, the new restriction takes
7686 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7687 Lift the restriction.
7690 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7691 @section The agenda dispatcher
7692 @cindex agenda dispatcher
7693 @cindex dispatching agenda commands
7694 The views are created through a dispatcher, which should be bound to a
7695 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7696 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7697 is accessed and list keyboard access to commands accordingly. After
7698 pressing @kbd{C-c a}, an additional letter is required to execute a
7699 command. The dispatcher offers the following default commands:
7703 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7705 Create a list of all TODO items (@pxref{Global TODO list}).
7707 Create a list of headlines matching a TAGS expression (@pxref{Matching
7708 tags and properties}).
7710 Create the timeline view for the current buffer (@pxref{Timeline}).
7712 Create a list of entries selected by a boolean expression of keywords
7713 and/or regular expressions that must or must not occur in the entry.
7715 @vindex org-agenda-text-search-extra-files
7716 Search for a regular expression in all agenda files and additionally in
7717 the files listed in @code{org-agenda-text-search-extra-files}. This
7718 uses the Emacs command @code{multi-occur}. A prefix argument can be
7719 used to specify the number of context lines for each match, default is
7722 Create a list of stuck projects (@pxref{Stuck projects}).
7724 Restrict an agenda command to the current buffer@footnote{For backward
7725 compatibility, you can also press @kbd{1} to restrict to the current
7726 buffer.}. After pressing @kbd{<}, you still need to press the character
7727 selecting the command.
7729 If there is an active region, restrict the following agenda command to
7730 the region. Otherwise, restrict it to the current subtree@footnote{For
7731 backward compatibility, you can also press @kbd{0} to restrict to the
7732 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7733 character selecting the command.
7736 @vindex org-agenda-sticky
7737 Toggle sticky agenda views. By default, Org maintains only a single agenda
7738 buffer and rebuilds it each time you change the view, to make sure everything
7739 is always up to date. If you switch between views often and the build time
7740 bothers you, you can turn on sticky agenda buffers (make this the default by
7741 customizing the variable @code{org-agenda-sticky}). With sticky agendas, the
7742 dispatcher only switches to the selected view, you need to update it by hand
7743 with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with
7744 @code{org-toggle-sticky-agenda}.
7747 You can also define custom commands that will be accessible through the
7748 dispatcher, just like the default commands. This includes the
7749 possibility to create extended agenda buffers that contain several
7750 blocks together, for example the weekly agenda, the global TODO list and
7751 a number of special tags matches. @xref{Custom agenda views}.
7753 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7754 @section The built-in agenda views
7756 In this section we describe the built-in views.
7759 * Weekly/daily agenda:: The calendar page with current tasks
7760 * Global TODO list:: All unfinished action items
7761 * Matching tags and properties:: Structured information with fine-tuned search
7762 * Timeline:: Time-sorted view for single file
7763 * Search view:: Find entries by searching for text
7764 * Stuck projects:: Find projects you need to review
7767 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7768 @subsection The weekly/daily agenda
7770 @cindex weekly agenda
7771 @cindex daily agenda
7773 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7774 paper agenda, showing all the tasks for the current week or day.
7777 @cindex org-agenda, command
7778 @orgcmd{C-c a a,org-agenda-list}
7779 Compile an agenda for the current week from a list of Org files. The agenda
7780 shows the entries for each day. With a numeric prefix@footnote{For backward
7781 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7782 listed before the agenda. This feature is deprecated, use the dedicated TODO
7783 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7784 C-c a a}) you may set the number of days to be displayed.
7787 @vindex org-agenda-span
7788 @vindex org-agenda-ndays
7789 @vindex org-agenda-start-day
7790 @vindex org-agenda-start-on-weekday
7791 The default number of days displayed in the agenda is set by the variable
7792 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7793 variable can be set to any number of days you want to see by default in the
7794 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7795 @code{year}. For weekly agendas, the default is to start on the previous
7796 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7797 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7798 start the agenda ten days from today in the future.
7800 Remote editing from the agenda buffer means, for example, that you can
7801 change the dates of deadlines and appointments from the agenda buffer.
7802 The commands available in the Agenda buffer are listed in @ref{Agenda
7805 @subsubheading Calendar/Diary integration
7806 @cindex calendar integration
7807 @cindex diary integration
7809 Emacs contains the calendar and diary by Edward M. Reingold. The
7810 calendar displays a three-month calendar with holidays from different
7811 countries and cultures. The diary allows you to keep track of
7812 anniversaries, lunar phases, sunrise/set, recurrent appointments
7813 (weekly, monthly) and more. In this way, it is quite complementary to
7814 Org. It can be very useful to combine output from Org with
7817 In order to include entries from the Emacs diary into Org mode's
7818 agenda, you only need to customize the variable
7821 (setq org-agenda-include-diary t)
7824 @noindent After that, everything will happen automatically. All diary
7825 entries including holidays, anniversaries, etc., will be included in the
7826 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7827 @key{RET} can be used from the agenda buffer to jump to the diary
7828 file in order to edit existing diary entries. The @kbd{i} command to
7829 insert new entries for the current date works in the agenda buffer, as
7830 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7831 Sunrise/Sunset times, show lunar phases and to convert to other
7832 calendars, respectively. @kbd{c} can be used to switch back and forth
7833 between calendar and agenda.
7835 If you are using the diary only for sexp entries and holidays, it is
7836 faster to not use the above setting, but instead to copy or even move
7837 the entries into an Org file. Org mode evaluates diary-style sexp
7838 entries, and does it faster because there is no overhead for first
7839 creating the diary display. Note that the sexp entries must start at
7840 the left margin, no whitespace is allowed before them. For example,
7841 the following segment of an Org file will be processed and entries
7842 will be made in the agenda:
7845 * Birthdays and similar stuff
7847 %%(org-calendar-holiday) ; special function for holiday names
7849 %%(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
7850 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7853 @subsubheading Anniversaries from BBDB
7854 @cindex BBDB, anniversaries
7855 @cindex anniversaries, from BBDB
7857 If you are using the Big Brothers Database to store your contacts, you will
7858 very likely prefer to store anniversaries in BBDB rather than in a
7859 separate Org or diary file. Org supports this and will show BBDB
7860 anniversaries as part of the agenda. All you need to do is to add the
7861 following to one of your agenda files:
7868 %%(org-bbdb-anniversaries)
7871 You can then go ahead and define anniversaries for a BBDB record. Basically,
7872 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7873 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7874 followed by a space and the class of the anniversary (@samp{birthday} or
7875 @samp{wedding}, or a format string). If you omit the class, it will default to
7876 @samp{birthday}. Here are a few examples, the header for the file
7877 @file{org-bbdb.el} contains more detailed information.
7883 2008-04-14 %s released version 6.01 of org mode, %d years ago
7886 After a change to BBDB, or for the first agenda display during an Emacs
7887 session, the agenda display will suffer a short delay as Org updates its
7888 hash with anniversaries. However, from then on things will be very fast---much
7889 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7890 in an Org or Diary file.
7892 @subsubheading Appointment reminders
7893 @cindex @file{appt.el}
7894 @cindex appointment reminders
7898 Org can interact with Emacs appointments notification facility. To add the
7899 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7900 This command lets you filter through the list of your appointments and add
7901 only those belonging to a specific category or matching a regular expression.
7902 It also reads a @code{APPT_WARNTIME} property which will then override the
7903 value of @code{appt-message-warning-time} for this appointment. See the
7904 docstring for details.
7906 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7907 @subsection The global TODO list
7908 @cindex global TODO list
7909 @cindex TODO list, global
7911 The global TODO list contains all unfinished TODO items formatted and
7912 collected into a single place.
7915 @orgcmd{C-c a t,org-todo-list}
7916 Show the global TODO list. This collects the TODO items from all agenda
7917 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7918 items with a state the is not a DONE state. The buffer is in
7919 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7920 entries directly from that buffer (@pxref{Agenda commands}).
7921 @orgcmd{C-c a T,org-todo-list}
7922 @cindex TODO keyword matching
7923 @vindex org-todo-keywords
7924 Like the above, but allows selection of a specific TODO keyword. You can
7925 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7926 prompted for a keyword, and you may also specify several keywords by
7927 separating them with @samp{|} as the boolean OR operator. With a numeric
7928 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7930 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7931 a prefix argument to this command to change the selected TODO keyword,
7932 for example @kbd{3 r}. If you often need a search for a specific
7933 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7934 Matching specific TODO keywords can also be done as part of a tags
7935 search (@pxref{Tag searches}).
7938 Remote editing of TODO items means that you can change the state of a
7939 TODO entry with a single key press. The commands available in the
7940 TODO list are described in @ref{Agenda commands}.
7942 @cindex sublevels, inclusion into TODO list
7943 Normally the global TODO list simply shows all headlines with TODO
7944 keywords. This list can become very long. There are two ways to keep
7948 @vindex org-agenda-todo-ignore-scheduled
7949 @vindex org-agenda-todo-ignore-deadlines
7950 @vindex org-agenda-todo-ignore-timestamp
7951 @vindex org-agenda-todo-ignore-with-date
7952 Some people view a TODO item that has been @emph{scheduled} for execution or
7953 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7954 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7955 @code{org-agenda-todo-ignore-deadlines},
7956 @code{org-agenda-todo-ignore-timestamp} and/or
7957 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7960 @vindex org-agenda-todo-list-sublevels
7961 TODO items may have sublevels to break up the task into subtasks. In
7962 such cases it may be enough to list only the highest level TODO headline
7963 and omit the sublevels from the global list. Configure the variable
7964 @code{org-agenda-todo-list-sublevels} to get this behavior.
7967 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7968 @subsection Matching tags and properties
7969 @cindex matching, of tags
7970 @cindex matching, of properties
7974 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7975 or have properties (@pxref{Properties and Columns}), you can select headlines
7976 based on this metadata and collect them into an agenda buffer. The match
7977 syntax described here also applies when creating sparse trees with @kbd{C-c /
7981 @orgcmd{C-c a m,org-tags-view}
7982 Produce a list of all headlines that match a given set of tags. The
7983 command prompts for a selection criterion, which is a boolean logic
7984 expression with tags, like @samp{+work+urgent-withboss} or
7985 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7986 define a custom command for it (@pxref{Agenda dispatcher}).
7987 @orgcmd{C-c a M,org-tags-view}
7988 @vindex org-tags-match-list-sublevels
7989 @vindex org-agenda-tags-todo-honor-ignore-options
7990 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7991 not-DONE state and force checking subitems (see variable
7992 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7993 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7994 specific TODO keywords together with a tags match is also possible, see
7998 The commands available in the tags list are described in @ref{Agenda
8001 @subsubheading Match syntax
8003 @cindex Boolean logic, for tag/property searches
8004 A search string can use Boolean operators @samp{&} for @code{AND} and
8005 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8006 Parentheses are not implemented. Each element in the search is either a
8007 tag, a regular expression matching tags, or an expression like
8008 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8009 property value. Each element may be preceded by @samp{-}, to select
8010 against it, and @samp{+} is syntactic sugar for positive selection. The
8011 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8012 present. Here are some examples, using only tags.
8016 Select headlines tagged @samp{:work:}.
8018 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8020 Select headlines tagged @samp{:work:}, but discard those also tagged
8023 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8024 @item work|laptop+night
8025 Like before, but require the @samp{:laptop:} lines to be tagged also
8029 @cindex regular expressions, with tags search
8030 Instead of a tag, you may also specify a regular expression enclosed in curly
8031 braces. For example,
8032 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8033 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8035 @cindex group tags, as regular expressions
8036 Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g.,
8037 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8038 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8039 and searching for @samp{-work} will search for all headlines but those with
8040 one of the tag in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8042 @cindex TODO keyword matching, with tags search
8043 @cindex level, require for tags/property match
8044 @cindex category, require for tags/property match
8045 @vindex org-odd-levels-only
8046 You may also test for properties (@pxref{Properties and Columns}) at the same
8047 time as matching tags. The properties may be real properties, or special
8048 properties that represent other metadata (@pxref{Special properties}). For
8049 example, the ``property'' @code{TODO} represents the TODO keyword of the
8050 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
8051 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
8052 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
8053 DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
8054 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8055 The ITEM special property cannot currently be used in tags/property
8056 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8057 ,skipping entries based on regexp}.}.
8059 Here are more examples:
8062 @item work+TODO="WAITING"
8063 Select @samp{:work:}-tagged TODO lines with the specific TODO
8064 keyword @samp{WAITING}.
8065 @item work+TODO="WAITING"|home+TODO="WAITING"
8066 Waiting tasks both at work and at home.
8069 When matching properties, a number of different operators can be used to test
8070 the value of a property. Here is a complex example:
8073 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8074 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8078 The type of comparison will depend on how the comparison value is written:
8081 If the comparison value is a plain number, a numerical comparison is done,
8082 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8083 @samp{>=}, and @samp{<>}.
8085 If the comparison value is enclosed in double-quotes,
8086 a string comparison is done, and the same operators are allowed.
8088 If the comparison value is enclosed in double-quotes @emph{and} angular
8089 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8090 assumed to be date/time specifications in the standard Org way, and the
8091 comparison will be done accordingly. Special values that will be recognized
8092 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8093 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8094 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8095 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8096 respectively, can be used.
8098 If the comparison value is enclosed
8099 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8100 regexp matches the property value, and @samp{<>} meaning that it does not
8104 So the search string in the example finds entries tagged @samp{:work:} but
8105 not @samp{:boss:}, which also have a priority value @samp{A}, a
8106 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8107 property that is numerically smaller than 2, a @samp{:With:} property that is
8108 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8109 on or after October 11, 2008.
8111 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
8112 other properties will slow down the search. However, once you have paid the
8113 price by accessing one property, testing additional properties is cheap
8116 You can configure Org mode to use property inheritance during a search, but
8117 beware that this can slow down searches considerably. See @ref{Property
8118 inheritance}, for details.
8120 For backward compatibility, and also for typing speed, there is also a
8121 different way to test TODO states in a search. For this, terminate the
8122 tags/property part of the search string (which may include several terms
8123 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8124 expression just for TODO keywords. The syntax is then similar to that for
8125 tags, but should be applied with care: for example, a positive selection on
8126 several TODO keywords cannot meaningfully be combined with boolean AND@.
8127 However, @emph{negative selection} combined with AND can be meaningful. To
8128 make sure that only lines are checked that actually have any TODO keyword
8129 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8130 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8131 not match TODO keywords in a DONE state. Examples:
8135 Same as @samp{work+TODO="WAITING"}
8136 @item work/!-WAITING-NEXT
8137 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8139 @item work/!+WAITING|+NEXT
8140 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8144 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
8145 @subsection Timeline for a single file
8146 @cindex timeline, single file
8147 @cindex time-sorted view
8149 The timeline summarizes all time-stamped items from a single Org mode
8150 file in a @emph{time-sorted view}. The main purpose of this command is
8151 to give an overview over events in a project.
8154 @orgcmd{C-c a L,org-timeline}
8155 Show a time-sorted view of the Org file, with all time-stamped items.
8156 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8157 (scheduled or not) are also listed under the current date.
8161 The commands available in the timeline buffer are listed in
8162 @ref{Agenda commands}.
8164 @node Search view, Stuck projects, Timeline, Built-in agenda views
8165 @subsection Search view
8168 @cindex searching, for text
8170 This agenda view is a general text search facility for Org mode entries.
8171 It is particularly useful to find notes.
8174 @orgcmd{C-c a s,org-search-view}
8175 This is a special search that lets you select entries by matching a substring
8176 or specific words using a boolean logic.
8178 For example, the search string @samp{computer equipment} will find entries
8179 that contain @samp{computer equipment} as a substring. If the two words are
8180 separated by more space or a line break, the search will still match.
8181 Search view can also search for specific keywords in the entry, using Boolean
8182 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8183 will search for note entries that contain the keywords @code{computer}
8184 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8185 not matched by the regular expression @code{8\.11[bg]}, meaning to
8186 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8187 word search, other @samp{+} characters are optional. For more details, see
8188 the docstring of the command @code{org-search-view}.
8190 @vindex org-agenda-text-search-extra-files
8191 Note that in addition to the agenda files, this command will also search
8192 the files listed in @code{org-agenda-text-search-extra-files}.
8194 @node Stuck projects, , Search view, Built-in agenda views
8195 @subsection Stuck projects
8196 @pindex GTD, Getting Things Done
8198 If you are following a system like David Allen's GTD to organize your
8199 work, one of the ``duties'' you have is a regular review to make sure
8200 that all projects move along. A @emph{stuck} project is a project that
8201 has no defined next actions, so it will never show up in the TODO lists
8202 Org mode produces. During the review, you need to identify such
8203 projects and define next actions for them.
8206 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8207 List projects that are stuck.
8210 @vindex org-stuck-projects
8211 Customize the variable @code{org-stuck-projects} to define what a stuck
8212 project is and how to find it.
8215 You almost certainly will have to configure this view before it will
8216 work for you. The built-in default assumes that all your projects are
8217 level-2 headlines, and that a project is not stuck if it has at least
8218 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8220 Let's assume that you, in your own way of using Org mode, identify
8221 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8222 indicate a project that should not be considered yet. Let's further
8223 assume that the TODO keyword DONE marks finished projects, and that NEXT
8224 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8225 is a next action even without the NEXT tag. Finally, if the project
8226 contains the special word IGNORE anywhere, it should not be listed
8227 either. In this case you would start by identifying eligible projects
8228 with a tags/todo match@footnote{@xref{Tag searches}.}
8229 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8230 IGNORE in the subtree to identify projects that are not stuck. The
8231 correct customization for this is
8234 (setq org-stuck-projects
8235 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8239 Note that if a project is identified as non-stuck, the subtree of this entry
8240 will still be searched for stuck projects.
8242 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
8243 @section Presentation and sorting
8244 @cindex presentation, of agenda items
8246 @vindex org-agenda-prefix-format
8247 @vindex org-agenda-tags-column
8248 Before displaying items in an agenda view, Org mode visually prepares the
8249 items and sorts them. Each item occupies a single line. The line starts
8250 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8251 of the item and other important information. You can customize in which
8252 column tags will be displayed through @code{org-agenda-tags-column}. You can
8253 also customize the prefix using the option @code{org-agenda-prefix-format}.
8254 This prefix is followed by a cleaned-up version of the outline headline
8255 associated with the item.
8258 * Categories:: Not all tasks are equal
8259 * Time-of-day specifications:: How the agenda knows the time
8260 * Sorting agenda items:: The order of things
8261 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8264 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
8265 @subsection Categories
8269 The category is a broad label assigned to each agenda item. By default,
8270 the category is simply derived from the file name, but you can also
8271 specify it with a special line in the buffer, like this@footnote{For
8272 backward compatibility, the following also works: if there are several
8273 such lines in a file, each specifies the category for the text below it.
8274 The first category also applies to any text before the first CATEGORY
8275 line. However, using this method is @emph{strongly} deprecated as it is
8276 incompatible with the outline structure of the document. The correct
8277 method for setting multiple categories in a buffer is using a
8285 @cindex property, CATEGORY
8286 If you would like to have a special CATEGORY for a single entry or a
8287 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8288 special category you want to apply as the value.
8291 The display in the agenda buffer looks best if the category is not
8292 longer than 10 characters.
8295 You can set up icons for category by customizing the
8296 @code{org-agenda-category-icon-alist} variable.
8298 @node Time-of-day specifications, Sorting agenda items, Categories, Presentation and sorting
8299 @subsection Time-of-day specifications
8300 @cindex time-of-day specification
8302 Org mode checks each agenda item for a time-of-day specification. The
8303 time can be part of the timestamp that triggered inclusion into the
8304 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8305 ranges can be specified with two timestamps, like
8307 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8309 In the headline of the entry itself, a time(range) may also appear as
8310 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8311 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8312 specifications in diary entries are recognized as well.
8314 For agenda display, Org mode extracts the time and displays it in a
8315 standard 24 hour format as part of the prefix. The example times in
8316 the previous paragraphs would end up in the agenda like this:
8319 8:30-13:00 Arthur Dent lies in front of the bulldozer
8320 12:45...... Ford Prefect arrives and takes Arthur to the pub
8321 19:00...... The Vogon reads his poem
8322 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8326 If the agenda is in single-day mode, or for the display of today, the
8327 timed entries are embedded in a time grid, like
8330 8:00...... ------------------
8331 8:30-13:00 Arthur Dent lies in front of the bulldozer
8332 10:00...... ------------------
8333 12:00...... ------------------
8334 12:45...... Ford Prefect arrives and takes Arthur to the pub
8335 14:00...... ------------------
8336 16:00...... ------------------
8337 18:00...... ------------------
8338 19:00...... The Vogon reads his poem
8339 20:00...... ------------------
8340 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8343 @vindex org-agenda-use-time-grid
8344 @vindex org-agenda-time-grid
8345 The time grid can be turned on and off with the variable
8346 @code{org-agenda-use-time-grid}, and can be configured with
8347 @code{org-agenda-time-grid}.
8349 @node Sorting agenda items, Filtering/limiting agenda items, Time-of-day specifications, Presentation and sorting
8350 @subsection Sorting agenda items
8351 @cindex sorting, of agenda items
8352 @cindex priorities, of agenda items
8353 Before being inserted into a view, the items are sorted. How this is
8354 done depends on the type of view.
8357 @vindex org-agenda-files
8358 For the daily/weekly agenda, the items for each day are sorted. The
8359 default order is to first collect all items containing an explicit
8360 time-of-day specification. These entries will be shown at the beginning
8361 of the list, as a @emph{schedule} for the day. After that, items remain
8362 grouped in categories, in the sequence given by @code{org-agenda-files}.
8363 Within each category, items are sorted by priority (@pxref{Priorities}),
8364 which is composed of the base priority (2000 for priority @samp{A}, 1000
8365 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8366 overdue scheduled or deadline items.
8368 For the TODO list, items remain in the order of categories, but within
8369 each category, sorting takes place according to priority
8370 (@pxref{Priorities}). The priority used for sorting derives from the
8371 priority cookie, with additions depending on how close an item is to its due
8374 For tags matches, items are not sorted at all, but just appear in the
8375 sequence in which they are found in the agenda files.
8378 @vindex org-agenda-sorting-strategy
8379 Sorting can be customized using the variable
8380 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8381 the estimated effort of an entry (@pxref{Effort estimates}).
8383 @node Filtering/limiting agenda items, , Sorting agenda items, Presentation and sorting
8384 @subsection Filtering/limiting agenda items
8386 Agenda built-in or customized commands are statically defined. Agenda
8387 filters and limits provide two ways of dynamically narrowing down the list of
8388 agenda entries: @emph{fitlers} and @emph{limits}. Filters only act on the
8389 display of the items, while limits take effect before the list of agenda
8390 entries is built. Filter are more often used interactively, while limits are
8391 mostly useful when defined as local variables within custom agenda commands.
8393 @subsubheading Filtering in the agenda
8394 @cindex filtering, by tag, category, top headline and effort, in agenda
8395 @cindex tag filtering, in agenda
8396 @cindex category filtering, in agenda
8397 @cindex top headline filtering, in agenda
8398 @cindex effort filtering, in agenda
8399 @cindex query editing, in agenda
8402 @orgcmd{/,org-agenda-filter-by-tag}
8403 @vindex org-agenda-tag-filter-preset
8404 Filter the agenda view with respect to a tag and/or effort estimates. The
8405 difference between this and a custom agenda command is that filtering is very
8406 fast, so that you can switch quickly between different filters without having
8407 to recreate the agenda.@footnote{Custom commands can preset a filter by
8408 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8409 filter will then be applied to the view and persist as a basic filter through
8410 refreshes and more secondary filtering. The filter is a global property of
8411 the entire agenda view---in a block agenda, you should only set this in the
8412 global options section, not in the section of an individual block.}
8414 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8415 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8416 tag (including any tags that do not have a selection character). The command
8417 then hides all entries that do not contain or inherit this tag. When called
8418 with prefix arg, remove the entries that @emph{do} have the tag. A second
8419 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8420 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8421 will be narrowed by requiring or forbidding the selected additional tag.
8422 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8423 immediately use the @kbd{\} command.
8425 @vindex org-sort-agenda-noeffort-is-high
8426 In order to filter for effort estimates, you should set up allowed
8427 efforts globally, for example
8429 (setq org-global-properties
8430 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8432 You can then filter for an effort by first typing an operator, one of
8433 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8434 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8435 The filter will then restrict to entries with effort smaller-or-equal, equal,
8436 or larger-or-equal than the selected value. If the digits 0--9 are not used
8437 as fast access keys to tags, you can also simply press the index digit
8438 directly without an operator. In this case, @kbd{<} will be assumed. For
8439 application of the operator, entries without a defined effort will be treated
8440 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8441 for tasks without effort definition, press @kbd{?} as the operator.
8443 Org also supports automatic, context-aware tag filtering. If the variable
8444 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8445 that function can decide which tags should be excluded from the agenda
8446 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8447 as a sub-option key and runs the auto exclusion logic. For example, let's
8448 say you use a @code{Net} tag to identify tasks which need network access, an
8449 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8450 calls. You could auto-exclude these tags based on the availability of the
8451 Internet, and outside of business hours, with something like this:
8455 (defun org-my-auto-exclude-function (tag)
8457 ((string= tag "Net")
8458 (/= 0 (call-process "/sbin/ping" nil nil nil
8459 "-c1" "-q" "-t1" "mail.gnu.org")))
8460 ((or (string= tag "Errand") (string= tag "Call"))
8461 (let ((hour (nth 2 (decode-time))))
8462 (or (< hour 8) (> hour 21)))))
8465 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8469 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8470 Narrow the current agenda filter by an additional condition. When called with
8471 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8472 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8473 @kbd{-} as the first key after the @kbd{/} command.
8482 @item @r{in} search view
8483 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8484 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8485 add a positive search term prefixed by @samp{+}, indicating that this search
8486 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8487 negative search term which @i{must not} occur/match in the entry for it to be
8491 @orgcmd{<,org-agenda-filter-by-category}
8492 @vindex org-agenda-category-filter-preset
8494 Filter the current agenda view with respect to the category of the item at
8495 point. Pressing @code{<} another time will remove this filter. You can add
8496 a filter preset through the option @code{org-agenda-category-filter-preset}
8499 @orgcmd{^,org-agenda-filter-by-top-headline}
8500 Filter the current agenda view and only display the siblings and the parent
8501 headline of the one at point.
8503 @orgcmd{=,org-agenda-filter-by-regexp}
8504 @vindex org-agenda-regexp-filter-preset
8506 Filter the agenda view by a regular expression: only show agenda entries
8507 matching the regular expression the user entered. When called with a prefix
8508 argument, it will filter @emph{out} entries matching the regexp. With two
8509 universal prefix arguments, it will remove all the regexp filters, which can
8510 be accumulated. You can add a filter preset through the option
8511 @code{org-agenda-category-filter-preset} (see below.)
8513 @orgcmd{|,org-agenda-filter-remove-all}
8514 Remove all filters in the current agenda view.
8517 @subsubheading Setting limits for the agenda
8518 @cindex limits, in agenda
8519 @vindex org-agenda-max-entries
8520 @vindex org-agenda-max-effort
8521 @vindex org-agenda-max-todos
8522 @vindex org-agenda-max-tags
8524 Here is a list of options that you can set, either globally, or locally in
8525 your custom agenda views@pxref{Custom agenda views}.
8528 @item org-agenda-max-entries
8529 Limit the number of entries.
8530 @item org-agenda-max-effort
8531 Limit the duration of accumulated efforts (as minutes).
8532 @item org-agenda-max-todos
8533 Limit the number of entries with TODO keywords.
8534 @item org-agenda-max-tags
8535 Limit the number of tagged entries.
8538 When set to a positive integer, each option will exclude entries from other
8539 catogories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8540 the agenda to 100 minutes of effort and exclude any entry that as no effort
8541 property. If you want to include entries with no effort property, use a
8542 negative value for @code{org-agenda-max-effort}.
8544 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8545 command. For example, this custom command will display the next five entries
8546 with a @code{NEXT} TODO keyword.
8549 (setq org-agenda-custom-commands
8551 ((org-agenda-max-entries 5)))))
8554 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8555 will again the next five entries again, including the first entry that was
8558 You can also dynamically set temporary limits@footnote{Those temporary limits
8559 are lost when rebuilding the agenda.}:
8562 @orgcmd{~,org-agenda-limit-interactively}
8563 This prompts for the type of limit to apply and its value.
8566 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8567 @section Commands in the agenda buffer
8568 @cindex commands, in agenda buffer
8570 Entries in the agenda buffer are linked back to the Org file or diary
8571 file where they originate. You are not allowed to edit the agenda
8572 buffer itself, but commands are provided to show and jump to the
8573 original entry location, and to edit the Org files ``remotely'' from
8574 the agenda buffer. In this way, all information is stored only once,
8575 removing the risk that your agenda and note files may diverge.
8577 Some commands can be executed with mouse clicks on agenda lines. For
8578 the other commands, the cursor needs to be in the desired line.
8581 @tsubheading{Motion}
8582 @cindex motion commands in agenda
8583 @orgcmd{n,org-agenda-next-line}
8584 Next line (same as @key{down} and @kbd{C-n}).
8585 @orgcmd{p,org-agenda-previous-line}
8586 Previous line (same as @key{up} and @kbd{C-p}).
8587 @tsubheading{View/Go to Org file}
8588 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8589 Display the original location of the item in another window.
8590 With prefix arg, make sure that the entire entry is made visible in the
8591 outline, not only the heading.
8593 @orgcmd{L,org-agenda-recenter}
8594 Display original location and recenter that window.
8596 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8597 Go to the original location of the item in another window.
8599 @orgcmd{@key{RET},org-agenda-switch-to}
8600 Go to the original location of the item and delete other windows.
8602 @orgcmd{F,org-agenda-follow-mode}
8603 @vindex org-agenda-start-with-follow-mode
8604 Toggle Follow mode. In Follow mode, as you move the cursor through
8605 the agenda buffer, the other window always shows the corresponding
8606 location in the Org file. The initial setting for this mode in new
8607 agenda buffers can be set with the variable
8608 @code{org-agenda-start-with-follow-mode}.
8610 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8611 Display the entire subtree of the current item in an indirect buffer. With a
8612 numeric prefix argument N, go up to level N and then take that tree. If N is
8613 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8614 previously used indirect buffer.
8616 @orgcmd{C-c C-o,org-agenda-open-link}
8617 Follow a link in the entry. This will offer a selection of any links in the
8618 text belonging to the referenced Org node. If there is only one link, it
8619 will be followed without a selection prompt.
8621 @tsubheading{Change display}
8622 @cindex display changing, in agenda
8625 Interactively select another agenda view and append it to the current view.
8629 Delete other windows.
8631 @orgcmdkskc{v d,d,org-agenda-day-view}
8632 @xorgcmdkskc{v w,w,org-agenda-week-view}
8633 @xorgcmd{v m,org-agenda-month-view}
8634 @xorgcmd{v y,org-agenda-year-view}
8635 @xorgcmd{v SPC,org-agenda-reset-view}
8636 @vindex org-agenda-span
8637 Switch to day/week/month/year view. When switching to day or week view, this
8638 setting becomes the default for subsequent agenda refreshes. Since month and
8639 year views are slow to create, they do not become the default. A numeric
8640 prefix argument may be used to jump directly to a specific day of the year,
8641 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8642 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8643 month view, a year may be encoded in the prefix argument as well. For
8644 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8645 specification has only one or two digits, it will be mapped to the interval
8646 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8647 @code{org-agenda-span}.
8649 @orgcmd{f,org-agenda-later}
8650 Go forward in time to display the following @code{org-agenda-current-span} days.
8651 For example, if the display covers a week, switch to the following week.
8652 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8654 @orgcmd{b,org-agenda-earlier}
8655 Go backward in time to display earlier dates.
8657 @orgcmd{.,org-agenda-goto-today}
8660 @orgcmd{j,org-agenda-goto-date}
8661 Prompt for a date and go there.
8663 @orgcmd{J,org-agenda-clock-goto}
8664 Go to the currently clocked-in task @i{in the agenda buffer}.
8666 @orgcmd{D,org-agenda-toggle-diary}
8667 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8669 @orgcmdkskc{v l,l,org-agenda-log-mode}
8671 @vindex org-log-done
8672 @vindex org-agenda-log-mode-items
8673 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8674 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8675 entries that have been clocked on that day. You can configure the entry
8676 types that should be included in log mode using the variable
8677 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8678 all possible logbook entries, including state changes. When called with two
8679 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8680 @kbd{v L} is equivalent to @kbd{C-u v l}.
8682 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8683 Include inactive timestamps into the current view. Only for weekly/daily
8684 agenda and timeline views.
8686 @orgcmd{v a,org-agenda-archives-mode}
8687 @xorgcmd{v A,org-agenda-archives-mode 'files}
8688 Toggle Archives mode. In Archives mode, trees that are marked
8689 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8690 capital @kbd{A}, even all archive files are included. To exit archives mode,
8691 press @kbd{v a} again.
8693 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8694 @vindex org-agenda-start-with-clockreport-mode
8695 @vindex org-clock-report-include-clocking-task
8696 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8697 always show a table with the clocked times for the time span and file scope
8698 covered by the current agenda view. The initial setting for this mode in new
8699 agenda buffers can be set with the variable
8700 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8701 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8702 contributions from entries that are hidden by agenda filtering@footnote{Only
8703 tags filtering will be respected here, effort filtering is ignored.}. See
8704 also the variable @code{org-clock-report-include-clocking-task}.
8707 @vindex org-agenda-clock-consistency-checks
8708 Show overlapping clock entries, clocking gaps, and other clocking problems in
8709 the current agenda range. You can then visit clocking lines and fix them
8710 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8711 information on how to customize the definition of what constituted a clocking
8712 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8715 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8716 @vindex org-agenda-start-with-entry-text-mode
8717 @vindex org-agenda-entry-text-maxlines
8718 Toggle entry text mode. In entry text mode, a number of lines from the Org
8719 outline node referenced by an agenda line will be displayed below the line.
8720 The maximum number of lines is given by the variable
8721 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8722 prefix argument will temporarily modify that number to the prefix value.
8724 @orgcmd{G,org-agenda-toggle-time-grid}
8725 @vindex org-agenda-use-time-grid
8726 @vindex org-agenda-time-grid
8727 Toggle the time grid on and off. See also the variables
8728 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8730 @orgcmd{r,org-agenda-redo}
8731 Recreate the agenda buffer, for example to reflect the changes after
8732 modification of the timestamps of items with @kbd{S-@key{left}} and
8733 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8734 argument is interpreted to create a selective list for a specific TODO
8736 @orgcmd{g,org-agenda-redo}
8739 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8740 Save all Org buffers in the current Emacs session, and also the locations of
8743 @orgcmd{C-c C-x C-c,org-agenda-columns}
8744 @vindex org-columns-default-format
8745 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8746 view format is taken from the entry at point, or (if there is no entry at
8747 point), from the first entry in the agenda view. So whatever the format for
8748 that entry would be in the original buffer (taken from a property, from a
8749 @code{#+COLUMNS} line, or from the default variable
8750 @code{org-columns-default-format}), will be used in the agenda.
8752 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8753 Remove the restriction lock on the agenda, if it is currently restricted to a
8754 file or subtree (@pxref{Agenda files}).
8756 @tsubheading{Secondary filtering and query editing}
8758 For a detailed description of these commands, see @pxref{Filtering/limiting
8761 @orgcmd{/,org-agenda-filter-by-tag}
8762 @vindex org-agenda-tag-filter-preset
8763 Filter the agenda view with respect to a tag and/or effort estimates.
8765 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8766 Narrow the current agenda filter by an additional condition.
8768 @orgcmd{<,org-agenda-filter-by-category}
8769 @vindex org-agenda-category-filter-preset
8771 Filter the current agenda view with respect to the category of the item at
8772 point. Pressing @code{<} another time will remove this filter.
8774 @orgcmd{^,org-agenda-filter-by-top-headline}
8775 Filter the current agenda view and only display the siblings and the parent
8776 headline of the one at point.
8778 @orgcmd{=,org-agenda-filter-by-regexp}
8779 @vindex org-agenda-regexp-filter-preset
8781 Filter the agenda view by a regular expression: only show agenda entries
8782 matching the regular expression the user entered. When called with a prefix
8783 argument, it will filter @emph{out} entries matching the regexp. With two
8784 universal prefix arguments, it will remove all the regexp filters, which can
8785 be accumulated. You can add a filter preset through the option
8786 @code{org-agenda-category-filter-preset} (see below.)
8788 @orgcmd{|,org-agenda-filter-remove-all}
8789 Remove all filters in the current agenda view.
8791 @tsubheading{Remote editing}
8792 @cindex remote editing, from agenda
8797 @cindex undoing remote-editing events
8798 @cindex remote editing, undo
8799 @orgcmd{C-_,org-agenda-undo}
8800 Undo a change due to a remote editing command. The change is undone
8801 both in the agenda buffer and in the remote buffer.
8803 @orgcmd{t,org-agenda-todo}
8804 Change the TODO state of the item, both in the agenda and in the
8807 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8808 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8809 Switch to the next/previous set of TODO keywords.
8811 @orgcmd{C-k,org-agenda-kill}
8812 @vindex org-agenda-confirm-kill
8813 Delete the current agenda item along with the entire subtree belonging
8814 to it in the original Org file. If the text to be deleted remotely
8815 is longer than one line, the kill needs to be confirmed by the user. See
8816 variable @code{org-agenda-confirm-kill}.
8818 @orgcmd{C-c C-w,org-agenda-refile}
8819 Refile the entry at point.
8821 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8822 @vindex org-archive-default-command
8823 Archive the subtree corresponding to the entry at point using the default
8824 archiving command set in @code{org-archive-default-command}. When using the
8825 @code{a} key, confirmation will be required.
8827 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8828 Toggle the ARCHIVE tag for the current headline.
8830 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8831 Move the subtree corresponding to the current entry to its @emph{archive
8834 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8835 Archive the subtree corresponding to the current headline. This means the
8836 entry will be moved to the configured archive location, most likely a
8839 @orgcmd{T,org-agenda-show-tags}
8840 @vindex org-agenda-show-inherited-tags
8841 Show all tags associated with the current item. This is useful if you have
8842 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8843 tags of a headline occasionally.
8845 @orgcmd{:,org-agenda-set-tags}
8846 Set tags for the current headline. If there is an active region in the
8847 agenda, change a tag for all headings in the region.
8851 Set the priority for the current item (@command{org-agenda-priority}).
8852 Org mode prompts for the priority character. If you reply with @key{SPC},
8853 the priority cookie is removed from the entry.
8855 @orgcmd{P,org-agenda-show-priority}
8856 Display weighted priority of current item.
8858 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8859 Increase the priority of the current item. The priority is changed in
8860 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8863 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8864 Decrease the priority of the current item.
8866 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8867 @vindex org-log-into-drawer
8868 Add a note to the entry. This note will be recorded, and then filed to the
8869 same location where state change notes are put. Depending on
8870 @code{org-log-into-drawer}, this may be inside a drawer.
8872 @orgcmd{C-c C-a,org-attach}
8873 Dispatcher for all command related to attachments.
8875 @orgcmd{C-c C-s,org-agenda-schedule}
8876 Schedule this item. With prefix arg remove the scheduling timestamp
8878 @orgcmd{C-c C-d,org-agenda-deadline}
8879 Set a deadline for this item. With prefix arg remove the deadline.
8881 @orgcmd{S-@key{right},org-agenda-do-date-later}
8882 Change the timestamp associated with the current line by one day into the
8883 future. If the date is in the past, the first call to this command will move
8885 With a numeric prefix argument, change it by that many days. For example,
8886 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8887 change the time by one hour. If you immediately repeat the command, it will
8888 continue to change hours even without the prefix arg. With a double @kbd{C-u
8889 C-u} prefix, do the same for changing minutes.@*
8890 The stamp is changed in the original Org file, but the change is not directly
8891 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8893 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8894 Change the timestamp associated with the current line by one day
8897 @orgcmd{>,org-agenda-date-prompt}
8898 Change the timestamp associated with the current line. The key @kbd{>} has
8899 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8901 @orgcmd{I,org-agenda-clock-in}
8902 Start the clock on the current item. If a clock is running already, it
8905 @orgcmd{O,org-agenda-clock-out}
8906 Stop the previously started clock.
8908 @orgcmd{X,org-agenda-clock-cancel}
8909 Cancel the currently running clock.
8911 @orgcmd{J,org-agenda-clock-goto}
8912 Jump to the running clock in another window.
8914 @orgcmd{k,org-agenda-capture}
8915 Like @code{org-capture}, but use the date at point as the default date for
8916 the capture template. See @code{org-capture-use-agenda-date} to make this
8917 the default behavior of @code{org-capture}.
8918 @cindex capturing, from agenda
8919 @vindex org-capture-use-agenda-date
8921 @tsubheading{Dragging agenda lines forward/backward}
8922 @cindex dragging, agenda lines
8924 @orgcmd{M-<up>,org-agenda-drag-line-backward}
8925 Drag the line at point backward one line@footnote{Moving agenda lines does
8926 not persist after an agenda refresh and does not modify the contributing
8927 @file{.org} files}. With a numeric prefix argument, drag backward by that
8930 @orgcmd{M-<down>,org-agenda-drag-line-forward}
8931 Drag the line at point forward one line. With a numeric prefix argument,
8932 drag forward by that many lines.
8934 @tsubheading{Bulk remote editing selected entries}
8935 @cindex remote editing, bulk, from agenda
8936 @vindex org-agenda-bulk-custom-functions
8938 @orgcmd{m,org-agenda-bulk-mark}
8939 Mark the entry at point for bulk action. With numeric prefix argument, mark
8940 that many successive entries.
8942 @orgcmd{*,org-agenda-bulk-mark-all}
8943 Mark all visible agenda entries for bulk action.
8945 @orgcmd{u,org-agenda-bulk-unmark}
8946 Unmark entry at point for bulk action.
8948 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8949 Unmark all marked entries for bulk action.
8951 @orgcmd{M-m,org-agenda-bulk-toggle}
8952 Toggle mark of the entry at point for bulk action.
8954 @orgcmd{M-*,org-agenda-bulk-toggle-all}
8955 Toggle marks of all visible entries for bulk action.
8957 @orgcmd{%,org-agenda-bulk-mark-regexp}
8958 Mark entries matching a regular expression for bulk action.
8960 @orgcmd{B,org-agenda-bulk-action}
8961 Bulk action: act on all marked entries in the agenda. This will prompt for
8962 another key to select the action to be applied. The prefix arg to @kbd{B}
8963 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8964 these special timestamps. By default, marks are removed after the bulk. If
8965 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8966 @code{t} or hit @kbd{p} at the prompt.
8970 Toggle persistent marks.
8972 Archive all selected entries.
8974 Archive entries by moving them to their respective archive siblings.
8976 Change TODO state. This prompts for a single TODO keyword and changes the
8977 state of all selected entries, bypassing blocking and suppressing logging
8978 notes (but not timestamps).
8980 Add a tag to all selected entries.
8982 Remove a tag from all selected entries.
8984 Schedule all items to a new date. To shift existing schedule dates by a
8985 fixed number of days, use something starting with double plus at the prompt,
8986 for example @samp{++8d} or @samp{++2w}.
8988 Set deadline to a specific date.
8990 Prompt for a single refile target and move all entries. The entries will no
8991 longer be in the agenda; refresh (@kbd{g}) to bring them back.
8993 Reschedule randomly into the coming N days. N will be prompted for. With
8994 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
8996 Apply a function@footnote{You can also create persistent custom functions
8997 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
8998 example, the function below sets the CATEGORY property of the entries to web.
9002 (defun set-category ()
9004 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9005 (org-agenda-error)))
9006 (buffer (marker-buffer marker)))
9007 (with-current-buffer buffer
9012 (org-back-to-heading t)
9013 (org-set-property "CATEGORY" "web"))))))
9018 @tsubheading{Calendar commands}
9019 @cindex calendar commands, from agenda
9021 @orgcmd{c,org-agenda-goto-calendar}
9022 Open the Emacs calendar and move to the date at the agenda cursor.
9024 @orgcmd{c,org-calendar-goto-agenda}
9025 When in the calendar, compute and show the Org mode agenda for the
9028 @cindex diary entries, creating from agenda
9029 @orgcmd{i,org-agenda-diary-entry}
9030 @vindex org-agenda-diary-file
9031 Insert a new entry into the diary, using the date at the cursor and (for
9032 block entries) the date at the mark. This will add to the Emacs diary
9033 file@footnote{This file is parsed for the agenda when
9034 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9035 command in the calendar. The diary file will pop up in another window, where
9036 you can add the entry.
9038 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9039 Org will create entries (in Org mode syntax) in that file instead. Most
9040 entries will be stored in a date-based outline tree that will later make it
9041 easy to archive appointments from previous months/years. The tree will be
9042 built under an entry with a @code{DATE_TREE} property, or else with years as
9043 top-level entries. Emacs will prompt you for the entry text---if you specify
9044 it, the entry will be created in @code{org-agenda-diary-file} without further
9045 interaction. If you directly press @key{RET} at the prompt without typing
9046 text, the target file will be shown in another window for you to finish the
9047 entry there. See also the @kbd{k r} command.
9049 @orgcmd{M,org-agenda-phases-of-moon}
9050 Show the phases of the moon for the three months around current date.
9052 @orgcmd{S,org-agenda-sunrise-sunset}
9053 Show sunrise and sunset times. The geographical location must be set
9054 with calendar variables, see the documentation for the Emacs calendar.
9056 @orgcmd{C,org-agenda-convert-date}
9057 Convert the date at cursor into many other cultural and historic
9060 @orgcmd{H,org-agenda-holidays}
9061 Show holidays for three months around the cursor date.
9063 @item M-x org-icalendar-combine-agenda-files RET
9064 Export a single iCalendar file containing entries from all agenda files.
9065 This is a globally available command, and also available in the agenda menu.
9067 @tsubheading{Exporting to a file}
9068 @orgcmd{C-x C-w,org-agenda-write}
9069 @cindex exporting agenda views
9070 @cindex agenda views, exporting
9071 @vindex org-agenda-exporter-settings
9072 Write the agenda view to a file. Depending on the extension of the selected
9073 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9074 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9075 (any other extension). When exporting to Org, only the body of original
9076 headlines are exported, not subtrees or inherited tags. When called with a
9077 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9078 variable @code{org-agenda-exporter-settings} to set options for
9079 @file{ps-print} and for @file{htmlize} to be used during export.
9081 @tsubheading{Quit and Exit}
9082 @orgcmd{q,org-agenda-quit}
9083 Quit agenda, remove the agenda buffer.
9085 @cindex agenda files, removing buffers
9086 @orgcmd{x,org-agenda-exit}
9087 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9088 for the compilation of the agenda. Buffers created by the user to
9089 visit Org files will not be removed.
9093 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
9094 @section Custom agenda views
9095 @cindex custom agenda views
9096 @cindex agenda views, custom
9098 Custom agenda commands serve two purposes: to store and quickly access
9099 frequently used TODO and tags searches, and to create special composite
9100 agenda buffers. Custom agenda commands will be accessible through the
9101 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9104 * Storing searches:: Type once, use often
9105 * Block agenda:: All the stuff you need in a single buffer
9106 * Setting Options:: Changing the rules
9109 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
9110 @subsection Storing searches
9112 The first application of custom searches is the definition of keyboard
9113 shortcuts for frequently used searches, either creating an agenda
9114 buffer, or a sparse tree (the latter covering of course only the current
9117 @vindex org-agenda-custom-commands
9118 @cindex agenda views, main example
9119 @cindex agenda, as an agenda views
9120 @cindex agenda*, as an agenda views
9121 @cindex tags, as an agenda view
9122 @cindex todo, as an agenda view
9128 Custom commands are configured in the variable
9129 @code{org-agenda-custom-commands}. You can customize this variable, for
9130 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9131 Lisp in @file{.emacs}. The following example contains all valid agenda
9136 (setq org-agenda-custom-commands
9139 ("w" todo "WAITING")
9140 ("W" todo-tree "WAITING")
9141 ("u" tags "+boss-urgent")
9142 ("v" tags-todo "+boss-urgent")
9143 ("U" tags-tree "+boss-urgent")
9144 ("f" occur-tree "\\<FIXME\\>")
9145 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9146 ("hl" tags "+home+Lisa")
9147 ("hp" tags "+home+Peter")
9148 ("hk" tags "+home+Kim")))
9153 The initial string in each entry defines the keys you have to press
9154 after the dispatcher command @kbd{C-c a} in order to access the command.
9155 Usually this will be just a single character, but if you have many
9156 similar commands, you can also define two-letter combinations where the
9157 first character is the same in several combinations and serves as a
9158 prefix key@footnote{You can provide a description for a prefix key by
9159 inserting a cons cell with the prefix and the description.}. The second
9160 parameter is the search type, followed by the string or regular
9161 expression to be used for the matching. The example above will
9166 as a global search for agenda entries planned@footnote{@emph{Planned} means
9167 here that these entries have some planning information attached to them, like
9168 a time-stamp, a scheduled or a deadline string. See
9169 @code{org-agenda-entry-types} on how to set what planning information will be
9170 taken into account.} this week/day.
9172 as a global search for agenda entries planned this week/day, but only those
9173 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9175 as a global search for TODO entries with @samp{WAITING} as the TODO
9178 as the same search, but only in the current buffer and displaying the
9179 results as a sparse tree
9181 as a global tags search for headlines marked @samp{:boss:} but not
9184 as the same search as @kbd{C-c a u}, but limiting the search to
9185 headlines that are also TODO items
9187 as the same search as @kbd{C-c a u}, but only in the current buffer and
9188 displaying the result as a sparse tree
9190 to create a sparse tree (again: current buffer only) with all entries
9191 containing the word @samp{FIXME}
9193 as a prefix command for a HOME tags search where you have to press an
9194 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9195 Peter, or Kim) as additional tag to match.
9198 Note that the @code{*-tree} agenda views need to be called from an
9199 Org buffer as they operate on the current buffer only.
9201 @node Block agenda, Setting Options, Storing searches, Custom agenda views
9202 @subsection Block agenda
9203 @cindex block agenda
9204 @cindex agenda, with block views
9206 Another possibility is the construction of agenda views that comprise
9207 the results of @emph{several} commands, each of which creates a block in
9208 the agenda buffer. The available commands include @code{agenda} for the
9209 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9210 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9211 matching commands discussed above: @code{todo}, @code{tags}, and
9212 @code{tags-todo}. Here are two examples:
9216 (setq org-agenda-custom-commands
9217 '(("h" "Agenda and Home-related tasks"
9221 ("o" "Agenda and Office-related tasks"
9229 This will define @kbd{C-c a h} to create a multi-block view for stuff
9230 you need to attend to at home. The resulting agenda buffer will contain
9231 your agenda for the current week, all TODO items that carry the tag
9232 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9233 command @kbd{C-c a o} provides a similar view for office tasks.
9235 @node Setting Options, , Block agenda, Custom agenda views
9236 @subsection Setting options for custom commands
9237 @cindex options, for custom agenda views
9239 @vindex org-agenda-custom-commands
9240 Org mode contains a number of variables regulating agenda construction
9241 and display. The global variables define the behavior for all agenda
9242 commands, including the custom commands. However, if you want to change
9243 some settings just for a single custom view, you can do so. Setting
9244 options requires inserting a list of variable names and values at the
9245 right spot in @code{org-agenda-custom-commands}. For example:
9249 (setq org-agenda-custom-commands
9250 '(("w" todo "WAITING"
9251 ((org-agenda-sorting-strategy '(priority-down))
9252 (org-agenda-prefix-format " Mixed: ")))
9253 ("U" tags-tree "+boss-urgent"
9254 ((org-show-following-heading nil)
9255 (org-show-hierarchy-above nil)))
9257 ((org-agenda-files '("~org/notes.org"))
9258 (org-agenda-text-search-extra-files nil)))))
9263 Now the @kbd{C-c a w} command will sort the collected entries only by
9264 priority, and the prefix format is modified to just say @samp{ Mixed: }
9265 instead of giving the category of the entry. The sparse tags tree of
9266 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9267 headline hierarchy above the match, nor the headline following the match
9268 will be shown. The command @kbd{C-c a N} will do a text search limited
9269 to only a single file.
9271 @vindex org-agenda-custom-commands
9272 For command sets creating a block agenda,
9273 @code{org-agenda-custom-commands} has two separate spots for setting
9274 options. You can add options that should be valid for just a single
9275 command in the set, and options that should be valid for all commands in
9276 the set. The former are just added to the command entry; the latter
9277 must come after the list of command entries. Going back to the block
9278 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9279 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9280 the results for GARDEN tags query in the opposite order,
9281 @code{priority-up}. This would look like this:
9285 (setq org-agenda-custom-commands
9286 '(("h" "Agenda and Home-related tasks"
9290 ((org-agenda-sorting-strategy '(priority-up)))))
9291 ((org-agenda-sorting-strategy '(priority-down))))
9292 ("o" "Agenda and Office-related tasks"
9299 As you see, the values and parentheses setting is a little complex.
9300 When in doubt, use the customize interface to set this variable---it
9301 fully supports its structure. Just one caveat: when setting options in
9302 this interface, the @emph{values} are just Lisp expressions. So if the
9303 value is a string, you need to add the double-quotes around the value
9306 @vindex org-agenda-custom-commands-contexts
9307 To control whether an agenda command should be accessible from a specific
9308 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9309 say for example that you have an agenda commands @code{"o"} displaying a view
9310 that you only need when reading emails. Then you would configure this option
9314 (setq org-agenda-custom-commands-contexts
9315 '(("o" (in-mode . "message-mode"))))
9318 You can also tell that the command key @code{"o"} should refer to another
9319 command key @code{"r"}. In that case, add this command key like this:
9322 (setq org-agenda-custom-commands-contexts
9323 '(("o" "r" (in-mode . "message-mode"))))
9326 See the docstring of the variable for more information.
9328 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
9329 @section Exporting Agenda Views
9330 @cindex agenda views, exporting
9332 If you are away from your computer, it can be very useful to have a printed
9333 version of some agenda views to carry around. Org mode can export custom
9334 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9335 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9336 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9337 a PDF file will also create the postscript file.}, and iCalendar files. If
9338 you want to do this only occasionally, use the command
9341 @orgcmd{C-x C-w,org-agenda-write}
9342 @cindex exporting agenda views
9343 @cindex agenda views, exporting
9344 @vindex org-agenda-exporter-settings
9345 Write the agenda view to a file. Depending on the extension of the selected
9346 file name, the view will be exported as HTML (extension @file{.html} or
9347 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9348 @file{.ics}), or plain text (any other extension). Use the variable
9349 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9350 for @file{htmlize} to be used during export, for example
9352 @vindex org-agenda-add-entry-text-maxlines
9353 @vindex htmlize-output-type
9354 @vindex ps-number-of-columns
9355 @vindex ps-landscape-mode
9357 (setq org-agenda-exporter-settings
9358 '((ps-number-of-columns 2)
9359 (ps-landscape-mode t)
9360 (org-agenda-add-entry-text-maxlines 5)
9361 (htmlize-output-type 'css)))
9365 If you need to export certain agenda views frequently, you can associate
9366 any custom agenda command with a list of output file names
9367 @footnote{If you want to store standard views like the weekly agenda
9368 or the global TODO list as well, you need to define custom commands for
9369 them in order to be able to specify file names.}. Here is an example
9370 that first defines custom commands for the agenda and the global
9371 TODO list, together with a number of files to which to export them.
9372 Then we define two block agenda commands and specify file names for them
9373 as well. File names can be relative to the current working directory,
9378 (setq org-agenda-custom-commands
9379 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9380 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9381 ("h" "Agenda and Home-related tasks"
9386 ("~/views/home.html"))
9387 ("o" "Agenda and Office-related tasks"
9392 ("~/views/office.ps" "~/calendars/office.ics"))))
9396 The extension of the file name determines the type of export. If it is
9397 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9398 the buffer to HTML and save it to this file name. If the extension is
9399 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9400 Postscript output. If the extension is @file{.ics}, iCalendar export is
9401 run export over all files that were used to construct the agenda, and
9402 limit the export to entries listed in the agenda. Any other
9403 extension produces a plain ASCII file.
9405 The export files are @emph{not} created when you use one of those
9406 commands interactively because this might use too much overhead.
9407 Instead, there is a special command to produce @emph{all} specified
9411 @orgcmd{C-c a e,org-store-agenda-views}
9412 Export all agenda views that have export file names associated with
9416 You can use the options section of the custom agenda commands to also
9417 set options for the export commands. For example:
9420 (setq org-agenda-custom-commands
9422 ((ps-number-of-columns 2)
9423 (ps-landscape-mode t)
9424 (org-agenda-prefix-format " [ ] ")
9425 (org-agenda-with-colors nil)
9426 (org-agenda-remove-tags t))
9431 This command sets two options for the Postscript exporter, to make it
9432 print in two columns in landscape format---the resulting page can be cut
9433 in two and then used in a paper agenda. The remaining settings modify
9434 the agenda prefix to omit category and scheduling information, and
9435 instead include a checkbox to check off items. We also remove the tags
9436 to make the lines compact, and we don't want to use colors for the
9437 black-and-white printer. Settings specified in
9438 @code{org-agenda-exporter-settings} will also apply, but the settings
9439 in @code{org-agenda-custom-commands} take precedence.
9442 From the command line you may also use
9444 emacs -eval (org-batch-store-agenda-views) -kill
9447 or, if you need to modify some parameters@footnote{Quoting depends on the
9448 system you use, please check the FAQ for examples.}
9450 emacs -eval '(org-batch-store-agenda-views \
9451 org-agenda-span (quote month) \
9452 org-agenda-start-day "2007-11-01" \
9453 org-agenda-include-diary nil \
9454 org-agenda-files (quote ("~/org/project.org")))' \
9458 which will create the agenda views restricted to the file
9459 @file{~/org/project.org}, without diary entries and with a 30-day
9462 You can also extract agenda information in a way that allows further
9463 processing by other programs. See @ref{Extracting agenda information}, for
9467 @node Agenda column view, , Exporting Agenda Views, Agenda Views
9468 @section Using column view in the agenda
9469 @cindex column view, in agenda
9470 @cindex agenda, column view
9472 Column view (@pxref{Column view}) is normally used to view and edit
9473 properties embedded in the hierarchical structure of an Org file. It can be
9474 quite useful to use column view also from the agenda, where entries are
9475 collected by certain criteria.
9478 @orgcmd{C-c C-x C-c,org-agenda-columns}
9479 Turn on column view in the agenda.
9482 To understand how to use this properly, it is important to realize that the
9483 entries in the agenda are no longer in their proper outline environment.
9484 This causes the following issues:
9488 @vindex org-columns-default-format
9489 @vindex org-overriding-columns-format
9490 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9491 entries in the agenda are collected from different files, and different files
9492 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9493 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9494 currently set, and if so, takes the format from there. Otherwise it takes
9495 the format associated with the first item in the agenda, or, if that item
9496 does not have a specific format (defined in a property, or in its file), it
9497 uses @code{org-columns-default-format}.
9499 @cindex property, special, CLOCKSUM
9500 If any of the columns has a summary type defined (@pxref{Column attributes}),
9501 turning on column view in the agenda will visit all relevant agenda files and
9502 make sure that the computations of this property are up to date. This is
9503 also true for the special @code{CLOCKSUM} property. Org will then sum the
9504 values displayed in the agenda. In the daily/weekly agenda, the sums will
9505 cover a single day; in all other views they cover the entire block. It is
9506 vital to realize that the agenda may show the same entry @emph{twice} (for
9507 example as scheduled and as a deadline), and it may show two entries from the
9508 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9509 cases, the summation in the agenda will lead to incorrect results because
9510 some values will count double.
9512 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9513 the entire clocked time for this item. So even in the daily/weekly agenda,
9514 the clocksum listed in column view may originate from times outside the
9515 current view. This has the advantage that you can compare these values with
9516 a column listing the planned total effort for a task---one of the major
9517 applications for column view in the agenda. If you want information about
9518 clocked time in the displayed period use clock table mode (press @kbd{R} in
9522 @cindex property, special, CLOCKSUM_T
9523 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9524 always today's clocked time for this item. So even in the weekly agenda,
9525 the clocksum listed in column view only originates from today. This lets
9526 you compare the time you spent on a task for today, with the time already
9527 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9531 @node Markup, Exporting, Agenda Views, Top
9532 @chapter Markup for rich export
9534 When exporting Org mode documents, the exporter tries to reflect the
9535 structure of the document as accurately as possible in the back-end. Since
9536 export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has
9537 rules on how to prepare text for rich export. This section summarizes the
9538 markup rules used in an Org mode buffer.
9541 * Structural markup elements:: The basic structure as seen by the exporter
9542 * Images and tables:: Images, tables and caption mechanism
9543 * Literal examples:: Source code examples with special formatting
9544 * Include files:: Include additional files into a document
9545 * Index entries:: Making an index
9546 * Macro replacement:: Use macros to create templates
9547 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9548 * Special blocks:: Containers targeted at export back-ends
9551 @node Structural markup elements, Images and tables, Markup, Markup
9552 @section Structural markup elements
9555 * Document title:: Where the title is taken from
9556 * Headings and sections:: The document structure as seen by the exporter
9557 * Table of contents:: The if and where of the table of contents
9559 * Paragraphs:: Paragraphs
9560 * Footnote markup:: Footnotes
9561 * Emphasis and monospace:: Bold, italic, etc.
9562 * Horizontal rules:: Make a line
9563 * Comment lines:: What will *not* be exported
9566 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9567 @subheading Document title
9568 @cindex document title, markup rules
9571 The title of the exported document is taken from the special line
9575 #+TITLE: This is the title of the document
9579 If this line does not exist, the title will be the name of the file
9580 associated to buffer, without extension, or the buffer name.
9582 @cindex property, EXPORT_TITLE
9583 If you are exporting only a subtree by marking is as the region, the heading
9584 of the subtree will become the title of the document. If the subtree has a
9585 property @code{EXPORT_TITLE}, that will take precedence.
9587 @node Headings and sections, Table of contents, Document title, Structural markup elements
9588 @subheading Headings and sections
9589 @cindex headings and sections, markup rules
9591 @vindex org-export-headline-levels
9592 The outline structure of the document as described in @ref{Document
9593 Structure}, forms the basis for defining sections of the exported document.
9594 However, since the outline structure is also used for (for example) lists of
9595 tasks, only the first three outline levels will be used as headings. Deeper
9596 levels will become itemized lists. You can change the location of this
9597 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9598 per-file basis with a line
9605 @node Table of contents, Lists, Headings and sections, Structural markup elements
9606 @subheading Table of contents
9607 @cindex table of contents, markup rules
9610 @vindex org-export-with-toc
9611 The table of contents is normally inserted directly before the first headline
9612 of the file. The depth of the table is by default the same as the number of
9613 headline levels, but you can choose a smaller number, or turn off the table
9614 of contents entirely, by configuring the variable @code{org-export-with-toc},
9615 or on a per-file basis with a line like
9618 #+OPTIONS: toc:2 (only to two levels in TOC)
9619 #+OPTIONS: toc:nil (no default TOC at all)
9622 If you would like to move the table of contents to a different location, you
9623 should turn off the detault table using @code{org-export-with-toc} or
9624 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9628 #+OPTIONS: toc:nil (no default TOC)
9630 #+TOC: headlines 2 (insert TOC here, with two headline levels)
9633 Multiple @code{#+TOC: headline} lines are allowed. The same @code{TOC}
9634 keyword can also generate a list of all tables (resp.@: all listings) with a
9635 caption in the buffer.
9638 #+TOC: listings (build a list of listings)
9639 #+TOC: tables (build a list of tables)
9642 @cindex property, ALT_TITLE
9643 The headline's title usually determines its corresponding entry in a table of
9644 contents. However, it is possible to specify an alternative title by
9645 setting @code{ALT_TITLE} property accordingly. It will then be used when
9648 @node Lists, Paragraphs, Table of contents, Structural markup elements
9650 @cindex lists, markup rules
9652 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9653 syntax for such lists. Most back-ends support unordered, ordered, and
9656 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9657 @subheading Paragraphs, line breaks, and quoting
9658 @cindex paragraphs, markup rules
9660 Paragraphs are separated by at least one empty line. If you need to enforce
9661 a line break within a paragraph, use @samp{\\} at the end of a line.
9663 To keep the line breaks in a region, but otherwise use normal formatting, you
9664 can use this construct, which can also be used to format poetry.
9666 @cindex #+BEGIN_VERSE
9669 Great clouds overhead
9670 Tiny black birds rise and fall
9677 When quoting a passage from another document, it is customary to format this
9678 as a paragraph that is indented on both the left and the right margin. You
9679 can include quotations in Org mode documents like this:
9681 @cindex #+BEGIN_QUOTE
9684 Everything should be made as simple as possible,
9685 but not any simpler -- Albert Einstein
9689 If you would like to center some text, do it like this:
9690 @cindex #+BEGIN_CENTER
9693 Everything should be made as simple as possible, \\
9699 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9700 @subheading Footnote markup
9701 @cindex footnotes, markup rules
9702 @cindex @file{footnote.el}
9704 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9705 by all back-ends. Org allows multiple references to the same note, and
9706 multiple footnotes side by side.
9708 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9709 @subheading Emphasis and monospace
9711 @cindex underlined text, markup rules
9712 @cindex bold text, markup rules
9713 @cindex italic text, markup rules
9714 @cindex verbatim text, markup rules
9715 @cindex code text, markup rules
9716 @cindex strike-through text, markup rules
9717 @vindex org-fontify-emphasized-text
9718 @vindex org-emphasis-regexp-components
9719 @vindex org-emphasis-alist
9720 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9721 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
9722 in the code and verbatim string is not processed for Org mode specific
9723 syntax, it is exported verbatim.
9725 To turn off fontification for marked up text, you can set
9726 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9727 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9728 tune what characters are allowed before and after the markup characters, you
9729 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9730 the above variables will no take effect until you reload Org, for which you
9731 may need to restart Emacs.
9733 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9734 @subheading Horizontal rules
9735 @cindex horizontal rules, markup rules
9736 A line consisting of only dashes, and at least 5 of them, will be exported as
9737 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9739 @node Comment lines, , Horizontal rules, Structural markup elements
9740 @subheading Comment lines
9741 @cindex comment lines
9742 @cindex exporting, not
9743 @cindex #+BEGIN_COMMENT
9745 Lines starting with zero or more whitespace characters followed by one
9746 @samp{#} and a whitespace are treated as comments and will never be exported.
9747 Also entire subtrees starting with the word @samp{COMMENT} will never be
9748 exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9749 ... @samp{#+END_COMMENT} will not be exported.
9754 Toggle the COMMENT keyword at the beginning of an entry.
9758 @node Images and tables, Literal examples, Structural markup elements, Markup
9759 @section Images and Tables
9761 @cindex tables, markup rules
9764 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9765 the @file{table.el} package will be exported properly. For Org mode tables,
9766 the lines before the first horizontal separator line will become table header
9767 lines. You can use the following lines somewhere before the table to assign
9768 a caption and a label for cross references, and in the text you can refer to
9769 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9772 #+CAPTION: This is the caption for the next table (or link)
9773 #+NAME: tab:basic-data
9778 Optionally, the caption can take the form:
9780 #+CAPTION[Caption for list of tables]: Caption for table.
9783 @cindex inlined images, markup rules
9784 Some back-ends allow you to directly include images into the exported
9785 document. Org does this, if a link to an image files does not have
9786 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9787 define a caption for the image and maybe a label for internal cross
9788 references, make sure that the link is on a line by itself and precede it
9789 with @code{#+CAPTION} and @code{#+NAME} as follows:
9792 #+CAPTION: This is the caption for the next figure link (or table)
9793 #+NAME: fig:SED-HR4049
9798 Such images can be displayed within the buffer. @xref{Handling links,the
9799 discussion of image links}.
9801 Even though images and tables are prominent examples of captioned structures,
9802 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9803 equations, source code blocks). Depending on the export back-end, those may
9804 or may not be handled.
9806 @node Literal examples, Include files, Images and tables, Markup
9807 @section Literal examples
9808 @cindex literal examples, markup rules
9809 @cindex code line references, markup rules
9811 You can include literal examples that should not be subjected to
9812 markup. Such examples will be typeset in monospace, so this is well suited
9813 for source code and similar examples.
9814 @cindex #+BEGIN_EXAMPLE
9818 Some example from a text file.
9822 Note that such blocks may be @i{indented} in order to align nicely with
9823 indented text and in particular with plain list structure (@pxref{Plain
9824 lists}). For simplicity when using small examples, you can also start the
9825 example lines with a colon followed by a space. There may also be additional
9826 whitespace before the colon:
9830 : Some example from a text file.
9833 @cindex formatting source code, markup rules
9834 If the example is source code from a programming language, or any other text
9835 that can be marked up by font-lock in Emacs, you can ask for the example to
9836 look like the fontified Emacs buffer@footnote{This works automatically for
9837 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9838 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9839 achieved using either the listings or the
9840 @url{http://code.google.com/p/minted, minted,} package. Refer to
9841 @code{org-latex-listings} documentation for details.}. This is done
9842 with the @samp{src} block, where you also need to specify the name of the
9843 major mode that should be used to fontify the example@footnote{Code in
9844 @samp{src} blocks may also be evaluated either interactively or on export.
9845 See @pxref{Working With Source Code} for more information on evaluating code
9846 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9851 #+BEGIN_SRC emacs-lisp
9852 (defun org-xor (a b)
9858 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9859 switch to the end of the @code{BEGIN} line, to get the lines of the example
9860 numbered. If you use a @code{+n} switch, the numbering from the previous
9861 numbered snippet will be continued in the current one. In literal examples,
9862 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9863 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9864 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9865 link will remote-highlight the corresponding code line, which is kind of
9868 You can also add a @code{-r} switch which @i{removes} the labels from the
9869 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9870 labels in the source code while using line numbers for the links, which might
9871 be useful to explain those in an Org mode example code.}. With the @code{-n}
9872 switch, links to these references will be labeled by the line numbers from
9873 the code listing, otherwise links will use the labels with no parentheses.
9877 #+BEGIN_SRC emacs-lisp -n -r
9878 (save-excursion (ref:sc)
9879 (goto-char (point-min)) (ref:jump)
9881 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9885 @vindex org-coderef-label-format
9886 If the syntax for the label format conflicts with the language syntax, use a
9887 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9888 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9890 HTML export also allows examples to be published as text areas (@pxref{Text
9891 areas in HTML export}).
9893 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9894 so often, shortcuts are provided using the Easy Templates facility
9895 (@pxref{Easy Templates}).
9900 Edit the source code example at point in its native mode. This works by
9901 switching to a temporary buffer with the source code. You need to exit by
9902 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9903 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9904 from being interpreted by Org as outline nodes or special syntax. These
9905 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9906 The edited version will then replace the old version in the Org buffer.
9907 Fixed-width regions (where each line starts with a colon followed by a space)
9908 will be edited using @code{artist-mode}@footnote{You may select
9909 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9910 to allow creating ASCII drawings easily. Using this command in an empty line
9911 will create a new fixed-width region.
9914 Calling @code{org-store-link} while editing a source code example in a
9915 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9916 that it is unique in the current buffer, and insert it with the proper
9917 formatting like @samp{(ref:label)} at the end of the current line. Then the
9918 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9922 @node Include files, Index entries, Literal examples, Markup
9923 @section Include files
9924 @cindex include files, markup rules
9926 During export, you can include the content of another file. For example, to
9927 include your @file{.emacs} file, you could use:
9931 #+INCLUDE: "~/.emacs" src emacs-lisp
9935 The optional second and third parameter are the markup (e.g., @samp{quote},
9936 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9937 language for formatting the contents. The markup is optional; if it is not
9938 given, the text will be assumed to be in Org mode format and will be
9941 Contents of the included file will belong to the same structure (headline,
9942 item) containing the @code{INCLUDE} keyword. In particular, headlines within
9943 the file will become children of the current section. That behaviour can be
9944 changed by providing an additional keyword parameter, @code{:minlevel}. In
9945 that case, all headlines in the included file will be shifted so the one with
9946 the lowest level reaches that specified level. For example, to make a file
9947 become a sibling of the current top-level headline, use
9950 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
9953 You can also include a portion of a file by specifying a lines range using
9954 the @code{:lines} parameter. The line at the upper end of the range will not
9955 be included. The start and/or the end of the range may be omitted to use the
9959 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9960 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9961 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9967 Visit the include file at point.
9970 @node Index entries, Macro replacement, Include files, Markup
9971 @section Index entries
9972 @cindex index entries, for publishing
9974 You can specify entries that will be used for generating an index during
9975 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9976 the contains an exclamation mark will create a sub item. See @ref{Generating
9977 an index} for more information.
9982 #+INDEX: Application!CV
9988 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9989 @section Macro replacement
9990 @cindex macro replacement, during export
9993 You can define text snippets with
9996 #+MACRO: name replacement text $1, $2 are arguments
9999 @noindent which can be referenced in
10000 paragraphs, verse blocks, table cells and some keywords with
10001 @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments,
10002 commas within arguments have to be escaped with a backslash character.
10003 Conversely, backslash characters before a comma, and only them, need to be
10004 escaped with another backslash character.}. In addition to defined macros,
10005 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference
10006 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
10007 Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
10008 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
10009 and to the modification time of the file being exported, respectively.
10010 @var{FORMAT} should be a format string understood by
10011 @code{format-time-string}.
10013 Macro expansion takes place during export.
10016 @node Embedded @LaTeX{}, Special blocks, Macro replacement, Markup
10017 @section Embedded @LaTeX{}
10018 @cindex @TeX{} interpretation
10019 @cindex @LaTeX{} interpretation
10021 Plain ASCII is normally sufficient for almost all note taking. Exceptions
10022 include scientific notes, which often require mathematical symbols and the
10023 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10024 Donald E. Knuth's @TeX{} system. Many of the features described here as
10025 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10026 distinction.} is widely used to typeset scientific documents. Org mode
10027 supports embedding @LaTeX{} code into its files, because many academics are
10028 used to writing and reading @LaTeX{} source code, and because it can be
10029 readily processed to produce pretty output for a number of export back-ends.
10032 * Special symbols:: Greek letters and other symbols
10033 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10034 * @LaTeX{} fragments:: Complex formulas made easy
10035 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10036 * CDLaTeX mode:: Speed up entering of formulas
10039 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
10040 @subsection Special symbols
10041 @cindex math symbols
10042 @cindex special symbols
10043 @cindex @TeX{} macros
10044 @cindex @LaTeX{} fragments, markup rules
10045 @cindex HTML entities
10046 @cindex @LaTeX{} entities
10048 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10049 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10050 for these symbols is available, just type @samp{\} and maybe a few letters,
10051 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10052 code, Org mode allows these symbols to be present without surrounding math
10053 delimiters, for example:
10056 Angles are written as Greek letters \alpha, \beta and \gamma.
10059 @vindex org-entities
10060 During export, these symbols will be transformed into the native format of
10061 the exporter back-end. Strings like @code{\alpha} will be exported as
10062 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
10063 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10064 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10065 like this: @samp{\Aacute@{@}stor}.
10067 A large number of entities is provided, with names taken from both HTML and
10068 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10069 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10070 @samp{...} are all converted into special commands creating hyphens of
10071 different lengths or a compact set of dots.
10073 If you would like to see entities displayed as UTF-8 characters, use the
10074 following command@footnote{You can turn this on by default by setting the
10075 variable @code{org-pretty-entities}, or on a per-file base with the
10076 @code{#+STARTUP} option @code{entitiespretty}.}:
10079 @cindex @code{entitiespretty}, STARTUP keyword
10082 Toggle display of entities as UTF-8 characters. This does not change the
10083 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10084 for display purposes only.
10087 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
10088 @subsection Subscripts and superscripts
10090 @cindex superscript
10092 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10093 subscripts. Again, these can be used without embedding them in math-mode
10094 delimiters. To increase the readability of ASCII text, it is not necessary
10095 (but OK) to surround multi-character sub- and superscripts with curly braces.
10099 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10100 the sun is R_@{sun@} = 6.96 x 10^8 m.
10103 @vindex org-use-sub-superscripts
10104 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
10105 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
10106 where the underscore is often used in a different context, Org's convention
10107 to always interpret these as subscripts can get in your way. Configure the
10108 variable @code{org-use-sub-superscripts} to change this convention. For
10109 example, when setting this variable to @code{@{@}}, @samp{a_b} will not be
10110 interpreted as a subscript, but @samp{a_@{b@}} will.
10115 In addition to showing entities as UTF-8 characters, this command will also
10116 format sub- and superscripts in a WYSIWYM way.
10119 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
10120 @subsection @LaTeX{} fragments
10121 @cindex @LaTeX{} fragments
10123 @vindex org-format-latex-header
10124 Going beyond symbols and sub- and superscripts, a full formula language is
10125 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10126 to process these for several export back-ends. When exporting to @LaTeX{},
10127 the code is obviously left as it is. When exporting to HTML, Org invokes the
10128 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10129 HTML export}) to process and display the math@footnote{If you plan to use
10130 this regularly or on pages with significant page views, you should install
10131 @file{MathJax} on your own server in order to limit the load of our server.}.
10132 Finally, it can also process the mathematical expressions into
10133 images@footnote{For this to work you need to be on a system with a working
10134 @LaTeX{} installation. You also need the @file{dvipng} program or the
10135 @file{convert}, respectively available at
10136 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10137 suite. The @LaTeX{} header that will be used when processing a fragment can
10138 be configured with the variable @code{org-format-latex-header}.} that can be
10139 displayed in a browser.
10141 @LaTeX{} fragments don't need any special marking at all. The following
10142 snippets will be identified as @LaTeX{} source code:
10145 Environments of any kind@footnote{When @file{MathJax} is used, only the
10146 environments recognized by @file{MathJax} will be processed. When
10147 @file{dvipng} is used to create images, any @LaTeX{} environment will be
10148 handled.}. The only requirement is that the @code{\begin} and @code{\end}
10149 statements appear on a new line, at the beginning of the line or after
10152 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10153 currency specifications, single @samp{$} characters are only recognized as
10154 math delimiters if the enclosed text contains at most two line breaks, is
10155 directly attached to the @samp{$} characters with no whitespace in between,
10156 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10157 For the other delimiters, there is no such restriction, so when in doubt, use
10158 @samp{\(...\)} as inline math delimiters.
10161 @noindent For example:
10168 If $a^2=b$ and \( b=2 \), then the solution must be
10169 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10174 @c @vindex org-format-latex-options
10175 @c If you need any of the delimiter ASCII sequences for other purposes, you
10176 @c can configure the option @code{org-format-latex-options} to deselect the
10177 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10179 @vindex org-export-with-latex
10180 @LaTeX{} processing can be configured with the variable
10181 @code{org-export-with-latex}. The default setting is @code{t} which means
10182 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10183 You can also set this variable on a per-file basis using one of these
10187 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10188 #+OPTIONS: tex:dvipng @r{Force using dvipng images}
10189 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10190 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10193 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
10194 @subsection Previewing @LaTeX{} fragments
10195 @cindex @LaTeX{} fragments, preview
10197 @vindex org-latex-create-formula-image-program
10198 If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the
10199 converter by setting the variable
10200 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10201 fragments can be processed to produce preview images of the typeset
10205 @kindex C-c C-x C-l
10207 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10208 over the source code. If there is no fragment at point, process all
10209 fragments in the current entry (between two headlines). When called
10210 with a prefix argument, process the entire subtree. When called with
10211 two prefix arguments, or when the cursor is before the first headline,
10212 process the entire buffer.
10215 Remove the overlay preview images.
10218 @vindex org-format-latex-options
10219 You can customize the variable @code{org-format-latex-options} to influence
10220 some aspects of the preview. In particular, the @code{:scale} (and for HTML
10221 export, @code{:html-scale}) property can be used to adjust the size of the
10224 @vindex org-startup-with-latex-preview
10225 You can turn on the previewing of all @LaTeX{} fragments in a file with
10228 #+STARTUP: latexpreview
10231 To disable it, simply use
10234 #+STARTUP: nolatexpreview
10237 @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
10238 @subsection Using CD@LaTeX{} to enter math
10241 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10242 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10243 environments and math templates. Inside Org mode, you can make use of
10244 some of the features of CD@LaTeX{} mode. You need to install
10245 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10246 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10247 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10248 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10249 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10253 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10256 When this mode is enabled, the following features are present (for more
10257 details see the documentation of CD@LaTeX{} mode):
10261 Environment templates can be inserted with @kbd{C-c @{}.
10264 The @key{TAB} key will do template expansion if the cursor is inside a
10265 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10266 inside such a fragment, see the documentation of the function
10267 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10268 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10269 correctly inside the first brace. Another @key{TAB} will get you into
10270 the second brace. Even outside fragments, @key{TAB} will expand
10271 environment abbreviations at the beginning of a line. For example, if
10272 you write @samp{equ} at the beginning of a line and press @key{TAB},
10273 this abbreviation will be expanded to an @code{equation} environment.
10274 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10278 @vindex cdlatex-simplify-sub-super-scripts
10279 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10280 characters together with a pair of braces. If you use @key{TAB} to move
10281 out of the braces, and if the braces surround only a single character or
10282 macro, they are removed again (depending on the variable
10283 @code{cdlatex-simplify-sub-super-scripts}).
10286 Pressing the backquote @kbd{`} followed by a character inserts math
10287 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10288 after the backquote, a help window will pop up.
10291 Pressing the single-quote @kbd{'} followed by another character modifies
10292 the symbol before point with an accent or a font. If you wait more than
10293 1.5 seconds after the single-quote, a help window will pop up. Character
10294 modification will work only inside @LaTeX{} fragments; outside the quote
10298 @node Special blocks, , Embedded @LaTeX{}, Markup
10299 @section Special blocks
10300 @cindex Special blocks
10302 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10303 examples}). It is also possible to create blocks containing raw code
10304 targeted at a specific back-ends (e.g., @samp{#+BEGIN_LATEX}).
10306 Any other block is a @emph{special block}. Each export back-end decides if
10307 they should be exported, and how. When the block is ignored, its contents
10308 are still exported, as if the block were not there. For example, when
10309 exporting a @samp{#+BEGIN_TEST} block, HTML back-end wraps its contents
10310 within @samp{<div name="test">} tag. Refer to back-end specific
10311 documentation for more information.
10313 @node Exporting, Publishing, Markup, Top
10317 The Org mode export facilities can be used to export Org documents or parts
10318 of Org documents to a variety of other formats. In addition, these
10319 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10320 in foreign buffers so you can author tables and lists in Org syntax and
10321 convert them in place to the target language.
10323 ASCII export produces a readable and simple version of an Org file for
10324 printing and sharing notes. HTML export allows you to easily publish notes
10325 on the web, or to build full-fledged websites. @LaTeX{} export lets you use
10326 Org mode and its structured editing functions to create arbitrarily complex
10327 @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export
10328 allows seamless collaboration across organizational boundaries. Markdown
10329 export lets you seamlessly collaborate with other developers. Finally, iCal
10330 export can extract entries with deadlines or appointments to produce a file
10331 in the iCalendar format.
10334 * The Export Dispatcher:: The main exporter interface
10335 * Export back-ends:: Built-in export formats
10336 * Export settings:: Generic export settings
10337 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10338 * Beamer export:: Exporting as a Beamer presentation
10339 * HTML export:: Exporting to HTML
10340 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
10341 * Markdown export:: Exporting to Markdown
10342 * OpenDocument Text export:: Exporting to OpenDocument Text
10343 * iCalendar export:: Exporting to iCalendar
10344 * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org
10345 * Export in foreign buffers:: Author tables in lists in Org syntax
10346 * Advanced configuration:: Fine-tuning the export output
10349 @node The Export Dispatcher, Export back-ends, Exporting, Exporting
10350 @section The Export Dispatcher
10351 @vindex org-export-dispatch-use-expert-ui
10352 @cindex Export, dispatcher
10354 The main entry point for export related tasks is the dispatcher, a
10355 hierarchical menu from which it is possible to select an export format and
10356 toggle export options@footnote{It is also possible to use a less intrusive
10357 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10358 non-@code{nil} value. In that case, only a prompt is visible from the
10359 minibuffer. From there one can still switch back to regular menu by pressing
10360 @key{?}.} from which it is possible to select an export format and to toggle
10365 @orgcmd{C-c C-e,org-export-dispatch}
10367 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10368 prefix argument, repeat the last export command on the current buffer while
10369 preserving toggled options. If the current buffer hasn't changed and subtree
10370 export was activated, the command will affect that same subtree.
10374 Normally the entire buffer is exported, but if there is an active region
10375 only that part of the buffer will be exported.
10377 Several export options (@pxref{Export settings}) can be toggled from the
10378 export dispatcher with the following key combinations:
10382 @vindex org-export-async-init-file
10383 Toggle asynchronous export. Asynchronous export uses an external Emacs
10384 process that is configured with a specified initialization file.
10386 While exporting asynchronously, the output is not displayed. It is stored in
10387 a list called ``the export stack'', and can be viewed from there. The stack
10388 can be reached by calling the dispatcher with a double @kbd{C-u} prefix
10389 argument, or with @kbd{&} key from the dispatcher.
10391 @vindex org-export-in-background
10392 To make this behaviour the default, customize the variable
10393 @code{org-export-in-background}.
10396 Toggle body-only export. Its effect depends on the back-end used.
10397 Typically, if the back-end has a header section (like @code{<head>...</head>}
10398 in the HTML back-end), a body-only export will not include this header.
10401 @vindex org-export-initial-scope
10402 Toggle subtree export. The top heading becomes the document title.
10404 You can change the default state of this option by setting
10405 @code{org-export-initial-scope}.
10408 Toggle visible-only export. Only export the text that is currently
10409 visible, i.e. not hidden by outline visibility in the buffer.
10413 @vindex org-export-copy-to-kill-ring
10414 With the exception of asynchronous export, a successful export process writes
10415 its output to the kill-ring. You can configure this behavior by altering the
10416 option @code{org-export-copy-to-kill-ring}.
10418 @node Export back-ends, Export settings, The Export Dispatcher, Exporting
10419 @section Export back-ends
10420 @cindex Export, back-ends
10422 An export back-end is a library that translates Org syntax into a foreign
10423 format. An export format is not available until the proper back-end has been
10426 @vindex org-export-backends
10427 By default, the following four back-ends are loaded: @code{ascii},
10428 @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
10429 (or remove some) by customizing @code{org-export-backends}.
10431 Built-in back-ends include:
10434 @item ascii (ASCII format)
10435 @item beamer (@LaTeX{} Beamer format)
10436 @item html (HTML format)
10437 @item icalendar (iCalendar format)
10438 @item latex (@LaTeX{} format)
10439 @item man (Man page format)
10440 @item md (Markdown format)
10441 @item odt (OpenDocument Text format)
10442 @item texinfo (Texinfo format)
10445 Other back-ends might be found in the @code{contrib/} directory
10446 (@pxref{Installation}).
10448 @node Export settings, ASCII/Latin-1/UTF-8 export, Export back-ends, Exporting
10449 @section Export settings
10450 @cindex Export, settings
10452 Export options can be set: globally with variables; for an individual file by
10453 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10454 settings}), by setting individual keywords, or by specifying them in a
10455 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10456 properties (@pxref{Properties and Columns}). Options set at a specific level
10457 override options set at a more general level.
10459 @cindex #+SETUPFILE
10460 In-buffer settings may appear anywhere in the file, either directly or
10461 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10462 Option keyword sets tailored to a particular back-end can be inserted from
10463 the export dispatcher (@pxref{The Export Dispatcher}) using the @code{Insert
10464 template} command by pressing @key{#}. To insert keywords individually,
10465 a good way to make sure the keyword is correct is to type @code{#+} and then
10466 to use @kbd{M-<TAB>} for completion.
10468 The export keywords available for every back-end, and their equivalent global
10469 variables, include:
10473 @vindex user-full-name
10474 The document author (@code{user-full-name}).
10477 @vindex org-export-creator-string
10478 Entity responsible for output generation (@code{org-export-creator-string}).
10481 @vindex org-export-date-timestamp-format
10482 A date or a time-stamp@footnote{The variable
10483 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10487 The document description. Back-ends handle it as they see fit (e.g., for the
10488 XHTML meta tag), if at all. You can use several such keywords for long
10492 @vindex user-mail-address
10493 The email address (@code{user-mail-address}).
10496 The keywords defining the contents of the document. Back-ends handle it as
10497 they see fit (e.g., for the XHTML meta tag), if at all. You can use several
10498 such keywords if the list is long.
10501 @vindex org-export-default-language
10502 The language used for translating some strings
10503 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10504 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10508 @vindex org-export-select-tags
10509 The tags that select a tree for export (@code{org-export-select-tags}). The
10510 default value is @code{:export:}. Within a subtree tagged with
10511 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10515 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10516 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10517 tag will be unconditionally excluded from the export, even if they have an
10518 @code{:export:} tag.
10521 The title to be shown (otherwise derived from buffer's name). You can use
10522 several such keywords for long titles.
10525 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10526 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10527 recognizes the following arguments:
10531 @vindex org-export-with-smart-quotes
10532 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10535 Toggle emphasized text (@code{org-export-with-emphasize}).
10538 @vindex org-export-with-special-strings
10539 Toggle conversion of special strings
10540 (@code{org-export-with-special-strings}).
10543 @vindex org-export-with-fixed-width
10544 Toggle fixed-width sections
10545 (@code{org-export-with-fixed-width}).
10548 @vindex org-export-with-timestamps
10549 Toggle inclusion of any time/date active/inactive stamps
10550 (@code{org-export-with-timestamps}).
10553 @vindex org-export-preserve-breaks
10554 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10557 @vindex org-export-with-sub-superscripts
10558 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10559 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10560 it is (@code{org-export-with-sub-superscripts}).
10563 @vindex org-export-with-archived-trees
10564 Configure export of archived trees. Can be set to @code{headline} to only
10565 process the headline, skipping its contents
10566 (@code{org-export-with-archived-trees}).
10569 @vindex org-export-with-author
10570 Toggle inclusion of author name into exported file
10571 (@code{org-export-with-author}).
10574 @vindex org-export-with-clocks
10575 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10578 @vindex org-export-with-creator
10579 Configure inclusion of creator info into exported file. It may be set to
10580 @code{comment} (@code{org-export-with-creator}).
10583 @vindex org-export-with-drawers
10584 Toggle inclusion of drawers, or list drawers to include
10585 (@code{org-export-with-drawers}).
10588 @vindex org-export-with-entities
10589 Toggle inclusion of entities (@code{org-export-with-entities}).
10592 @vindex org-export-with-email
10593 Toggle inclusion of the author's e-mail into exported file
10594 (@code{org-export-with-email}).
10597 @vindex org-export-with-footnotes
10598 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10601 @vindex org-export-headline-levels
10602 Set the number of headline levels for export
10603 (@code{org-export-headline-levels}). Below that level, headlines are treated
10604 differently. In most back-ends, they become list items.
10607 @vindex org-export-with-inlinetasks
10608 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10611 @vindex org-export-with-section-numbers
10612 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10613 be set to a number @samp{n}, so only headlines at that level or above will be
10617 @vindex org-export-with-planning
10618 Toggle export of planning information (@code{org-export-with-planning}).
10619 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10620 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10623 @vindex org-export-with-priority
10624 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10627 @vindex org-export-with-statistics-cookies
10628 Toggle inclusion of statistics cookies
10629 (@code{org-export-with-statistics-cookies}).
10632 @vindex org-export-with-tags
10633 Toggle inclusion of tags, may also be @code{not-in-toc}
10634 (@code{org-export-with-tags}).
10637 @vindex org-export-with-tasks
10638 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10639 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10640 (@code{org-export-with-tasks}).
10643 @vindex org-export-with-latex
10644 Configure export of @LaTeX{} fragments and environments. It may be set to
10645 @code{verbatim} (@code{org-export-with-latex}).
10648 @vindex org-export-time-stamp-file
10649 Toggle inclusion of the creation time into exported file
10650 (@code{org-export-time-stamp-file}).
10653 @vindex org-export-with-toc
10654 Toggle inclusion of the table of contents, or set the level limit
10655 (@code{org-export-with-toc}).
10658 @vindex org-export-with-todo-keywords
10659 Toggle inclusion of TODO keywords into exported text
10660 (@code{org-export-with-todo-keywords}).
10663 @vindex org-export-with-tables
10664 Toggle inclusion of tables (@code{org-export-with-tables}).
10667 @cindex property, EXPORT_FILE_NAME
10668 When exporting only a subtree, each of the previous keywords@footnote{With
10669 the exception of @samp{SETUPFILE}.} can be overriden locally by special node
10670 properties. These begin with @samp{EXPORT_}, followed by the name of the
10671 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10672 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10673 properties. Subtree export also supports the self-explicit
10674 @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide equivalent
10675 for this property. The file name in this case is derived from the file
10676 associated to the buffer, if possible, or asked to the user otherwise.}.
10679 @vindex org-export-allow-bind-keywords
10680 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10681 can become buffer-local during export by using the BIND keyword. Its syntax
10682 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10683 settings that cannot be changed using specific keywords.
10685 @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting
10686 @section ASCII/Latin-1/UTF-8 export
10687 @cindex ASCII export
10688 @cindex Latin-1 export
10689 @cindex UTF-8 export
10691 ASCII export produces a simple and very readable version of an Org mode
10692 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10693 with special characters and symbols available in these encodings.
10695 @vindex org-ascii-links-to-notes
10696 Links are exported in a footnote-like style, with the descriptive part in the
10697 text and the link in a note before the next heading. See the variable
10698 @code{org-ascii-links-to-notes} for details and other options.
10700 @subheading ASCII export commands
10703 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10704 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10705 will be @file{myfile.txt}. The file will be overwritten without warning.
10706 When the original file is @file{myfile.txt}, the resulting file becomes
10707 @file{myfile.txt.txt} in order to prevent data loss.
10708 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10709 Export to a temporary buffer. Do not create a file.
10712 @subheading Header and sectioning structure
10714 In the exported version, the first three outline levels become headlines,
10715 defining a general document structure. Additional levels are exported as
10716 lists. The transition can also occur at a different level (@pxref{Export
10719 @subheading Quoting ASCII text
10721 You can insert text that will only appear when using @code{ASCII} back-end
10722 with the following constructs:
10725 @cindex #+BEGIN_ASCII
10727 Text @@@@ascii:and additional text@@@@ within a paragraph.
10732 All lines in this block will appear only when using this back-end.
10736 @subheading ASCII specific attributes
10737 @cindex #+ATTR_ASCII
10738 @cindex horizontal rules, in ASCII export
10740 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10741 specifies the length, in characters, of a given horizontal rule. It must be
10742 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10745 #+ATTR_ASCII: :width 10
10749 @node Beamer export, HTML export, ASCII/Latin-1/UTF-8 export, Exporting
10750 @section Beamer export
10751 @cindex Beamer export
10753 The @LaTeX{} class @emph{Beamer} allows production of high quality
10754 presentations using @LaTeX{} and pdf processing. Org mode has special
10755 support for turning an Org mode file or tree into a Beamer presentation.
10757 @subheading Beamer export commands
10760 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10761 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
10762 file will be @file{myfile.tex}. The file will be overwritten without
10764 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10765 Export to a temporary buffer. Do not create a file.
10766 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10767 Export as @LaTeX{} and then process to PDF.
10769 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10772 @subheading Sectioning, Frames and Blocks
10774 Any tree with not-too-deep level nesting should in principle be exportable as
10775 a Beamer presentation. Headlines fall into three categories: sectioning
10776 elements, frames and blocks.
10780 @vindex org-beamer-frame-level
10781 Headlines become frames when their level is equal to
10782 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10783 (@pxref{Export settings}).
10785 @cindex property, BEAMER_ENV
10786 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10787 set to either to @code{frame} or @code{fullframe}, its level overrides the
10788 variable. A @code{fullframe} is a frame with an empty (ignored) title.
10791 @vindex org-beamer-environments-default
10792 @vindex org-beamer-environments-extra
10793 All frame's children become @code{block} environments. Special block types
10794 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10795 this property is set, the entry will also get a @code{:B_environment:} tag to
10796 make this visible. This tag has no semantic meaning, it is only a visual
10797 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10798 supported values and @code{org-beamer-environments-extra} for adding more).
10801 @cindex property, BEAMER_REF
10802 As a special case, if the @code{BEAMER_ENV} property is set to either
10803 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10804 headline will become, respectively, an appendix, a note (within frame or
10805 between frame, depending on its level), a note with its title ignored or an
10806 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
10807 is mandatory in order to refer to the frame being resumed, and contents are
10810 Also, a headline with an @code{ignoreheading} environment will have its
10811 contents only inserted in the output. This special value is useful to have
10812 data between frames, or to properly close a @code{column} environment.
10815 @cindex property, BEAMER_ACT
10816 @cindex property, BEAMER_OPT
10817 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
10818 The former is translated as an overlay/action specification, or a default
10819 overlay specification when enclosed within square brackets. The latter
10820 specifies options for the current frame. Though, @code{fragile} option is
10821 added automatically if it contains source code that uses any verbatim
10824 @cindex property, BEAMER_COL
10825 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
10826 be a decimal number representing the width of the column as a fraction of the
10827 total text width. If the headline has no specific environment, its title
10828 will be ignored and its contents will fill the column created. Otherwise,
10829 the block will fill the whole column and the title will be preserved. Two
10830 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
10831 @code{columns} @LaTeX{} environment. It will end before the next headline
10832 without such a property. This environment is generated automatically.
10833 Although, it can also be explicitly created, with a special @code{columns}
10834 value for @code{BEAMER_ENV} property (if it needs to be set up with some
10835 specific options, for example).
10837 @subheading Beamer specific syntax
10839 Beamer back-end is an extension of @LaTeX{} back-end. As such, all @LaTeX{}
10840 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
10841 recognized. See @ref{@LaTeX{} and PDF export} for more information.
10843 @cindex #+BEAMER_THEME
10844 @cindex #+BEAMER_COLOR_THEME
10845 @cindex #+BEAMER_FONT_THEME
10846 @cindex #+BEAMER_INNER_THEME
10847 @cindex #+BEAMER_OUTER_THEME
10848 Beamer export introduces a number of keywords to insert code in the
10849 document's header. Four control appearance of the presentantion:
10850 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
10851 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
10852 @code{#+BEAMER_OUTER_THEME}. All of them accept optional arguments
10853 within square brackets. The last one, @code{#+BEAMER_HEADER}, is more
10854 generic and allows you to append any line of code in the header.
10857 #+BEAMER_THEME: Rochester [height=20pt]
10858 #+BEAMER_COLOR_THEME: spruce
10861 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
10862 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
10863 keyword (@pxref{Table of contents}) are not. In that case, it is also
10864 possible to specify options, enclosed within square brackets.
10867 #+TOC: headlines [currentsection]
10870 Beamer specific code can be inserted with the following constructs:
10873 @cindex #+BEGIN_BEAMER
10878 All lines in this block will appear only when using this back-end.
10881 Text @@@@beamer:some code@@@@ within a paragraph.
10884 In particular, this last example can be used to add overlay specifications to
10885 objects whose type is among @code{bold}, @code{item}, @code{link},
10886 @code{radio-target} and @code{target}, when the value is enclosed within
10887 angular brackets and put at the beginning the object.
10890 A *@@@@beamer:<2->@@@@useful* feature
10893 @cindex #+ATTR_BEAMER
10894 Eventually, every plain list has support for @code{:environment},
10895 @code{:overlay} and @code{:options} attributes through
10896 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
10897 of a different environment, the second sets overlay specifications and
10898 the last one inserts optional arguments in current list environment.
10901 #+ATTR_BEAMER: :overlay +-
10906 @subheading Editing support
10908 You can turn on a special minor mode @code{org-beamer-mode} for faster
10916 @orgcmd{C-c C-b,org-beamer-select-environment}
10917 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
10918 environment or the @code{BEAMER_COL} property.
10921 Also, a template for useful in-buffer settings or properties can be inserted
10922 into the buffer with @kbd{M-x org-beamer-insert-options-template}. Among
10923 other things, this will install a column view format which is very handy for
10924 editing special properties used by Beamer.
10926 @subheading An example
10928 Here is a simple example Org document that is intended for Beamer export.
10931 #+TITLE: Example Presentation
10932 #+AUTHOR: Carsten Dominik
10934 #+LATEX_CLASS: beamer
10935 #+LATEX_CLASS_OPTIONS: [presentation]
10936 #+BEAMER_THEME: Madrid
10937 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
10939 * This is the first structural section
10942 *** Thanks to Eric Fraga :B_block:BMCOL:
10947 for the first viable Beamer setup in Org
10948 *** Thanks to everyone else :B_block:BMCOL:
10954 for contributing to the discussion
10955 **** This will be formatted as a beamer note :B_note:
10959 ** Frame 2 (where we will not use columns)
10961 Please test this stuff!
10964 @node HTML export, @LaTeX{} and PDF export, Beamer export, Exporting
10965 @section HTML export
10966 @cindex HTML export
10968 Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
10969 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10970 language, but with additional support for tables.
10973 * HTML Export commands:: How to invoke HTML export
10974 * HTML doctypes:: Org can export to various (X)HTML flavors
10975 * HTML preamble and postamble:: How to insert a preamble and a postamble
10976 * Quoting HTML tags:: Using direct HTML in Org mode
10977 * Links in HTML export:: How links will be interpreted and formatted
10978 * Tables in HTML export:: How to modify the formatting of tables
10979 * Images in HTML export:: How to insert figures into HTML output
10980 * Math formatting in HTML export:: Beautiful math also on the web
10981 * Text areas in HTML export:: An alternative way to show an example
10982 * CSS support:: Changing the appearance of the output
10983 * JavaScript support:: Info and Folding in a web browser
10986 @node HTML Export commands, HTML doctypes, HTML export, HTML export
10987 @subsection HTML export commands
10990 @orgcmd{C-c C-e h h,org-html-export-to-html}
10991 Export as a HTML file. For an Org file @file{myfile.org},
10992 the HTML file will be @file{myfile.html}. The file will be overwritten
10995 Export as a HTML file and immediately open it with a browser.
10996 @orgcmd{C-c C-e h H,org-html-export-as-html}
10997 Export to a temporary buffer. Do not create a file.
11000 @c FIXME Exporting sublevels
11001 @c @cindex headline levels, for exporting
11002 @c In the exported version, the first 3 outline levels will become headlines,
11003 @c defining a general document structure. Additional levels will be exported as
11004 @c itemized lists. If you want that transition to occur at a different level,
11005 @c specify it with a numeric prefix argument. For example,
11008 @c @kbd{C-2 C-c C-e b}
11012 @c creates two levels of headings and does the rest as items.
11014 @node HTML doctypes, HTML preamble and postamble, HTML Export commands, HTML export
11015 @subsection HTML doctypes
11016 @vindex org-html-doctype
11017 @vindex org-html-doctype-alist
11019 Org can export to various (X)HTML flavors.
11021 Setting the variable @code{org-html-doctype} allows you to export to different
11022 (X)HTML variants. The exported HTML will be adjusted according to the sytax
11023 requirements of that variant. You can either set this variable to a doctype
11024 string directly, in which case the exporter will try to adjust the syntax
11025 automatically, or you can use a ready-made doctype. The ready-made options
11032 ``html4-transitional''
11038 ``xhtml-transitional''
11049 See the variable @code{org-html-doctype-alist} for details. The default is
11052 @subsubheading Fancy HTML5 export
11053 @vindex org-html-html5-fancy
11054 @vindex org-html-html5-elements
11056 HTML5 introduces several new element types. By default, Org will not make
11057 use of these element types, but you can set @code{org-html-html5-fancy} to
11058 @code{t} (or use the corresponding @code{HTML_HTML5_FANCY} export option), to
11059 enable a few new block-level elements. These are created using arbitrary
11060 #+BEGIN and #+END blocks. For instance:
11079 #+ATTR_HTML: :controls controls :width 350
11081 #+HTML: <source src="movie.mp4" type="video/mp4">
11082 #+HTML: <source src="movie.ogg" type="video/ogg">
11083 Your browser does not support the video tag.
11090 <video controls="controls" width="350">
11091 <source src="movie.mp4" type="video/mp4">
11092 <source src="movie.ogg" type="video/ogg">
11093 <p>Your browser does not support the video tag.</p>
11097 Special blocks that do not correspond to HTML5 elements (see
11098 @code{org-html-html5-elements}) will revert to the usual behavior,
11099 i.e. #+BEGIN_LEDERHOSEN will still export to <div class=''lederhosen''>.
11101 Headlines cannot appear within special blocks. To wrap a headline and its
11102 contents in e.g. <section> or <article> tags, set the @code{HTML_CONTAINER}
11103 property on the headline itself.
11105 @node HTML preamble and postamble, Quoting HTML tags, HTML doctypes, HTML export
11106 @subsection HTML preamble and postamble
11107 @vindex org-html-preamble
11108 @vindex org-html-postamble
11109 @vindex org-html-preamble-format
11110 @vindex org-html-postamble-format
11111 @vindex org-html-validation-link
11112 @vindex org-export-creator-string
11113 @vindex org-export-time-stamp-file
11115 The HTML exporter lets you define a preamble and a postamble.
11117 The default value for @code{org-html-preamble} is @code{t}, which means
11118 that the preamble is inserted depending on the relevant format string in
11119 @code{org-html-preamble-format}.
11121 Setting @code{org-html-preamble} to a string will override the default format
11122 string. If you set it to a function, it will insert the output of the
11123 function, which must be a string. Setting to @code{nil} will not insert any
11126 The default value for @code{org-html-postamble} is @code{'auto}, which means
11127 that the HTML exporter will look for information about the author, the email,
11128 the creator and the date, and build the postamble from these values. Setting
11129 @code{org-html-postamble} to @code{t} will insert the postamble from the
11130 relevant format string found in @code{org-html-postamble-format}. Setting it
11131 to @code{nil} will not insert any postamble.
11133 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
11134 @subsection Quoting HTML tags
11136 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11137 @samp{>} in HTML export. If you want to include raw HTML code, which
11138 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11139 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11140 that should be copied verbatim to the exported file use either
11143 @cindex #+BEGIN_HTML
11145 #+HTML: Literal HTML code for export
11149 @cindex #+BEGIN_HTML
11153 All lines between these markers are exported literally
11158 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
11159 @subsection Links in HTML export
11161 @cindex links, in HTML export
11162 @cindex internal links, in HTML export
11163 @cindex external links, in HTML export
11164 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11165 includes automatic links created by radio targets (@pxref{Radio
11166 targets}). Links to external files will still work if the target file is on
11167 the same @i{relative} path as the published Org file. Links to other
11168 @file{.org} files will be translated into HTML links under the assumption
11169 that a HTML version also exists of the linked file, at the same relative
11170 path. @samp{id:} links can then be used to jump to specific entries across
11171 files. For information related to linking files while publishing them to a
11172 publishing directory see @ref{Publishing links}.
11174 If you want to specify attributes for links, you can do so using a special
11175 @code{#+ATTR_HTML} line to define attributes that will be added to the
11176 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11177 and @code{style} attributes for a link:
11179 @cindex #+ATTR_HTML
11181 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11182 [[http://orgmode.org]]
11185 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
11187 @cindex tables, in HTML
11188 @vindex org-html-table-default-attributes
11190 Org mode tables are exported to HTML using the table attributes defined in
11191 @code{org-html-table-default-attributes}. The default setting makes tables
11192 without cell borders and frame. If you would like to change this for
11193 individual tables, place something like the following before the table:
11196 @cindex #+ATTR_HTML
11198 #+CAPTION: This is a table with lines around and between cells
11199 #+ATTR_HTML: :border 2 :rules all :frame border
11202 @vindex org-html-table-row-tags
11203 You can also modify the default tags used for each row by setting
11204 @code{org-html-table-row-tags}. See the docstring for an example on
11205 how to use this option.
11207 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
11208 @subsection Images in HTML export
11210 @cindex images, inline in HTML
11211 @cindex inlining images in HTML
11212 @vindex org-html-inline-images
11213 HTML export can inline images given as links in the Org file, and
11214 it can make an image the clickable part of a link. By
11215 default@footnote{But see the variable
11216 @code{org-html-inline-images}.}, images are inlined if a link does
11217 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11218 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11219 @samp{the image} that points to the image. If the description part
11220 itself is a @code{file:} link or a @code{http:} URL pointing to an
11221 image, this image will be inlined and activated so that clicking on the
11222 image will activate the link. For example, to include a thumbnail that
11223 will link to a high resolution version of the image, you could use:
11226 [[file:highres.jpg][file:thumb.jpg]]
11229 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11230 In the example below we specify the @code{alt} and @code{title} attributes to
11231 support text viewers and accessibility, and align it to the right.
11234 @cindex #+ATTR_HTML
11236 #+CAPTION: A black cat stalking a spider
11237 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11242 You could use @code{http} addresses just as well.
11244 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
11245 @subsection Math formatting in HTML export
11249 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11250 different ways on HTML pages. The default is to use the
11251 @uref{http://www.mathjax.org, MathJax system} which should work out of the
11252 box with Org mode installation because @uref{http://orgmode.org} serves
11253 @file{MathJax} for Org mode users for small applications and for testing
11254 purposes. @b{If you plan to use this regularly or on pages with significant
11255 page views, you should install@footnote{Installation instructions can be
11256 found on the MathJax website, see
11257 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
11258 your own server in order to limit the load of our server.} To configure
11259 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
11260 insert something like the following into the buffer:
11263 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
11266 @noindent See the docstring of the variable
11267 @code{org-html-mathjax-options} for the meaning of the parameters in
11270 If you prefer, you can also request that @LaTeX{} fragments are processed
11271 into small images that will be inserted into the browser page. Before the
11272 availability of MathJax, this was the default method for Org files. This
11273 method requires that the @file{dvipng} program is available on your system.
11274 You can still get this processing with
11277 #+OPTIONS: tex:dvipng
11280 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
11281 @subsection Text areas in HTML export
11283 @cindex text areas, in HTML
11284 An alternative way to publish literal code examples in HTML is to use text
11285 areas, where the example can even be edited before pasting it into an
11286 application. It is triggered by @code{:textarea} attribute at an
11287 @code{example} or @code{src} block.
11289 You may also use @code{:height} and @code{:width} attributes to specify the
11290 height and width of the text area, which default to the number of lines in
11291 the example, and 80, respectively. For example
11294 #+ATTR_HTML: :textarea t :width 40
11296 (defun org-xor (a b)
11303 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
11304 @subsection CSS support
11305 @cindex CSS, for HTML export
11306 @cindex HTML export, CSS
11308 @vindex org-html-todo-kwd-class-prefix
11309 @vindex org-html-tag-class-prefix
11310 You can also give style information for the exported file. The HTML exporter
11311 assigns the following special CSS classes@footnote{If the classes on TODO
11312 keywords and tags lead to conflicts, use the variables
11313 @code{org-html-todo-kwd-class-prefix} and
11314 @code{org-html-tag-class-prefix} to make them unique.} to appropriate
11315 parts of the document---your style specifications may change these, in
11316 addition to any of the standard classes like for headlines, tables, etc.
11318 p.author @r{author information, including email}
11319 p.date @r{publishing date}
11320 p.creator @r{creator info, about org mode version}
11321 .title @r{document title}
11322 .todo @r{TODO keywords, all not-done states}
11323 .done @r{the DONE keywords, all states that count as done}
11324 .WAITING @r{each TODO keyword also uses a class named after itself}
11325 .timestamp @r{timestamp}
11326 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11327 .timestamp-wrapper @r{span around keyword plus timestamp}
11328 .tag @r{tag in a headline}
11329 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11330 .target @r{target for links}
11331 .linenr @r{the line number in a code example}
11332 .code-highlighted @r{for highlighting referenced code lines}
11333 div.outline-N @r{div for outline level N (headline plus text))}
11334 div.outline-text-N @r{extra div for text at outline level N}
11335 .section-number-N @r{section number in headlines, different for each level}
11336 div.figure @r{how to format an inlined image}
11337 pre.src @r{formatted source code}
11338 pre.example @r{normal example}
11339 p.verse @r{verse paragraph}
11340 div.footnotes @r{footnote section headline}
11341 p.footnote @r{footnote definition paragraph, containing a footnote}
11342 .footref @r{a footnote reference number (always a <sup>)}
11343 .footnum @r{footnote number in footnote definition (always <sup>)}
11346 @vindex org-html-style-default
11347 @vindex org-html-head-include-default-style
11348 @vindex org-html-head
11349 @vindex org-html-head-extra
11350 @cindex #+HTML_INCLUDE_STYLE
11351 Each exported file contains a compact default style that defines these
11352 classes in a basic way@footnote{This style is defined in the constant
11353 @code{org-html-style-default}, which you should not modify. To turn
11354 inclusion of these defaults off, customize
11355 @code{org-html-head-include-default-style} or set @code{#+HTML_INCLUDE_STYLE}
11356 to @code{nil} on a per-file basis.}. You may overwrite these settings, or add to
11357 them by using the variables @code{org-html-head} and
11358 @code{org-html-head-extra}. You can override the global values of these
11359 variables for each file by using these keywords:
11361 @cindex #+HTML_HEAD
11362 @cindex #+HTML_HEAD_EXTRA
11364 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11365 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11369 For longer style definitions, you can use several such lines. You could also
11370 directly write a @code{<style>} @code{</style>} section in this way, without
11371 referring to an external file.
11373 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11374 property to assign a class to the tree. In order to specify CSS styles for a
11375 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11378 @c FIXME: More about header and footer styles
11379 @c FIXME: Talk about links and targets.
11381 @node JavaScript support, , CSS support, HTML export
11382 @subsection JavaScript supported display of web pages
11384 @cindex Rose, Sebastian
11385 Sebastian Rose has written a JavaScript program especially designed to
11386 enhance the web viewing experience of HTML files created with Org. This
11387 program allows you to view large files in two different ways. The first one
11388 is an @emph{Info}-like mode where each section is displayed separately and
11389 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11390 as well, press @kbd{?} for an overview of the available keys). The second
11391 view type is a @emph{folding} view much like Org provides inside Emacs. The
11392 script is available at @url{http://orgmode.org/org-info.js} and you can find
11393 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11394 We host the script at our site, but if you use it a lot, you might not want
11395 to be dependent on @url{http://orgmode.org} and prefer to install a local
11396 copy on your own web server.
11398 All it then takes to use this program is adding a single line to the Org
11401 @cindex #+INFOJS_OPT
11403 #+INFOJS_OPT: view:info toc:nil
11407 If this line is found, the HTML header will automatically contain the code
11408 needed to invoke the script. Using the line above, you can set the following
11412 path: @r{The path to the script. The default is to grab the script from}
11413 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11414 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11415 view: @r{Initial view when the website is first shown. Possible values are:}
11416 info @r{Info-like interface with one section per page.}
11417 overview @r{Folding interface, initially showing only top-level.}
11418 content @r{Folding interface, starting with all headlines visible.}
11419 showall @r{Folding interface, all headlines and text visible.}
11420 sdepth: @r{Maximum headline level that will still become an independent}
11421 @r{section for info and folding modes. The default is taken from}
11422 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11423 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11424 @r{info/folding section can still contain child headlines.}
11425 toc: @r{Should the table of contents @emph{initially} be visible?}
11426 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11427 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11428 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11429 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11430 @r{If yes, the toc will never be displayed as a section.}
11431 ltoc: @r{Should there be short contents (children) in each section?}
11432 @r{Make this @code{above} if the section should be above initial text.}
11433 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11434 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11435 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11436 @r{default), only one such button will be present.}
11439 @vindex org-html-infojs-options
11440 @vindex org-html-use-infojs
11441 You can choose default values for these options by customizing the variable
11442 @code{org-html-infojs-options}. If you always want to apply the script to your
11443 pages, configure the variable @code{org-html-use-infojs}.
11445 @node @LaTeX{} and PDF export, Markdown export, HTML export, Exporting
11446 @section @LaTeX{} and PDF export
11447 @cindex @LaTeX{} export
11450 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11451 standard or custom document class. With further processing@footnote{The
11452 default @LaTeX{} output is designed for processing with @code{pdftex} or
11453 @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
11454 possibly @code{luatex}. The @LaTeX{} exporter can be configured to support
11455 alternative TeX engines, see the options
11456 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11457 which the @LaTeX{} exporter is able to control, this back-end is able to
11458 produce PDF output. Because the @LaTeX{} exporter can be configured to use
11459 the @code{hyperref} package, the default setup produces fully-linked PDF
11462 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11463 will not be started if two contiguous syntactical elements are not separated
11466 This back-end also offers enhanced support for footnotes. Thus, it handles
11467 nested footnotes, footnotes in tables and footnotes in a list item's
11471 * @LaTeX{} export commands:: How to export to LaTeX and PDF
11472 * Header and sectioning:: Setting up the export file structure
11473 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11474 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
11477 @node @LaTeX{} export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
11478 @subsection @LaTeX{} export commands
11481 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11482 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11483 file will be @file{myfile.tex}. The file will be overwritten without
11485 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11486 Export to a temporary buffer. Do not create a file.
11487 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11488 Export as @LaTeX{} and then process to PDF.
11490 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11493 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{} export commands, @LaTeX{} and PDF export
11494 @subsection Header and sectioning structure
11495 @cindex @LaTeX{} class
11496 @cindex @LaTeX{} sectioning structure
11497 @cindex @LaTeX{} header
11498 @cindex header, for @LaTeX{} files
11499 @cindex sectioning structure, for @LaTeX{} export
11501 By default, the first three outline levels become headlines, defining a
11502 general document structure. Additional levels are exported as @code{itemize}
11503 or @code{enumerate} lists. The transition can also occur at a different
11504 level (@pxref{Export settings}).
11506 By default, the @LaTeX{} output uses the class @code{article}.
11508 @vindex org-latex-default-class
11509 @vindex org-latex-classes
11510 @vindex org-latex-default-packages-alist
11511 @vindex org-latex-packages-alist
11512 You can change this globally by setting a different value for
11513 @code{org-latex-default-class} or locally by adding an option like
11514 @code{#+LATEX_CLASS: myclass} in your file, or with
11515 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11516 containing only this (sub)tree. The class must be listed in
11517 @code{org-latex-classes}. This variable defines a header template for each
11518 class@footnote{Into which the values of
11519 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11520 are spliced.}, and allows you to define the sectioning structure for each
11521 class. You can also define your own classes there.
11523 @cindex #+LATEX_CLASS
11524 @cindex #+LATEX_CLASS_OPTIONS
11525 @cindex property, EXPORT_LATEX_CLASS
11526 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11527 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11528 property can specify the options for the @code{\documentclass} macro. These
11529 options have to be provided, as expected by @LaTeX{}, within square brackets.
11531 @cindex #+LATEX_HEADER
11532 @cindex #+LATEX_HEADER_EXTRA
11533 You can also use the @code{LATEX_HEADER} and
11534 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11535 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11536 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11537 to add lines to the header. See the docstring of @code{org-latex-classes} for
11540 An example is shown below.
11543 #+LATEX_CLASS: article
11544 #+LATEX_CLASS_OPTIONS: [a4paper]
11545 #+LATEX_HEADER: \usepackage@{xyz@}
11551 @node Quoting @LaTeX{} code, @LaTeX{} specific attributes, Header and sectioning, @LaTeX{} and PDF export
11552 @subsection Quoting @LaTeX{} code
11554 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11555 inserted into the @LaTeX{} file. Furthermore, you can add special code that
11556 should only be present in @LaTeX{} export with the following constructs:
11559 @cindex #+BEGIN_LATEX
11561 Code within @@@@latex:some code@@@@ a paragraph.
11563 #+LATEX: Literal @LaTeX{} code for export
11566 All lines between these markers are exported literally
11570 @node @LaTeX{} specific attributes, , Quoting @LaTeX{} code, @LaTeX{} and PDF export
11571 @subsection @LaTeX{} specific attributes
11572 @cindex #+ATTR_LATEX
11574 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
11575 affect tables, images, plain lists, special blocks and source blocks.
11577 @subsubheading Tables in @LaTeX{} export
11578 @cindex tables, in @LaTeX{} export
11580 For @LaTeX{} export of a table, you can specify a label and a caption
11581 (@pxref{Images and tables}). You can also use attributes to control table
11582 layout and contents. Valid @LaTeX{} attributes include:
11586 @vindex org-latex-default-table-mode
11587 Nature of table's contents. It can be set to @code{table}, @code{math},
11588 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
11589 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11590 ignored and the table will be wrapped in a math environment. Also,
11591 contiguous tables sharing the same math mode will be wrapped within the same
11592 environment. Default mode is determined in
11593 @code{org-latex-default-table-mode}.
11595 @vindex org-latex-default-table-environment
11596 Environment used for the table. It can be set to any @LaTeX{} table
11597 environment, like @code{tabularx}, @code{longtable}, @code{array},
11598 @code{tabu}, @code{bmatrix}@enddots{} It defaults to
11599 @code{org-latex-default-table-environment} value.
11602 Float environment for the table. Possible values are @code{sidewaystable},
11603 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
11604 a caption will have a @code{table} environment. Moreover, @code{:placement}
11605 attribute can specify the positioning of the float.
11609 Set, respectively, the alignment string of the table, its font size and its
11610 width. They only apply on regular tables.
11612 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11613 only takes effect when used in conjunction with the @code{:width} attribute.
11614 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11615 value of @code{:width}.
11619 @vindex org-latex-tables-booktabs
11620 @vindex org-latex-tables-centered
11621 They toggle, respectively, @code{booktabs} usage (assuming the package is
11622 properly loaded), table centering and removal of every horizontal rule but
11623 the first one (in a "table.el" table only). In particular,
11624 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11625 activates the first (respectively second) attribute globally.
11627 @itemx :math-suffix
11628 @itemx :math-arguments
11629 A string that will be inserted, respectively, before the table within the
11630 math environment, after the table within the math environment, and between
11631 the macro name and the contents of the table. The @code{:math-arguments}
11632 attribute is used for matrix macros that require more than one argument
11633 (e.g., @code{qbordermatrix}).
11636 Thus, attributes can be used in a wide array of situations, like writing
11637 a table that will span over multiple pages, or a matrix product:
11640 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11644 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11647 #+ATTR_LATEX: :mode math :environment bmatrix
11652 @subsubheading Images in @LaTeX{} export
11653 @cindex images, inline in @LaTeX{}
11654 @cindex inlining images in @LaTeX{}
11656 Images that are linked to without a description part in the link, like
11657 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11658 output file resulting from @LaTeX{} processing. Org will use an
11659 @code{\includegraphics} macro to insert the image@footnote{In the case of
11660 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11661 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11663 You can specify specify image width or height with, respectively,
11664 @code{:width} and @code{:height} attributes. It is also possible to add any
11665 other option with the @code{:options} attribute, as shown in the following
11669 #+ATTR_LATEX: :width 5cm :options angle=90
11670 [[./img/sed-hr4049.pdf]]
11673 If you have specified a caption as described in @ref{Images and tables}, the
11674 picture will be wrapped into a @code{figure} environment and thus become
11675 a floating element. You can also ask Org to export an image as a float
11676 without specifying caption by setting the @code{:float} attribute. You may
11680 @code{t}: if you want to use the standard @samp{figure} environment. It is
11681 used by default if you provide a caption to the image.
11683 @code{multicolumn}: if you wish to include an image which spans multiple
11684 columns in a page. This will export the image wrapped in a @code{figure*}
11687 @code{wrap}: if you would like to let text flow around the image. It will
11688 make the figure occupy the left half of the page.
11690 @code{nil}: if you need to avoid any floating environment, even when
11691 a caption is provided.
11694 To modify the placement option of any floating environment, set the
11695 @code{placement} attribute.
11698 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11702 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11703 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11705 @subsubheading Plain lists in @LaTeX{} export
11706 @cindex plain lists, in @LaTeX{} export
11708 Plain lists accept two optional attributes: @code{:environment} and
11709 @code{:options}. The first one allows the use of a non-standard
11710 environment (e.g., @samp{inparaenum}). The second one specifies
11711 optional arguments for that environment (square brackets may be
11715 #+ATTR_LATEX: :environment compactitem :options $\circ$
11716 - you need ``paralist'' package to reproduce this example.
11719 @subsubheading Source blocks in @LaTeX{} export
11720 @cindex source blocks, in @LaTeX{} export
11722 In addition to syntax defined in @ref{Literal examples}, names and captions
11723 (@pxref{Images and tables}), source blocks also accept a @code{:float}
11724 attribute. You may set it to:
11727 @code{t}: if you want to make the source block a float. It is the default
11728 value when a caption is provided.
11730 @code{mulicolumn}: if you wish to include a source block which spans multiple
11733 @code{nil}: if you need to avoid any floating evironment, even when a caption
11734 is provided. It is useful for source code that may not fit in a single page.
11738 #+ATTR_LATEX: :float nil
11739 #+BEGIN_SRC emacs-lisp
11740 Code that may not fit in a single page.
11744 @subsubheading Special blocks in @LaTeX{} export
11745 @cindex special blocks, in @LaTeX{} export
11747 In @LaTeX{} back-end, special blocks become environments of the same name.
11748 Value of @code{:options} attribute will be appended as-is to that
11749 environment's opening string. For example:
11752 #+ATTR_LATEX: :options [Proof of important theorem]
11755 Therefore, any even number greater than 2 is the sum of two primes.
11763 \begin@{proof@}[Proof of important theorem]
11765 Therefore, any even number greater than 2 is the sum of two primes.
11769 @subsubheading Horizontal rules
11770 @cindex horizontal rules, in @LaTeX{} export
11772 Width and thickness of a given horizontal rule can be controlled with,
11773 respectively, @code{:width} and @code{:thickness} attributes:
11776 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
11780 @node Markdown export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
11781 @section Markdown export
11782 @cindex Markdown export
11784 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavour,
11785 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
11788 It is built over HTML back-end: any construct not supported by Markdown
11789 syntax (e.g., tables) will be controlled and translated by @code{html}
11790 back-end (@pxref{HTML export}).
11792 @subheading Markdown export commands
11795 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
11796 Export as a text file written in Markdown syntax. For an Org file,
11797 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
11798 will be overwritten without warning.
11799 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
11800 Export to a temporary buffer. Do not create a file.
11802 Export as a text file with Markdown syntax, then open it.
11805 @subheading Header and sectioning structure
11807 @vindex org-md-headline-style
11808 Markdown export can generate both @code{atx} and @code{setext} types for
11809 headlines, according to @code{org-md-headline-style}. The former introduces
11810 a hard limit of two levels, whereas the latter pushes it to six. Headlines
11811 below that limit are exported as lists. You can also set a soft limit before
11812 that one (@pxref{Export settings}).
11814 @c begin opendocument
11816 @node OpenDocument Text export, iCalendar export, Markdown export, Exporting
11817 @section OpenDocument Text export
11819 @cindex OpenDocument
11820 @cindex export, OpenDocument
11821 @cindex LibreOffice
11823 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11824 (ODT) format. Documents created by this exporter use the
11825 @cite{OpenDocument-v1.2
11826 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11827 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11828 are compatible with LibreOffice 3.4.
11831 * Pre-requisites for ODT export:: What packages ODT exporter relies on
11832 * ODT export commands:: How to invoke ODT export
11833 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
11834 * Applying custom styles:: How to apply custom styles to the output
11835 * Links in ODT export:: How links will be interpreted and formatted
11836 * Tables in ODT export:: How Tables are exported
11837 * Images in ODT export:: How to insert images
11838 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
11839 * Labels and captions in ODT export:: How captions are rendered
11840 * Literal examples in ODT export:: How source and example blocks are formatted
11841 * Advanced topics in ODT export:: Read this if you are a power user
11844 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
11845 @subsection Pre-requisites for ODT export
11847 The ODT exporter relies on the @file{zip} program to create the final
11848 output. Check the availability of this program before proceeding further.
11850 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
11851 @subsection ODT export commands
11853 @subsubheading Exporting to ODT
11854 @anchor{x-export-to-odt}
11856 @cindex region, active
11857 @cindex active region
11858 @cindex transient-mark-mode
11860 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
11861 @cindex property EXPORT_FILE_NAME
11863 Export as OpenDocument Text file.
11865 @vindex org-odt-preferred-output-format
11866 If @code{org-odt-preferred-output-format} is specified, automatically convert
11867 the exported file to that format. @xref{x-export-to-other-formats, ,
11868 Automatically exporting to other formats}.
11870 For an Org file @file{myfile.org}, the ODT file will be
11871 @file{myfile.odt}. The file will be overwritten without warning. If there
11872 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11873 turned on} only the region will be exported. If the selected region is a
11874 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11875 tree head will become the document title. If the tree head entry has, or
11876 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11880 Export as an OpenDocument Text file and open the resulting file.
11882 @vindex org-odt-preferred-output-format
11883 If @code{org-odt-preferred-output-format} is specified, open the converted
11884 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
11888 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
11889 @subsection Extending ODT export
11891 The ODT exporter can interface with a variety of document
11892 converters and supports popular converters out of the box. As a result, you
11893 can use it to export to formats like @samp{doc} or convert a document from
11894 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11896 @cindex @file{unoconv}
11897 @cindex LibreOffice
11898 If you have a working installation of LibreOffice, a document converter is
11899 pre-configured for you and you can use it right away. If you would like to
11900 use @file{unoconv} as your preferred converter, customize the variable
11901 @code{org-odt-convert-process} to point to @code{unoconv}. You can
11902 also use your own favorite converter or tweak the default settings of the
11903 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
11904 document converter}.
11906 @subsubsection Automatically exporting to other formats
11907 @anchor{x-export-to-other-formats}
11909 @vindex org-odt-preferred-output-format
11910 Very often, you will find yourself exporting to ODT format, only to
11911 immediately save the exported document to other formats like @samp{doc},
11912 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
11913 preferred output format by customizing the variable
11914 @code{org-odt-preferred-output-format}. This way, the export commands
11915 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
11916 format that is of immediate interest to you.
11918 @subsubsection Converting between document formats
11919 @anchor{x-convert-to-other-formats}
11921 There are many document converters in the wild which support conversion to
11922 and from various file formats, including, but not limited to the
11923 ODT format. LibreOffice converter, mentioned above, is one such
11924 converter. Once a converter is configured, you can interact with it using
11925 the following command.
11927 @vindex org-odt-convert
11930 @item M-x org-odt-convert RET
11931 Convert an existing document from one format to another. With a prefix
11932 argument, also open the newly produced file.
11935 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
11936 @subsection Applying custom styles
11937 @cindex styles, custom
11938 @cindex template, custom
11940 The ODT exporter ships with a set of OpenDocument styles
11941 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
11942 output. These factory styles, however, may not cater to your specific
11943 tastes. To customize the output, you can either modify the above styles
11944 files directly, or generate the required styles using an application like
11945 LibreOffice. The latter method is suitable for expert and non-expert
11946 users alike, and is described here.
11948 @subsubsection Applying custom styles: the easy way
11952 Create a sample @file{example.org} file with the below settings and export it
11956 #+OPTIONS: H:10 num:t
11960 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
11961 to locate the target styles---these typically have the @samp{Org} prefix---and
11962 modify those to your taste. Save the modified file either as an
11963 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
11966 @cindex #+ODT_STYLES_FILE
11967 @vindex org-odt-styles-file
11968 Customize the variable @code{org-odt-styles-file} and point it to the
11969 newly created file. For additional configuration options
11970 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
11972 If you would like to choose a style on a per-file basis, you can use the
11973 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
11976 #+ODT_STYLES_FILE: "/path/to/example.ott"
11982 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
11987 @subsubsection Using third-party styles and templates
11989 You can use third-party styles and templates for customizing your output.
11990 This will produce the desired output only if the template provides all
11991 style names that the @samp{ODT} exporter relies on. Unless this condition is
11992 met, the output is going to be less than satisfactory. So it is highly
11993 recommended that you only work with templates that are directly derived from
11994 the factory settings.
11996 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
11997 @subsection Links in ODT export
11998 @cindex links, in ODT export
12000 ODT exporter creates native cross-references for internal links. It creates
12001 Internet-style links for all other links.
12003 A link with no description and destined to a regular (un-itemized) outline
12004 heading is replaced with a cross-reference and section number of the heading.
12006 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12007 with a cross-reference and sequence number of the labeled entity.
12008 @xref{Labels and captions in ODT export}.
12010 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
12011 @subsection Tables in ODT export
12012 @cindex tables, in ODT export
12014 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12015 tables is supported. However, export of complex @file{table.el} tables---tables
12016 that have column or row spans---is not supported. Such tables are
12017 stripped from the exported document.
12019 By default, a table is exported with top and bottom frames and with rules
12020 separating row and column groups (@pxref{Column groups}). Furthermore, all
12021 tables are typeset to occupy the same width. If the table specifies
12022 alignment and relative width for its columns (@pxref{Column width and
12023 alignment}) then these are honored on export.@footnote{The column widths are
12024 interpreted as weighted ratios with the default weight being 1}
12027 You can control the width of the table by specifying @code{:rel-width}
12028 property using an @code{#+ATTR_ODT} line.
12030 For example, consider the following table which makes use of all the rules
12034 #+ATTR_ODT: :rel-width 50
12035 | Area/Month | Jan | Feb | Mar | Sum |
12036 |---------------+-------+-------+-------+-------|
12038 | <l13> | <r5> | <r5> | <r5> | <r6> |
12039 | North America | 1 | 21 | 926 | 948 |
12040 | Middle East | 6 | 75 | 844 | 925 |
12041 | Asia Pacific | 9 | 27 | 790 | 826 |
12042 |---------------+-------+-------+-------+-------|
12043 | Sum | 16 | 123 | 2560 | 2699 |
12046 On export, the table will occupy 50% of text area. The columns will be sized
12047 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12048 and rest of the columns will be right-aligned. There will be vertical rules
12049 after separating the header and last columns from other columns. There will
12050 be horizontal rules separating the header and last rows from other rows.
12052 If you are not satisfied with the above formatting options, you can create
12053 custom table styles and associate them with a table using the
12054 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12056 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
12057 @subsection Images in ODT export
12058 @cindex images, embedding in ODT
12059 @cindex embedding images in ODT
12061 @subsubheading Embedding images
12062 You can embed images within the exported document by providing a link to the
12063 desired image file with no link description. For example, to embed
12064 @samp{img.png} do either of the following:
12074 @subsubheading Embedding clickable images
12075 You can create clickable images by providing a link whose description is a
12076 link to an image file. For example, to embed a image
12077 @file{org-mode-unicorn.png} which when clicked jumps to
12078 @uref{http://Orgmode.org} website, do the following
12081 [[http://orgmode.org][./org-mode-unicorn.png]]
12084 @subsubheading Sizing and scaling of embedded images
12087 You can control the size and scale of the embedded images using the
12088 @code{#+ATTR_ODT} attribute.
12090 @cindex identify, ImageMagick
12091 @vindex org-odt-pixels-per-inch
12092 The exporter specifies the desired size of the image in the final document in
12093 units of centimeters. In order to scale the embedded images, the exporter
12094 queries for pixel dimensions of the images using one of a) ImageMagick's
12095 @file{identify} program or b) Emacs `create-image' and `image-size'
12096 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12097 routinely produce documents that have large images or you export your Org
12098 files that has images using a Emacs batch script, then the use of
12099 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12100 converted in to units of centimeters using
12101 @code{org-odt-pixels-per-inch}. The default value of this variable is
12102 set to @code{display-pixels-per-inch}. You can tweak this variable to
12103 achieve the best results.
12105 The examples below illustrate the various possibilities.
12108 @item Explicitly size the image
12109 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12112 #+ATTR_ODT: :width 10 :height 10
12116 @item Scale the image
12117 To embed @file{img.png} at half its size, do the following:
12120 #+ATTR_ODT: :scale 0.5
12124 @item Scale the image to a specific width
12125 To embed @file{img.png} with a width of 10 cm while retaining the original
12126 height:width ratio, do the following:
12129 #+ATTR_ODT: :width 10
12133 @item Scale the image to a specific height
12134 To embed @file{img.png} with a height of 10 cm while retaining the original
12135 height:width ratio, do the following
12138 #+ATTR_ODT: :height 10
12143 @subsubheading Anchoring of images
12146 You can control the manner in which an image is anchored by setting the
12147 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
12148 of the the following three values for the @code{:anchor} property:
12149 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12151 To create an image that is anchored to a page, do the following:
12153 #+ATTR_ODT: :anchor "page"
12157 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
12158 @subsection Math formatting in ODT export
12160 The ODT exporter has special support for handling math.
12163 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12164 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12167 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
12168 @subsubsection Working with @LaTeX{} math snippets
12170 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12171 document in one of the following ways:
12177 This option is activated on a per-file basis with
12183 With this option, @LaTeX{} fragments are first converted into MathML
12184 fragments using an external @LaTeX{}-to-MathML converter program. The
12185 resulting MathML fragments are then embedded as an OpenDocument Formula in
12186 the exported document.
12188 @vindex org-latex-to-mathml-convert-command
12189 @vindex org-latex-to-mathml-jar-file
12191 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12192 @code{org-latex-to-mathml-convert-command} and
12193 @code{org-latex-to-mathml-jar-file}.
12195 If you prefer to use @file{MathToWeb}@footnote{See
12196 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
12197 converter, you can configure the above variables as shown below.
12200 (setq org-latex-to-mathml-convert-command
12201 "java -jar %j -unicode -force -df %o %I"
12202 org-latex-to-mathml-jar-file
12203 "/path/to/mathtoweb.jar")
12206 You can use the following commands to quickly verify the reliability of
12207 the @LaTeX{}-to-MathML converter.
12210 @item M-x org-odt-export-as-odf RET
12211 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12213 @item M-x org-odt-export-as-odf-and-open RET
12214 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12215 and open the formula file with the system-registered application.
12221 This option is activated on a per-file basis with
12224 #+OPTIONS: LaTeX:dvipng
12227 With this option, @LaTeX{} fragments are processed into PNG images and the
12228 resulting images are embedded in the exported document. This method requires
12229 that the @file{dvipng} program be available on your system.
12232 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export
12233 @subsubsection Working with MathML or OpenDocument formula files
12235 For various reasons, you may find embedding @LaTeX{} math snippets in an
12236 ODT document less than reliable. In that case, you can embed a
12237 math equation by linking to its MathML (@file{.mml}) source or its
12238 OpenDocument formula (@file{.odf}) file as shown below:
12250 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
12251 @subsection Labels and captions in ODT export
12253 You can label and caption various category of objects---an inline image, a
12254 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12255 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12256 each labeled or captioned object of a given category separately. As a
12257 result, each such object is assigned a sequence number based on order of it's
12258 appearance in the Org file.
12260 In the exported document, a user-provided caption is augmented with the
12261 category and sequence number. Consider the following inline image in an Org
12265 #+CAPTION: Bell curve
12266 #+LABEL: fig:SED-HR4049
12270 It could be rendered as shown below in the exported document.
12273 Figure 2: Bell curve
12276 @vindex org-odt-category-map-alist
12277 You can modify the category component of the caption by customizing the
12278 option @code{org-odt-category-map-alist}. For example, to tag all embedded
12279 images with the string @samp{Illustration} (instead of the default
12280 @samp{Figure}) use the following setting:
12283 (setq org-odt-category-map-alist
12284 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12287 With this, previous image will be captioned as below in the exported
12291 Illustration 2: Bell curve
12294 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
12295 @subsection Literal examples in ODT export
12297 Export of literal examples (@pxref{Literal examples}) with full fontification
12298 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
12299 generate all style definitions needed for a fancy listing.@footnote{Your
12300 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12301 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
12302 as prefix and inherit their color from the faces used by Emacs
12303 @code{font-lock} library for the source language.
12305 @vindex org-odt-fontify-srcblocks
12306 If you prefer to use your own custom styles for fontification, you can do
12307 so by customizing the option
12308 @code{org-odt-create-custom-styles-for-srcblocks}.
12310 @vindex org-odt-create-custom-styles-for-srcblocks
12311 You can turn off fontification of literal examples by customizing the
12312 option @code{org-odt-fontify-srcblocks}.
12314 @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export
12315 @subsection Advanced topics in ODT export
12317 If you rely heavily on ODT export, you may want to exploit the full
12318 set of features that the exporter offers. This section describes features
12319 that would be of interest to power users.
12322 * Configuring a document converter:: How to register a document converter
12323 * Working with OpenDocument style files:: Explore the internals
12324 * Creating one-off styles:: How to produce custom highlighting etc
12325 * Customizing tables in ODT export:: How to define and use Table templates
12326 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
12329 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
12330 @subsubsection Configuring a document converter
12332 @cindex doc, docx, rtf
12335 The ODT exporter can work with popular converters with little or no
12336 extra configuration from your side. @xref{Extending ODT export}.
12337 If you are using a converter that is not supported by default or if you would
12338 like to tweak the default converter settings, proceed as below.
12341 @item Register the converter
12343 @vindex org-odt-convert-processes
12344 Name your converter and add it to the list of known converters by
12345 customizing the option @code{org-odt-convert-processes}. Also specify how
12346 the converter can be invoked via command-line to effect the conversion.
12348 @item Configure its capabilities
12350 @vindex org-odt-convert-capabilities
12351 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12352 converter can handle by customizing the variable
12353 @code{org-odt-convert-capabilities}. Use the default value for this
12354 variable as a guide for configuring your converter. As suggested by the
12355 default setting, you can specify the full set of formats supported by the
12356 converter and not limit yourself to specifying formats that are related to
12357 just the OpenDocument Text format.
12359 @item Choose the converter
12361 @vindex org-odt-convert-process
12362 Select the newly added converter as the preferred one by customizing the
12363 option @code{org-odt-convert-process}.
12366 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
12367 @subsubsection Working with OpenDocument style files
12368 @cindex styles, custom
12369 @cindex template, custom
12371 This section explores the internals of the ODT exporter and the
12372 means by which it produces styled documents. Read this section if you are
12373 interested in exploring the automatic and custom OpenDocument styles used by
12376 @anchor{x-factory-styles}
12377 @subsubheading Factory styles
12379 The ODT exporter relies on two files for generating its output.
12380 These files are bundled with the distribution under the directory pointed to
12381 by the variable @code{org-odt-styles-dir}. The two files are:
12384 @anchor{x-orgodtstyles-xml}
12386 @file{OrgOdtStyles.xml}
12388 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12389 document. This file gets modified for the following purposes:
12393 To control outline numbering based on user settings.
12396 To add styles generated by @file{htmlfontify.el} for fontification of code
12400 @anchor{x-orgodtcontenttemplate-xml}
12402 @file{OrgOdtContentTemplate.xml}
12404 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12405 document. The contents of the Org outline are inserted between the
12406 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12408 Apart from serving as a template file for the final @file{content.xml}, the
12409 file serves the following purposes:
12413 It contains automatic styles for formatting of tables which are referenced by
12417 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12418 elements that control how various entities---tables, images, equations,
12419 etc.---are numbered.
12423 @anchor{x-overriding-factory-styles}
12424 @subsubheading Overriding factory styles
12425 The following two variables control the location from which the ODT
12426 exporter picks up the custom styles and content template files. You can
12427 customize these variables to override the factory styles used by the
12431 @anchor{x-org-odt-styles-file}
12433 @code{org-odt-styles-file}
12435 Use this variable to specify the @file{styles.xml} that will be used in the
12436 final output. You can specify one of the following values:
12439 @item A @file{styles.xml} file
12441 Use this file instead of the default @file{styles.xml}
12443 @item A @file{.odt} or @file{.ott} file
12445 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12448 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12450 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12451 Template file. Additionally extract the specified member files and embed
12452 those within the final @samp{ODT} document.
12454 Use this option if the @file{styles.xml} file references additional files
12455 like header and footer images.
12459 Use the default @file{styles.xml}
12462 @anchor{x-org-odt-content-template-file}
12464 @code{org-odt-content-template-file}
12466 Use this variable to specify the blank @file{content.xml} that will be used
12467 in the final output.
12470 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
12471 @subsubsection Creating one-off styles
12473 There are times when you would want one-off formatting in the exported
12474 document. You can achieve this by embedding raw OpenDocument XML in the Org
12475 file. The use of this feature is better illustrated with couple of examples.
12478 @item Embedding ODT tags as part of regular text
12480 You can include simple OpenDocument tags by prefixing them with
12481 @samp{@@}. For example, to highlight a region of text do the following:
12484 @@<text:span text:style-name="Highlight">This is a
12485 highlighted text@@</text:span>. But this is a
12489 @strong{Hint:} To see the above example in action, edit your
12490 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12491 custom @samp{Highlight} style as shown below.
12494 <style:style style:name="Highlight" style:family="text">
12495 <style:text-properties fo:background-color="#ff0000"/>
12499 @item Embedding a one-line OpenDocument XML
12501 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12502 directive. For example, to force a page break do the following:
12505 #+ODT: <text:p text:style-name="PageBreak"/>
12508 @strong{Hint:} To see the above example in action, edit your
12509 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12510 custom @samp{PageBreak} style as shown below.
12513 <style:style style:name="PageBreak" style:family="paragraph"
12514 style:parent-style-name="Text_20_body">
12515 <style:paragraph-properties fo:break-before="page"/>
12519 @item Embedding a block of OpenDocument XML
12521 You can add a large block of OpenDocument XML using the
12522 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12524 For example, to create a one-off paragraph that uses bold text, do the
12529 <text:p text:style-name="Text_20_body_20_bold">
12530 This paragraph is specially formatted and uses bold text.
12537 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
12538 @subsubsection Customizing tables in ODT export
12539 @cindex tables, in ODT export
12542 You can override the default formatting of the table by specifying a custom
12543 table style with the @code{#+ATTR_ODT} line. For a discussion on default
12544 formatting of tables @pxref{Tables in ODT export}.
12546 This feature closely mimics the way table templates are defined in the
12548 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12549 OpenDocument-v1.2 Specification}}
12551 @subsubheading Custom table styles: an illustration
12553 @vindex org-odt-table-styles
12554 To have a quick preview of this feature, install the below setting and
12555 export the table that follows:
12558 (setq org-odt-table-styles
12559 (append org-odt-table-styles
12560 '(("TableWithHeaderRowAndColumn" "Custom"
12561 ((use-first-row-styles . t)
12562 (use-first-column-styles . t)))
12563 ("TableWithFirstRowandLastRow" "Custom"
12564 ((use-first-row-styles . t)
12565 (use-last-row-styles . t))))))
12569 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12570 | Name | Phone | Age |
12571 | Peter | 1234 | 17 |
12572 | Anna | 4321 | 25 |
12575 In the above example, you used a template named @samp{Custom} and installed
12576 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12577 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
12578 styles needed for producing the above template have been pre-defined for
12579 you. These styles are available under the section marked @samp{Custom
12580 Table Template} in @file{OrgOdtContentTemplate.xml}
12581 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
12582 additional templates you have to define these styles yourselves.
12584 @subsubheading Custom table styles: the nitty-gritty
12585 To use this feature proceed as follows:
12589 Create a table template@footnote{See the @code{<table:table-template>}
12590 element of the OpenDocument-v1.2 specification}
12592 A table template is nothing but a set of @samp{table-cell} and
12593 @samp{paragraph} styles for each of the following table cell categories:
12607 The names for the above styles must be chosen based on the name of the table
12608 template using a well-defined convention.
12610 The naming convention is better illustrated with an example. For a table
12611 template with the name @samp{Custom}, the needed style names are listed in
12612 the following table.
12614 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12615 @headitem Table cell type
12616 @tab @code{table-cell} style
12617 @tab @code{paragraph} style
12622 @tab @samp{CustomTableCell}
12623 @tab @samp{CustomTableParagraph}
12625 @tab @samp{CustomFirstColumnTableCell}
12626 @tab @samp{CustomFirstColumnTableParagraph}
12628 @tab @samp{CustomLastColumnTableCell}
12629 @tab @samp{CustomLastColumnTableParagraph}
12631 @tab @samp{CustomFirstRowTableCell}
12632 @tab @samp{CustomFirstRowTableParagraph}
12634 @tab @samp{CustomLastRowTableCell}
12635 @tab @samp{CustomLastRowTableParagraph}
12637 @tab @samp{CustomEvenRowTableCell}
12638 @tab @samp{CustomEvenRowTableParagraph}
12640 @tab @samp{CustomOddRowTableCell}
12641 @tab @samp{CustomOddRowTableParagraph}
12643 @tab @samp{CustomEvenColumnTableCell}
12644 @tab @samp{CustomEvenColumnTableParagraph}
12646 @tab @samp{CustomOddColumnTableCell}
12647 @tab @samp{CustomOddColumnTableParagraph}
12650 To create a table template with the name @samp{Custom}, define the above
12652 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12653 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12657 Define a table style@footnote{See the attributes @code{table:template-name},
12658 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12659 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12660 @code{table:use-banding-rows-styles}, and
12661 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12662 the OpenDocument-v1.2 specification}
12664 @vindex org-odt-table-styles
12665 To define a table style, create an entry for the style in the variable
12666 @code{org-odt-table-styles} and specify the following:
12669 @item the name of the table template created in step (1)
12670 @item the set of cell styles in that template that are to be activated
12673 For example, the entry below defines two different table styles
12674 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12675 based on the same template @samp{Custom}. The styles achieve their intended
12676 effect by selectively activating the individual cell styles in that template.
12679 (setq org-odt-table-styles
12680 (append org-odt-table-styles
12681 '(("TableWithHeaderRowAndColumn" "Custom"
12682 ((use-first-row-styles . t)
12683 (use-first-column-styles . t)))
12684 ("TableWithFirstRowandLastRow" "Custom"
12685 ((use-first-row-styles . t)
12686 (use-last-row-styles . t))))))
12690 Associate a table with the table style
12692 To do this, specify the table style created in step (2) as part of
12693 the @code{ATTR_ODT} line as shown below.
12696 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12697 | Name | Phone | Age |
12698 | Peter | 1234 | 17 |
12699 | Anna | 4321 | 25 |
12703 @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export
12704 @subsubsection Validating OpenDocument XML
12706 Occasionally, you will discover that the document created by the
12707 ODT exporter cannot be opened by your favorite application. One of
12708 the common reasons for this is that the @file{.odt} file is corrupt. In such
12709 cases, you may want to validate the document against the OpenDocument RELAX
12710 NG Compact Syntax (RNC) schema.
12712 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12713 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
12714 general help with validation (and schema-sensitive editing) of XML files:
12715 @inforef{Introduction,,nxml-mode}.
12717 @vindex org-odt-schema-dir
12718 If you have ready access to OpenDocument @file{.rnc} files and the needed
12719 schema-locating rules in a single folder, you can customize the variable
12720 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
12721 will take care of updating the @code{rng-schema-locating-files} for you.
12723 @c end opendocument
12725 @node iCalendar export, Other built-in back-ends, OpenDocument Text export, Exporting
12726 @section iCalendar export
12727 @cindex iCalendar export
12729 @vindex org-icalendar-include-todo
12730 @vindex org-icalendar-use-deadline
12731 @vindex org-icalendar-use-scheduled
12732 @vindex org-icalendar-categories
12733 @vindex org-icalendar-alarm-time
12734 Some people use Org mode for keeping track of projects, but still prefer a
12735 standard calendar application for anniversaries and appointments. In this
12736 case it can be useful to show deadlines and other time-stamped items in Org
12737 files in the calendar application. Org mode can export calendar information
12738 in the standard iCalendar format. If you also want to have TODO entries
12739 included in the export, configure the variable
12740 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
12741 and TODO items as VTODO@. It will also create events from deadlines that are
12742 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
12743 to set the start and due dates for the TODO entry@footnote{See the variables
12744 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12745 As categories, it will use the tags locally defined in the heading, and the
12746 file/tree category@footnote{To add inherited tags or the TODO state,
12747 configure the variable @code{org-icalendar-categories}.}. See the variable
12748 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12751 @vindex org-icalendar-store-UID
12752 @cindex property, ID
12753 The iCalendar standard requires each entry to have a globally unique
12754 identifier (UID). Org creates these identifiers during export. If you set
12755 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12756 @code{:ID:} property of the entry and re-used next time you report this
12757 entry. Since a single entry can give rise to multiple iCalendar entries (as
12758 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12759 prefixes to the UID, depending on what triggered the inclusion of the entry.
12760 In this way the UID remains unique, but a synchronization program can still
12761 figure out from which entry all the different instances originate.
12764 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
12765 Create iCalendar entries for the current buffer and store them in the same
12766 directory, using a file extension @file{.ics}.
12767 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
12768 @vindex org-agenda-files
12769 Like @kbd{C-c C-e c f}, but do this for all files in
12770 @code{org-agenda-files}. For each of these files, a separate iCalendar
12771 file will be written.
12772 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
12773 @vindex org-icalendar-combined-agenda-file
12774 Create a single large iCalendar file from all files in
12775 @code{org-agenda-files} and write it to the file given by
12776 @code{org-icalendar-combined-agenda-file}.
12779 @vindex org-use-property-inheritance
12780 @vindex org-icalendar-include-body
12781 @cindex property, SUMMARY
12782 @cindex property, DESCRIPTION
12783 @cindex property, LOCATION
12784 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12785 property can be inherited from higher in the hierarchy if you configure
12786 @code{org-use-property-inheritance} accordingly.} properties if the selected
12787 entries have them. If not, the summary will be derived from the headline,
12788 and the description from the body (limited to
12789 @code{org-icalendar-include-body} characters).
12791 How this calendar is best read and updated, depends on the application
12792 you are using. The FAQ covers this issue.
12794 @node Other built-in back-ends, Export in foreign buffers, iCalendar export, Exporting
12795 @section Other built-in back-ends
12796 @cindex export back-ends, built-in
12797 @vindex org-export-backends
12799 On top of the aforemetioned back-ends, Org comes with other built-in ones:
12802 @item @file{ox-man.el}: export to a man page.
12803 @item @file{ox-texinfo.el}: export to @code{Texinfo} format.
12804 @item @file{ox-org.el}: export to an Org document.
12807 To activate these export back-end, customize @code{org-export-backends} or
12808 load them directly with e.g., @code{(require 'ox-texinfo)}. This will add
12809 new keys in the export dispatcher (@pxref{The Export Dispatcher}).
12811 See the comment section of these files for more information on how to use
12814 @node Export in foreign buffers, Advanced configuration, Other built-in back-ends, Exporting
12815 @section Export in foreign buffers
12817 Most built-in back-ends come with a command to convert the selected region
12818 into a selected format and replace this region by the exported output. Here
12819 is a list of such conversion commands:
12822 @item org-html-convert-region-to-html
12823 Convert the selected region into HTML.
12824 @item org-latex-convert-region-to-latex
12825 Convert the selected region into @LaTeX{}.
12826 @item org-texinfo-convert-region-to-texinfo
12827 Convert the selected region into @code{Texinfo}.
12828 @item org-md-convert-region-to-md
12829 Convert the selected region into @code{MarkDown}.
12832 This is particularily useful for converting tables and lists in foreign
12833 buffers. E.g., in a HTML buffer, you can turn on @code{orgstruct-mode}, then
12834 use Org commands for editing a list, and finally select and convert the list
12835 with @code{M-x org-html-convert-region-to-html RET}.
12837 @node Advanced configuration, , Export in foreign buffers, Exporting
12838 @section Advanced configuration
12842 @vindex org-export-before-processing-hook
12843 @vindex org-export-before-parsing-hook
12844 Two hooks are run during the first steps of the export process. The first
12845 one, @code{org-export-before-processing-hook} is called before expanding
12846 macros, Babel code and include keywords in the buffer. The second one,
12847 @code{org-export-before-parsing-hook}, as its name suggests, happens just
12848 before parsing the buffer. Their main use is for heavy duties, that is
12849 duties involving structural modifications of the document. For example, one
12850 may want to remove every headline in the buffer during export. The following
12851 code can achieve this:
12855 (defun my-headline-removal (backend)
12856 "Remove all headlines in the current buffer.
12857 BACKEND is the export back-end being used, as a symbol."
12859 (lambda () (delete-region (point) (progn (forward-line) (point))))))
12861 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
12865 Note that functions used in these hooks require a mandatory argument,
12866 a symbol representing the back-end used.
12868 @subheading Filters
12870 @cindex Filters, exporting
12871 Filters are lists of functions applied on a specific part of the output from
12872 a given back-end. More explicitly, each time a back-end transforms an Org
12873 object or element into another language, all functions within a given filter
12874 type are called in turn on the string produced. The string returned by the
12875 last function will be the one used in the final output.
12877 There are filters sets for each type of element or object, for plain text,
12878 for the parse tree, for the export options and for the final output. They
12879 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
12880 where @code{TYPE} is the type targeted by the filter. Valid types are:
12882 @multitable @columnfractions .33 .33 .33
12889 @item comment-block
12892 @item dynamic-block
12896 @tab export-snippet
12899 @tab footnote-definition
12900 @tab footnote-reference
12902 @tab horizontal-rule
12903 @tab inline-babel-call
12904 @item inline-src-block
12909 @tab latex-environment
12910 @item latex-fragment
12913 @item node-property
12920 @tab property-drawer
12922 @item quote-section
12925 @item special-block
12927 @tab statistics-cookie
12928 @item strike-through
12942 For example, the following snippet allows me to use non-breaking spaces in
12943 the Org buffer and get them translated into @LaTeX{} without using the
12944 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
12948 (defun my-latex-filter-nobreaks (text backend info)
12949 "Ensure \" \" are properly handled in LaTeX export."
12950 (when (org-export-derived-backend-p backend 'latex)
12951 (replace-regexp-in-string " " "~" text)))
12953 (add-to-list 'org-export-filter-plain-text-functions
12954 'my-latex-filter-nobreaks)
12958 Three arguments must be provided to a fiter: the code being changed, the
12959 back-end used, and some information about the export process. You can safely
12960 ignore the third argument for most purposes. Note the use of
12961 @code{org-export-derived-backend-p}, which ensures that the filter will only
12962 be applied when using @code{latex} back-end or any other back-end derived
12963 from it (e.g., @code{beamer}).
12965 @subheading Extending an existing back-end
12967 This is obviously the most powerful customization, since the changes happen
12968 at the parser level. Indeed, some export back-ends are built as extensions
12969 of other ones (e.g. Markdown back-end an extension of HTML back-end).
12971 Extending a back-end means that if an element type is not transcoded by the
12972 new back-end, it will be handled by the original one. Hence you can extend
12973 specific parts of a back-end without too much work.
12975 As an example, imagine we want the @code{ascii} back-end to display the
12976 language used in a source block, when it is available, but only when some
12977 attribute is non-@code{nil}, like the following:
12980 #+ATTR_ASCII: :language t
12983 Because that back-end is lacking in that area, we are going to create a new
12984 back-end, @code{my-ascii} that will do the job.
12988 (defun my-ascii-src-block (src-block contents info)
12989 "Transcode a SRC-BLOCK element from Org to ASCII.
12990 CONTENTS is nil. INFO is a plist used as a communication
12992 (if (not (org-export-read-attribute :attr_ascii src-block :language))
12993 (org-export-with-backend 'ascii src-block contents info)
12995 (format ",--[ %s ]--\n%s`----"
12996 (org-element-property :language src-block)
12997 (replace-regexp-in-string
12999 (org-element-normalize-string
13000 (org-export-format-code-default src-block info)))))))
13002 (org-export-define-derived-backend 'my-ascii 'ascii
13003 :translate-alist '((src-block . my-ascii-src-block)))
13007 The @code{my-ascii-src-block} function looks at the attribute above the
13008 element. If it isn’t true, it gives hand to the @code{ascii} back-end.
13009 Otherwise, it creates a box around the code, leaving room for the language.
13010 A new back-end is then created. It only changes its behaviour when
13011 translating @code{src-block} type element. Now, all it takes to use the new
13012 back-end is calling the following from an Org buffer:
13015 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13018 It is obviously possible to write an interactive function for this, install
13019 it in the export dispatcher menu, and so on.
13021 @node Publishing, Working With Source Code, Exporting, Top
13022 @chapter Publishing
13025 Org includes a publishing management system that allows you to configure
13026 automatic HTML conversion of @emph{projects} composed of interlinked org
13027 files. You can also configure Org to automatically upload your exported HTML
13028 pages and related attachments, such as images and source code files, to a web
13031 You can also use Org to convert files into PDF, or even combine HTML and PDF
13032 conversion so that files are available in both formats on the server.
13034 Publishing has been contributed to Org by David O'Toole.
13037 * Configuration:: Defining projects
13038 * Uploading files:: How to get files up on the server
13039 * Sample configuration:: Example projects
13040 * Triggering publication:: Publication commands
13043 @node Configuration, Uploading files, Publishing, Publishing
13044 @section Configuration
13046 Publishing needs significant configuration to specify files, destination
13047 and many other properties of a project.
13050 * Project alist:: The central configuration variable
13051 * Sources and destinations:: From here to there
13052 * Selecting files:: What files are part of the project?
13053 * Publishing action:: Setting the function doing the publishing
13054 * Publishing options:: Tweaking HTML/@LaTeX{} export
13055 * Publishing links:: Which links keep working after publishing?
13056 * Sitemap:: Generating a list of all pages
13057 * Generating an index:: An index that reaches across pages
13060 @node Project alist, Sources and destinations, Configuration, Configuration
13061 @subsection The variable @code{org-publish-project-alist}
13062 @cindex org-publish-project-alist
13063 @cindex projects, for publishing
13065 @vindex org-publish-project-alist
13066 Publishing is configured almost entirely through setting the value of one
13067 variable, called @code{org-publish-project-alist}. Each element of the list
13068 configures one project, and may be in one of the two following forms:
13071 ("project-name" :property value :property value ...)
13072 @r{i.e., a well-formed property list with alternating keys and values}
13074 ("project-name" :components ("project-name" "project-name" ...))
13078 In both cases, projects are configured by specifying property values. A
13079 project defines the set of files that will be published, as well as the
13080 publishing configuration to use when publishing those files. When a project
13081 takes the second form listed above, the individual members of the
13082 @code{:components} property are taken to be sub-projects, which group
13083 together files requiring different publishing options. When you publish such
13084 a ``meta-project'', all the components will also be published, in the
13087 @node Sources and destinations, Selecting files, Project alist, Configuration
13088 @subsection Sources and destinations for files
13089 @cindex directories, for publishing
13091 Most properties are optional, but some should always be set. In
13092 particular, Org needs to know where to look for source files,
13093 and where to put published files.
13095 @multitable @columnfractions 0.3 0.7
13096 @item @code{:base-directory}
13097 @tab Directory containing publishing source files
13098 @item @code{:publishing-directory}
13099 @tab Directory where output files will be published. You can directly
13100 publish to a web server using a file name syntax appropriate for
13101 the Emacs @file{tramp} package. Or you can publish to a local directory and
13102 use external tools to upload your website (@pxref{Uploading files}).
13103 @item @code{:preparation-function}
13104 @tab Function or list of functions to be called before starting the
13105 publishing process, for example, to run @code{make} for updating files to be
13106 published. The project property list is scoped into this call as the
13107 variable @code{project-plist}.
13108 @item @code{:completion-function}
13109 @tab Function or list of functions called after finishing the publishing
13110 process, for example, to change permissions of the resulting files. The
13111 project property list is scoped into this call as the variable
13112 @code{project-plist}.
13116 @node Selecting files, Publishing action, Sources and destinations, Configuration
13117 @subsection Selecting files
13118 @cindex files, selecting for publishing
13120 By default, all files with extension @file{.org} in the base directory
13121 are considered part of the project. This can be modified by setting the
13123 @multitable @columnfractions 0.25 0.75
13124 @item @code{:base-extension}
13125 @tab Extension (without the dot!) of source files. This actually is a
13126 regular expression. Set this to the symbol @code{any} if you want to get all
13127 files in @code{:base-directory}, even without extension.
13129 @item @code{:exclude}
13130 @tab Regular expression to match file names that should not be
13131 published, even though they have been selected on the basis of their
13134 @item @code{:include}
13135 @tab List of files to be included regardless of @code{:base-extension}
13136 and @code{:exclude}.
13138 @item @code{:recursive}
13139 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13142 @node Publishing action, Publishing options, Selecting files, Configuration
13143 @subsection Publishing action
13144 @cindex action, for publishing
13146 Publishing means that a file is copied to the destination directory and
13147 possibly transformed in the process. The default transformation is to export
13148 Org files as HTML files, and this is done by the function
13149 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13150 export}). But you also can publish your content as PDF files using
13151 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13152 using the corresponding functions.
13154 If you want to publish the Org file as an @code{.org} file but with the
13155 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13156 function @code{org-org-publish-to-org}. This will produce @file{file.org}
13157 and put it in the publishing directory. If you want a htmlized version of
13158 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13159 produce @file{file.org.html} in the publishing directory@footnote{If the
13160 publishing directory is the same than the source directory, @file{file.org}
13161 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13163 Other files like images only need to be copied to the publishing destination.
13164 For this you can use @code{org-publish-attachment}. For non-org files, you
13165 always need to specify the publishing function:
13167 @multitable @columnfractions 0.3 0.7
13168 @item @code{:publishing-function}
13169 @tab Function executing the publication of a file. This may also be a
13170 list of functions, which will all be called in turn.
13171 @item @code{:htmlized-source}
13172 @tab non-@code{nil} means, publish htmlized source.
13175 The function must accept three arguments: a property list containing at least
13176 a @code{:publishing-directory} property, the name of the file to be published
13177 and the path to the publishing directory of the output file. It should take
13178 the specified file, make the necessary transformation (if any) and place the
13179 result into the destination folder.
13181 @node Publishing options, Publishing links, Publishing action, Configuration
13182 @subsection Options for the exporters
13183 @cindex options, for publishing
13185 The property list can be used to set many export options for the exporters.
13186 In most cases, these properties correspond to user variables in Org. The
13187 first table below lists these properties along with the variable they belong
13188 to. The second table list HTML specific properties. See the documentation
13189 string of these options for details.
13191 @vindex org-display-custom-times
13192 @vindex org-export-default-language
13193 @vindex org-export-exclude-tags
13194 @vindex org-export-headline-levels
13195 @vindex org-export-preserve-breaks
13196 @vindex org-export-publishing-directory
13197 @vindex org-export-select-tags
13198 @vindex org-export-with-archived-trees
13199 @vindex org-export-with-author
13200 @vindex org-export-with-creator
13201 @vindex org-export-with-drawers
13202 @vindex org-export-with-email
13203 @vindex org-export-with-emphasize
13204 @vindex org-export-with-fixed-width
13205 @vindex org-export-with-footnotes
13206 @vindex org-export-with-latex
13207 @vindex org-export-with-planning
13208 @vindex org-export-with-priority
13209 @vindex org-export-with-section-numbers
13210 @vindex org-export-with-special-strings
13211 @vindex org-export-with-sub-superscripts
13212 @vindex org-export-with-tables
13213 @vindex org-export-with-tags
13214 @vindex org-export-with-tasks
13215 @vindex org-export-with-timestamps
13216 @vindex org-export-with-toc
13217 @vindex org-export-with-todo-keywords
13218 @vindex user-mail-address
13220 @multitable @columnfractions 0.32 0.68
13221 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
13222 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
13223 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
13224 @item @code{:language} @tab @code{org-export-default-language}
13225 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
13226 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
13227 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
13228 @item @code{:select-tags} @tab @code{org-export-select-tags}
13229 @item @code{:with-author} @tab @code{org-export-with-author}
13230 @item @code{:with-creator} @tab @code{org-export-with-creator}
13231 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
13232 @item @code{:with-email} @tab @code{org-export-with-email}
13233 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
13234 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
13235 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
13236 @item @code{:with-latex} @tab @code{org-export-with-latex}
13237 @item @code{:with-planning} @tab @code{org-export-with-planning}
13238 @item @code{:with-priority} @tab @code{org-export-with-priority}
13239 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
13240 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
13241 @item @code{:with-tables} @tab @code{org-export-with-tables}
13242 @item @code{:with-tags} @tab @code{org-export-with-tags}
13243 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
13244 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
13245 @item @code{:with-toc} @tab @code{org-export-with-toc}
13246 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
13249 @vindex org-html-doctype
13250 @vindex org-html-xml-declaration
13251 @vindex org-html-link-up
13252 @vindex org-html-link-home
13253 @vindex org-html-link-org-files-as-html
13254 @vindex org-html-head
13255 @vindex org-html-head-extra
13256 @vindex org-html-inline-images
13257 @vindex org-html-extension
13258 @vindex org-html-preamble
13259 @vindex org-html-postamble
13260 @vindex org-html-table-default-attributes
13261 @vindex org-html-style-include-default
13262 @vindex org-html-style-include-scripts
13263 @multitable @columnfractions 0.32 0.68
13264 @item @code{:html-doctype} @tab @code{org-html-doctype}
13265 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
13266 @item @code{:html-link-up} @tab @code{org-html-link-up}
13267 @item @code{:html-link-home} @tab @code{org-html-link-home}
13268 @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html}
13269 @item @code{:html-head} @tab @code{org-html-head}
13270 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
13271 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
13272 @item @code{:html-extension} @tab @code{org-html-extension}
13273 @item @code{:html-preamble} @tab @code{org-html-preamble}
13274 @item @code{:html-postamble} @tab @code{org-html-postamble}
13275 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
13276 @item @code{:html-head-include-default-style} @tab @code{org-html-style-include-default}
13277 @item @code{:html-head-include-scripts} @tab @code{org-html-style-include-scripts}
13280 Most of the @code{org-export-with-*} variables have the same effect in each
13283 @vindex org-publish-project-alist
13284 When a property is given a value in @code{org-publish-project-alist}, its
13285 setting overrides the value of the corresponding user variable (if any)
13286 during publishing. Options set within a file (@pxref{Export settings}),
13287 however, override everything.
13289 @node Publishing links, Sitemap, Publishing options, Configuration
13290 @subsection Links between published files
13291 @cindex links, publishing
13293 To create a link from one Org file to another, you would use something like
13294 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
13295 (@pxref{Hyperlinks}). When published, this link becomes a link to
13296 @file{foo.html}. You can thus interlink the pages of your "org web" project
13297 and the links will work as expected when you publish them to HTML@. If you
13298 also publish the Org source file and want to link to it, use an @code{http:}
13299 link instead of a @code{file:} link, because @code{file:} links are converted
13300 to link to the corresponding @file{html} file.
13302 You may also link to related files, such as images. Provided you are careful
13303 with relative file names, and provided you have also configured Org to upload
13304 the related files, these links will work too. See @ref{Complex example}, for
13305 an example of this usage.
13307 @node Sitemap, Generating an index, Publishing links, Configuration
13308 @subsection Generating a sitemap
13309 @cindex sitemap, of published pages
13311 The following properties may be used to control publishing of
13312 a map of files for a given project.
13314 @multitable @columnfractions 0.35 0.65
13315 @item @code{:auto-sitemap}
13316 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
13317 or @code{org-publish-all}.
13319 @item @code{:sitemap-filename}
13320 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
13321 becomes @file{sitemap.html}).
13323 @item @code{:sitemap-title}
13324 @tab Title of sitemap page. Defaults to name of file.
13326 @item @code{:sitemap-function}
13327 @tab Plug-in function to use for generation of the sitemap.
13328 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
13329 of links to all files in the project.
13331 @item @code{:sitemap-sort-folders}
13332 @tab Where folders should appear in the sitemap. Set this to @code{first}
13333 (default) or @code{last} to display folders first or last,
13334 respectively. Any other value will mix files and folders.
13336 @item @code{:sitemap-sort-files}
13337 @tab How the files are sorted in the site map. Set this to
13338 @code{alphabetically} (default), @code{chronologically} or
13339 @code{anti-chronologically}. @code{chronologically} sorts the files with
13340 older date first while @code{anti-chronologically} sorts the files with newer
13341 date first. @code{alphabetically} sorts the files alphabetically. The date of
13342 a file is retrieved with @code{org-publish-find-date}.
13344 @item @code{:sitemap-ignore-case}
13345 @tab Should sorting be case-sensitive? Default @code{nil}.
13347 @item @code{:sitemap-file-entry-format}
13348 @tab With this option one can tell how a sitemap's entry is formatted in the
13349 sitemap. This is a format string with some escape sequences: @code{%t} stands
13350 for the title of the file, @code{%a} stands for the author of the file and
13351 @code{%d} stands for the date of the file. The date is retrieved with the
13352 @code{org-publish-find-date} function and formatted with
13353 @code{org-publish-sitemap-date-format}. Default @code{%t}.
13355 @item @code{:sitemap-date-format}
13356 @tab Format string for the @code{format-time-string} function that tells how
13357 a sitemap entry's date is to be formatted. This property bypasses
13358 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
13360 @item @code{:sitemap-sans-extension}
13361 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
13362 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
13363 Defaults to @code{nil}.
13367 @node Generating an index, , Sitemap, Configuration
13368 @subsection Generating an index
13369 @cindex index, in a publishing project
13371 Org mode can generate an index across the files of a publishing project.
13373 @multitable @columnfractions 0.25 0.75
13374 @item @code{:makeindex}
13375 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
13376 publish it as @file{theindex.html}.
13379 The file will be created when first publishing a project with the
13380 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
13381 "theindex.inc"}. You can then build around this include statement by adding
13382 a title, style information, etc.
13384 @node Uploading files, Sample configuration, Configuration, Publishing
13385 @section Uploading files
13389 For those people already utilizing third party sync tools such as
13390 @command{rsync} or @command{unison}, it might be preferable not to use the built in
13391 @i{remote} publishing facilities of Org mode which rely heavily on
13392 Tramp. Tramp, while very useful and powerful, tends not to be
13393 so efficient for multiple file transfer and has been known to cause problems
13396 Specialized synchronization utilities offer several advantages. In addition
13397 to timestamp comparison, they also do content and permissions/attribute
13398 checks. For this reason you might prefer to publish your web to a local
13399 directory (possibly even @i{in place} with your Org files) and then use
13400 @file{unison} or @file{rsync} to do the synchronization with the remote host.
13402 Since Unison (for example) can be configured as to which files to transfer to
13403 a certain remote destination, it can greatly simplify the project publishing
13404 definition. Simply keep all files in the correct location, process your Org
13405 files with @code{org-publish} and let the synchronization tool do the rest.
13406 You do not need, in this scenario, to include attachments such as @file{jpg},
13407 @file{css} or @file{gif} files in the project definition since the 3rd party
13410 Publishing to a local directory is also much faster than to a remote one, so
13411 that you can afford more easily to republish entire projects. If you set
13412 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
13413 benefit of re-including any changed external files such as source example
13414 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
13415 Org is not smart enough to detect if included files have been modified.
13417 @node Sample configuration, Triggering publication, Uploading files, Publishing
13418 @section Sample configuration
13420 Below we provide two example configurations. The first one is a simple
13421 project publishing only a set of Org files. The second example is
13422 more complex, with a multi-component project.
13425 * Simple example:: One-component publishing
13426 * Complex example:: A multi-component publishing example
13429 @node Simple example, Complex example, Sample configuration, Sample configuration
13430 @subsection Example: simple publishing configuration
13432 This example publishes a set of Org files to the @file{public_html}
13433 directory on the local machine.
13436 (setq org-publish-project-alist
13438 :base-directory "~/org/"
13439 :publishing-directory "~/public_html"
13440 :section-numbers nil
13442 :html-head "<link rel=\"stylesheet\"
13443 href=\"../other/mystyle.css\"
13444 type=\"text/css\"/>")))
13447 @node Complex example, , Simple example, Sample configuration
13448 @subsection Example: complex publishing configuration
13450 This more complicated example publishes an entire website, including
13451 Org files converted to HTML, image files, Emacs Lisp source code, and
13452 style sheets. The publishing directory is remote and private files are
13455 To ensure that links are preserved, care should be taken to replicate
13456 your directory structure on the web server, and to use relative file
13457 paths. For example, if your Org files are kept in @file{~/org} and your
13458 publishable images in @file{~/images}, you would link to an image with
13461 file:../images/myimage.png
13464 On the web server, the relative path to the image should be the
13465 same. You can accomplish this by setting up an "images" folder in the
13466 right place on the web server, and publishing images to it.
13469 (setq org-publish-project-alist
13471 :base-directory "~/org/"
13472 :base-extension "org"
13473 :publishing-directory "/ssh:user@@host:~/html/notebook/"
13474 :publishing-function org-html-publish-to-html
13475 :exclude "PrivatePage.org" ;; regexp
13477 :section-numbers nil
13479 :html-head "<link rel=\"stylesheet\"
13480 href=\"../other/mystyle.css\" type=\"text/css\"/>"
13484 :base-directory "~/images/"
13485 :base-extension "jpg\\|gif\\|png"
13486 :publishing-directory "/ssh:user@@host:~/html/images/"
13487 :publishing-function org-publish-attachment)
13490 :base-directory "~/other/"
13491 :base-extension "css\\|el"
13492 :publishing-directory "/ssh:user@@host:~/html/other/"
13493 :publishing-function org-publish-attachment)
13494 ("website" :components ("orgfiles" "images" "other"))))
13497 @node Triggering publication, , Sample configuration, Publishing
13498 @section Triggering publication
13500 Once properly configured, Org can publish with the following commands:
13503 @orgcmd{C-c C-e P x,org-publish}
13504 Prompt for a specific project and publish all files that belong to it.
13505 @orgcmd{C-c C-e P p,org-publish-current-project}
13506 Publish the project containing the current file.
13507 @orgcmd{C-c C-e P f,org-publish-current-file}
13508 Publish only the current file.
13509 @orgcmd{C-c C-e P a,org-publish-all}
13510 Publish every project.
13513 @vindex org-publish-use-timestamps-flag
13514 Org uses timestamps to track when a file has changed. The above functions
13515 normally only publish changed files. You can override this and force
13516 publishing of all files by giving a prefix argument to any of the commands
13517 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
13518 This may be necessary in particular if files include other files via
13519 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
13521 @comment node-name, next, previous, up
13522 @comment Working With Source Code, Miscellaneous, Publishing, Top
13524 @node Working With Source Code, Miscellaneous, Publishing, Top
13525 @chapter Working with source code
13526 @cindex Schulte, Eric
13527 @cindex Davison, Dan
13528 @cindex source code, working with
13530 Source code can be included in Org mode documents using a @samp{src} block,
13534 #+BEGIN_SRC emacs-lisp
13535 (defun org-xor (a b)
13541 Org mode provides a number of features for working with live source code,
13542 including editing of code blocks in their native major-mode, evaluation of
13543 code blocks, converting code blocks into source files (known as @dfn{tangling}
13544 in literate programming), and exporting code blocks and their
13545 results in several formats. This functionality was contributed by Eric
13546 Schulte and Dan Davison, and was originally named Org-babel.
13548 The following sections describe Org mode's code block handling facilities.
13551 * Structure of code blocks:: Code block syntax described
13552 * Editing source code:: Language major-mode editing
13553 * Exporting code blocks:: Export contents and/or results
13554 * Extracting source code:: Create pure source code files
13555 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
13556 * Library of Babel:: Use and contribute to a library of useful code blocks
13557 * Languages:: List of supported code block languages
13558 * Header arguments:: Configure code block functionality
13559 * Results of evaluation:: How evaluation results are handled
13560 * Noweb reference syntax:: Literate programming in Org mode
13561 * Key bindings and useful functions:: Work quickly with code blocks
13562 * Batch execution:: Call functions from the command line
13565 @comment node-name, next, previous, up
13566 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
13568 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
13569 @section Structure of code blocks
13570 @cindex code block, structure
13571 @cindex source code, block structure
13573 @cindex #+BEGIN_SRC
13575 Live code blocks can be specified with a @samp{src} block or
13576 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
13577 @ref{Easy Templates} system} The structure of a @samp{src} block is
13581 #+BEGIN_SRC <language> <switches> <header arguments>
13586 The @code{#+NAME:} line is optional, and can be used to name the code
13587 block. Live code blocks require that a language be specified on the
13588 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
13589 @cindex source code, inline
13591 Live code blocks can also be specified inline using
13594 src_<language>@{<body>@}
13600 src_<language>[<header arguments>]@{<body>@}
13604 @item <#+NAME: name>
13605 This line associates a name with the code block. This is similar to the
13606 @code{#+NAME: Name} lines that can be used to name tables in Org mode
13607 files. Referencing the name of a code block makes it possible to evaluate
13608 the block from other places in the file, from other files, or from Org mode
13609 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
13610 and the behavior of Org mode when two or more blocks share the same name is
13614 The language of the code in the block (see @ref{Languages}).
13615 @cindex source code, language
13617 Optional switches control code block export (see the discussion of switches in
13618 @ref{Literal examples})
13619 @cindex source code, switches
13620 @item <header arguments>
13621 Optional header arguments control many aspects of evaluation, export and
13622 tangling of code blocks (see @ref{Header arguments}).
13623 Header arguments can also be set on a per-buffer or per-subtree
13624 basis using properties.
13625 @item source code, header arguments
13627 Source code in the specified language.
13630 @comment node-name, next, previous, up
13631 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
13633 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
13634 @section Editing source code
13635 @cindex code block, editing
13636 @cindex source code, editing
13638 @vindex org-edit-src-auto-save-idle-delay
13639 @vindex org-edit-src-turn-on-auto-save
13641 Use @kbd{C-c '} to edit the current code block. This brings up a language
13642 major-mode edit buffer containing the body of the code block. Manually
13643 saving this buffer with @key{C-x C-s} will write the contents back to the Org
13644 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
13645 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
13646 to auto-save this buffer into a separate file using @code{auto-save-mode}.
13647 Use @kbd{C-c '} again to exit.
13649 The @code{org-src-mode} minor mode will be active in the edit buffer. The
13650 following variables can be used to configure the behavior of the edit
13651 buffer. See also the customization group @code{org-edit-structure} for
13652 further configuration options.
13655 @item org-src-lang-modes
13656 If an Emacs major-mode named @code{<lang>-mode} exists, where
13657 @code{<lang>} is the language named in the header line of the code block,
13658 then the edit buffer will be placed in that major-mode. This variable
13659 can be used to map arbitrary language names to existing major modes.
13660 @item org-src-window-setup
13661 Controls the way Emacs windows are rearranged when the edit buffer is created.
13662 @item org-src-preserve-indentation
13663 This variable is especially useful for tangling languages such as
13664 Python, in which whitespace indentation in the output is critical.
13665 @item org-src-ask-before-returning-to-edit-buffer
13666 By default, Org will ask before returning to an open edit buffer. Set this
13667 variable to @code{nil} to switch without asking.
13670 To turn on native code fontification in the @emph{Org} buffer, configure the
13671 variable @code{org-src-fontify-natively}.
13673 @comment node-name, next, previous, up
13674 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
13676 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
13677 @section Exporting code blocks
13678 @cindex code block, exporting
13679 @cindex source code, exporting
13681 It is possible to export the @emph{code} of code blocks, the @emph{results}
13682 of code block evaluation, @emph{both} the code and the results of code block
13683 evaluation, or @emph{none}. For most languages, the default exports code.
13684 However, for some languages (e.g., @code{ditaa}) the default exports the
13685 results of code block evaluation. For information on exporting code block
13686 bodies, see @ref{Literal examples}.
13688 The @code{:exports} header argument can be used to specify export
13691 @subsubheading Header arguments:
13694 @item :exports code
13695 The default in most languages. The body of the code block is exported, as
13696 described in @ref{Literal examples}.
13697 @item :exports results
13698 The code block will be evaluated and the results will be placed in the
13699 Org mode buffer for export, either updating previous results of the code
13700 block located anywhere in the buffer or, if no previous results exist,
13701 placing the results immediately after the code block. The body of the code
13702 block will not be exported.
13703 @item :exports both
13704 Both the code block and its results will be exported.
13705 @item :exports none
13706 Neither the code block nor its results will be exported.
13709 It is possible to inhibit the evaluation of code blocks during export.
13710 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
13711 ensure that no code blocks are evaluated as part of the export process. This
13712 can be useful in situations where potentially untrusted Org mode files are
13713 exported in an automated fashion, for example when Org mode is used as the
13714 markup language for a wiki. It is also possible to set this variable to
13715 @code{‘inline-only}. In that case, only inline code blocks will be
13716 evaluated, in order to insert their results. Non-inline code blocks are
13717 assumed to have their results already inserted in the buffer by manual
13718 evaluation. This setting is useful to avoid expensive recalculations during
13719 export, not to provide security.
13721 @comment node-name, next, previous, up
13722 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
13723 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
13724 @section Extracting source code
13726 @cindex source code, extracting
13727 @cindex code block, extracting source code
13729 Creating pure source code files by extracting code from source blocks is
13730 referred to as ``tangling''---a term adopted from the literate programming
13731 community. During ``tangling'' of code blocks their bodies are expanded
13732 using @code{org-babel-expand-src-block} which can expand both variable and
13733 ``noweb'' style references (see @ref{Noweb reference syntax}).
13735 @subsubheading Header arguments
13739 The default. The code block is not included in the tangled output.
13741 Include the code block in the tangled output. The output file name is the
13742 name of the org file with the extension @samp{.org} replaced by the extension
13743 for the block language.
13744 @item :tangle filename
13745 Include the code block in the tangled output to file @samp{filename}.
13749 @subsubheading Functions
13752 @item org-babel-tangle
13753 Tangle the current file. Bound to @kbd{C-c C-v t}.
13755 With prefix argument only tangle the current code block.
13756 @item org-babel-tangle-file
13757 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
13760 @subsubheading Hooks
13763 @item org-babel-post-tangle-hook
13764 This hook is run from within code files tangled by @code{org-babel-tangle}.
13765 Example applications could include post-processing, compilation or evaluation
13766 of tangled code files.
13769 @subsubheading Jumping between code and Org
13771 When tangling code from an Org-mode buffer to a source code file, you'll
13772 frequently find yourself viewing the file of tangled source code (e.g., many
13773 debuggers point to lines of the source code file). It is useful to be able
13774 to navigate from the tangled source to the Org-mode buffer from which the
13777 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
13778 code to Org-mode functionality. Two header arguments are required for
13779 jumping to work, first the @code{padline} (@ref{padline}) option must be set
13780 to true (the default setting), second the @code{comments} (@ref{comments})
13781 header argument must be set to @code{links}, which will insert comments into
13782 the source code buffer which point back to the original Org-mode file.
13784 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
13785 @section Evaluating code blocks
13786 @cindex code block, evaluating
13787 @cindex source code, evaluating
13790 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
13791 potential for that code to do harm. Org mode provides safeguards to ensure
13792 that code is only evaluated after explicit confirmation from the user. For
13793 information on these safeguards (and on how to disable them) see @ref{Code
13794 evaluation security}.} and the results of evaluation optionally placed in the
13795 Org mode buffer. The results of evaluation are placed following a line that
13796 begins by default with @code{#+RESULTS} and optionally a cache identifier
13797 and/or the name of the evaluated code block. The default value of
13798 @code{#+RESULTS} can be changed with the customizable variable
13799 @code{org-babel-results-keyword}.
13801 By default, the evaluation facility is only enabled for Lisp code blocks
13802 specified as @code{emacs-lisp}. However, source code blocks in many languages
13803 can be evaluated within Org mode (see @ref{Languages} for a list of supported
13804 languages and @ref{Structure of code blocks} for information on the syntax
13805 used to define a code block).
13808 There are a number of ways to evaluate code blocks. The simplest is to press
13809 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
13810 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
13811 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
13812 @code{org-babel-execute-src-block} function to evaluate the block and insert
13813 its results into the Org mode buffer.
13816 It is also possible to evaluate named code blocks from anywhere in an Org
13817 mode buffer or an Org mode table. Live code blocks located in the current
13818 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
13819 can be executed. Named code blocks can be executed with a separate
13820 @code{#+CALL:} line or inline within a block of text.
13822 The syntax of the @code{#+CALL:} line is
13825 #+CALL: <name>(<arguments>)
13826 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
13829 The syntax for inline evaluation of named code blocks is
13832 ... call_<name>(<arguments>) ...
13833 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
13838 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
13840 Arguments specified in this section will be passed to the code block. These
13841 arguments use standard function call syntax, rather than
13842 header argument syntax. For example, a @code{#+CALL:} line that passes the
13843 number four to a code block named @code{double}, which declares the header
13844 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
13845 @item <inside header arguments>
13846 Inside header arguments are passed through and applied to the named code
13847 block. These arguments use header argument syntax rather than standard
13848 function call syntax. Inside header arguments affect how the code block is
13849 evaluated. For example, @code{[:results output]} will collect the results of
13850 everything printed to @code{STDOUT} during execution of the code block.
13851 @item <end header arguments>
13852 End header arguments are applied to the calling instance and do not affect
13853 evaluation of the named code block. They affect how the results are
13854 incorporated into the Org mode buffer and how the call line is exported. For
13855 example, @code{:results html} will insert the results of the call line
13856 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
13858 For more examples of passing header arguments to @code{#+CALL:} lines see
13859 @ref{Header arguments in function calls}.
13862 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
13863 @section Library of Babel
13864 @cindex babel, library of
13865 @cindex source code, library
13866 @cindex code block, library
13868 The ``Library of Babel'' consists of code blocks that can be called from any
13869 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
13870 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
13871 code blocks} for information on the syntax of remote code block evaluation).
13874 The central repository of code blocks in the ``Library of Babel'' is housed
13875 in an Org mode file located in the @samp{contrib} directory of Org mode.
13877 Users can add code blocks they believe to be generally useful to their
13878 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
13879 then loaded into the library with @code{org-babel-lob-ingest}.
13883 Code blocks located in any Org mode file can be loaded into the ``Library of
13884 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
13887 @node Languages, Header arguments, Library of Babel, Working With Source Code
13889 @cindex babel, languages
13890 @cindex source code, languages
13891 @cindex code block, languages
13893 Code blocks in the following languages are supported.
13895 @multitable @columnfractions 0.28 0.3 0.22 0.2
13896 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
13897 @item Asymptote @tab asymptote @tab Awk @tab awk
13898 @item Emacs Calc @tab calc @tab C @tab C
13899 @item C++ @tab C++ @tab Clojure @tab clojure
13900 @item CSS @tab css @tab ditaa @tab ditaa
13901 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
13902 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
13903 @item Java @tab java @tab @tab
13904 @item Javascript @tab js @tab LaTeX @tab latex
13905 @item Ledger @tab ledger @tab Lisp @tab lisp
13906 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
13907 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
13908 @item Octave @tab octave @tab Org mode @tab org
13909 @item Oz @tab oz @tab Perl @tab perl
13910 @item Plantuml @tab plantuml @tab Python @tab python
13911 @item R @tab R @tab Ruby @tab ruby
13912 @item Sass @tab sass @tab Scheme @tab scheme
13913 @item GNU Screen @tab screen @tab shell @tab sh
13914 @item SQL @tab sql @tab SQLite @tab sqlite
13917 Language-specific documentation is available for some languages. If
13918 available, it can be found at
13919 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
13921 The option @code{org-babel-load-languages} controls which languages are
13922 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
13923 variable can be set using the customization interface or by adding code like
13924 the following to your emacs configuration.
13927 The following disables @code{emacs-lisp} evaluation and enables evaluation of
13928 @code{R} code blocks.
13932 (org-babel-do-load-languages
13933 'org-babel-load-languages
13934 '((emacs-lisp . nil)
13938 It is also possible to enable support for a language by loading the related
13939 elisp file with @code{require}.
13942 The following adds support for evaluating @code{clojure} code blocks.
13946 (require 'ob-clojure)
13949 @node Header arguments, Results of evaluation, Languages, Working With Source Code
13950 @section Header arguments
13951 @cindex code block, header arguments
13952 @cindex source code, block header arguments
13954 Code block functionality can be configured with header arguments. This
13955 section provides an overview of the use of header arguments, and then
13956 describes each header argument in detail.
13959 * Using header arguments:: Different ways to set header arguments
13960 * Specific header arguments:: List of header arguments
13963 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
13964 @subsection Using header arguments
13966 The values of header arguments can be set in six different ways, each more
13967 specific (and having higher priority) than the last.
13969 * System-wide header arguments:: Set global default values
13970 * Language-specific header arguments:: Set default values by language
13971 * Buffer-wide header arguments:: Set default values for a specific buffer
13972 * Header arguments in Org mode properties:: Set default values for a buffer or heading
13973 * Code block specific header arguments:: The most common way to set values
13974 * Header arguments in function calls:: The most specific level
13978 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
13979 @subsubheading System-wide header arguments
13980 @vindex org-babel-default-header-args
13981 System-wide values of header arguments can be specified by adapting the
13982 @code{org-babel-default-header-args} variable:
13986 :results => "replace"
13992 For example, the following example could be used to set the default value of
13993 @code{:noweb} header arguments to @code{yes}. This would have the effect of
13994 expanding @code{:noweb} references by default when evaluating source code
13998 (setq org-babel-default-header-args
13999 (cons '(:noweb . "yes")
14000 (assq-delete-all :noweb org-babel-default-header-args)))
14003 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
14004 @subsubheading Language-specific header arguments
14005 Each language can define its own set of default header arguments. See the
14006 language-specific documentation available online at
14007 @uref{http://orgmode.org/worg/org-contrib/babel}.
14009 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
14010 @subsubheading Buffer-wide header arguments
14011 Buffer-wide header arguments may be specified as properties through the use
14012 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14013 @ref{Property syntax}).
14015 For example the following would set @code{session} to @code{*R*}, and
14016 @code{results} to @code{silent} for every code block in the buffer, ensuring
14017 that all execution took place in the same session, and no results would be
14018 inserted into the buffer.
14021 #+PROPERTY: session *R*
14022 #+PROPERTY: results silent
14025 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
14026 @subsubheading Header arguments in Org mode properties
14028 Header arguments are also read from Org mode properties (see @ref{Property
14029 syntax}), which can be set on a buffer-wide or per-heading basis. An example
14030 of setting a header argument for all code blocks in a buffer is
14033 #+PROPERTY: tangle yes
14036 @vindex org-use-property-inheritance
14037 When properties are used to set default header arguments, they are looked up
14038 with inheritance, regardless of the value of
14039 @code{org-use-property-inheritance}. In the following example the value of
14040 the @code{:cache} header argument will default to @code{yes} in all code
14041 blocks in the subtree rooted at the following heading:
14051 @vindex org-babel-default-header-args
14052 Properties defined in this way override the properties set in
14053 @code{org-babel-default-header-args}. It is convenient to use the
14054 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
14055 in Org mode documents.
14057 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
14058 @subsubheading Code block specific header arguments
14060 The most common way to assign values to header arguments is at the
14061 code block level. This can be done by listing a sequence of header
14062 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14063 Properties set in this way override both the values of
14064 @code{org-babel-default-header-args} and header arguments specified as
14065 properties. In the following example, the @code{:results} header argument
14066 is set to @code{silent}, meaning the results of execution will not be
14067 inserted in the buffer, and the @code{:exports} header argument is set to
14068 @code{code}, meaning only the body of the code block will be
14069 preserved on export to HTML or @LaTeX{}.
14073 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14075 fac n = n * fac (n-1)
14078 Similarly, it is possible to set header arguments for inline code blocks
14081 src_haskell[:exports both]@{fac 5@}
14084 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14085 @code{#+HEADERS:} lines preceding a code block or nested between the
14086 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14090 Multi-line header arguments on an un-named code block:
14093 #+HEADERS: :var data1=1
14094 #+BEGIN_SRC emacs-lisp :var data2=2
14095 (message "data1:%S, data2:%S" data1 data2)
14102 Multi-line header arguments on a named code block:
14105 #+NAME: named-block
14106 #+HEADER: :var data=2
14107 #+BEGIN_SRC emacs-lisp
14108 (message "data:%S" data)
14111 #+RESULTS: named-block
14115 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
14116 @comment node-name, next, previous, up
14117 @subsubheading Header arguments in function calls
14119 At the most specific level, header arguments for ``Library of Babel'' or
14120 @code{#+CALL:} lines can be set as shown in the two examples below. For more
14121 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14124 The following will apply the @code{:exports results} header argument to the
14125 evaluation of the @code{#+CALL:} line.
14128 #+CALL: factorial(n=5) :exports results
14131 The following will apply the @code{:session special} header argument to the
14132 evaluation of the @code{factorial} code block.
14135 #+CALL: factorial[:session special](n=5)
14138 @node Specific header arguments, , Using header arguments, Header arguments
14139 @subsection Specific header arguments
14140 Header arguments consist of an initial colon followed by the name of the
14141 argument in lowercase letters. The following header arguments are defined:
14144 * var:: Pass arguments to code blocks
14145 * results:: Specify the type of results and how they will
14146 be collected and handled
14147 * file:: Specify a path for file output
14148 * file-desc:: Specify a description for file results
14149 * dir:: Specify the default (possibly remote)
14150 directory for code block execution
14151 * exports:: Export code and/or results
14152 * tangle:: Toggle tangling and specify file name
14153 * mkdirp:: Toggle creation of parent directories of target
14154 files during tangling
14155 * comments:: Toggle insertion of comments in tangled
14157 * padline:: Control insertion of padding lines in tangled
14159 * no-expand:: Turn off variable assignment and noweb
14160 expansion during tangling
14161 * session:: Preserve the state of code evaluation
14162 * noweb:: Toggle expansion of noweb references
14163 * noweb-ref:: Specify block's noweb reference resolution target
14164 * noweb-sep:: String used to separate noweb references
14165 * cache:: Avoid re-evaluating unchanged code blocks
14166 * sep:: Delimiter for writing tabular results outside Org
14167 * hlines:: Handle horizontal lines in tables
14168 * colnames:: Handle column names in tables
14169 * rownames:: Handle row names in tables
14170 * shebang:: Make tangled files executable
14171 * tangle-mode:: Set permission of tangled files
14172 * eval:: Limit evaluation of specific code blocks
14173 * wrap:: Mark source block evaluation results
14174 * post:: Post processing of code block results
14177 Additional header arguments are defined on a language-specific basis, see
14180 @node var, results, Specific header arguments, Specific header arguments
14181 @subsubsection @code{:var}
14182 The @code{:var} header argument is used to pass arguments to code blocks.
14183 The specifics of how arguments are included in a code block vary by language;
14184 these are addressed in the language-specific documentation. However, the
14185 syntax used to specify arguments is the same across all languages. In every
14186 case, variables require a default value when they are declared.
14188 The values passed to arguments can either be literal values, references, or
14189 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
14190 References include anything in the Org mode file that takes a @code{#+NAME:}
14191 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
14192 other code blocks and the results of other code blocks.
14194 Note: When a reference is made to another code block, the referenced block
14195 will be evaluated unless it has current cached results (see @ref{cache}).
14197 Argument values can be indexed in a manner similar to arrays (see @ref{var,
14198 Indexable variable values}).
14200 The following syntax is used to pass arguments to code blocks using the
14201 @code{:var} header argument.
14207 The argument, @code{assign}, can either be a literal value, such as a string
14208 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
14209 literal example, another code block (with or without arguments), or the
14210 results of evaluating another code block.
14212 Here are examples of passing values by reference:
14217 an Org mode table named with either a @code{#+NAME:} line
14220 #+NAME: example-table
14226 #+NAME: table-length
14227 #+BEGIN_SRC emacs-lisp :var table=example-table
14231 #+RESULTS: table-length
14236 a simple list named with a @code{#+NAME:} line (note that nesting is not
14237 carried through to the source code block)
14240 #+NAME: example-list
14246 #+BEGIN_SRC emacs-lisp :var x=example-list
14254 @item code block without arguments
14255 a code block name (from the example above), as assigned by @code{#+NAME:},
14256 optionally followed by parentheses
14259 #+BEGIN_SRC emacs-lisp :var length=table-length()
14267 @item code block with arguments
14268 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
14269 optional arguments passed within the parentheses following the
14270 code block name using standard function call syntax
14274 #+BEGIN_SRC emacs-lisp :var input=8
14282 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
14290 @item literal example
14291 a literal example block named with a @code{#+NAME:} line
14294 #+NAME: literal-example
14300 #+NAME: read-literal-example
14301 #+BEGIN_SRC emacs-lisp :var x=literal-example
14302 (concatenate 'string x " for you.")
14305 #+RESULTS: read-literal-example
14306 : A literal example
14307 : on two lines for you.
14313 @subsubheading Indexable variable values
14314 It is possible to reference portions of variable values by ``indexing'' into
14315 the variables. Indexes are 0 based with negative values counting back from
14316 the end. If an index is separated by @code{,}s then each subsequent section
14317 will index into the next deepest nesting or dimension of the value. Note
14318 that this indexing occurs @emph{before} other table related header arguments
14319 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
14320 following example assigns the last cell of the first row the table
14321 @code{example-table} to the variable @code{data}:
14324 #+NAME: example-table
14330 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
14338 Ranges of variable values can be referenced using two integers separated by a
14339 @code{:}, in which case the entire inclusive range is referenced. For
14340 example the following assigns the middle three rows of @code{example-table}
14344 #+NAME: example-table
14351 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
14361 Additionally, an empty index, or the single character @code{*}, are both
14362 interpreted to mean the entire range and as such are equivalent to
14363 @code{0:-1}, as shown in the following example in which the entire first
14364 column is referenced.
14367 #+NAME: example-table
14373 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
14381 It is possible to index into the results of code blocks as well as tables.
14382 Any number of dimensions can be indexed. Dimensions are separated from one
14383 another by commas, as shown in the following example.
14387 #+BEGIN_SRC emacs-lisp
14388 '(((1 2 3) (4 5 6) (7 8 9))
14389 ((10 11 12) (13 14 15) (16 17 18))
14390 ((19 20 21) (22 23 24) (25 26 27)))
14393 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
14401 @subsubheading Emacs Lisp evaluation of variables
14403 Emacs lisp code can be used to initialize variable values. When a variable
14404 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
14405 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
14406 the variable value. The following example demonstrates use of this
14407 evaluation to reliably pass the file-name of the Org mode buffer to a code
14408 block---note that evaluation of header arguments is guaranteed to take place
14409 in the original Org mode file, while there is no such guarantee for
14410 evaluation of the code block body.
14413 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
14418 Note that values read from tables and lists will not be evaluated as
14419 Emacs Lisp, as shown in the following example.
14425 #+HEADERS: :var data=table[0,0]
14434 @node results, file, var, Specific header arguments
14435 @subsubsection @code{:results}
14437 There are four classes of @code{:results} header argument. Only one option
14438 per class may be supplied per code block.
14442 @b{collection} header arguments specify how the results should be collected
14443 from the code block
14445 @b{type} header arguments specify what type of result the code block will
14446 return---which has implications for how they will be processed before
14447 insertion into the Org mode buffer
14449 @b{format} header arguments specify what type of result the code block will
14450 return---which has implications for how they will be inserted into the
14453 @b{handling} header arguments specify how the results of evaluating the code
14454 block should be handled.
14457 @subsubheading Collection
14458 The following options are mutually exclusive, and specify how the results
14459 should be collected from the code block.
14463 This is the default. The result is the value of the last statement in the
14464 code block. This header argument places the evaluation in functional
14465 mode. Note that in some languages, e.g., Python, use of this result type
14466 requires that a @code{return} statement be included in the body of the source
14467 code block. E.g., @code{:results value}.
14468 @item @code{output}
14469 The result is the collection of everything printed to STDOUT during the
14470 execution of the code block. This header argument places the
14471 evaluation in scripting mode. E.g., @code{:results output}.
14474 @subsubheading Type
14476 The following options are mutually exclusive and specify what type of results
14477 the code block will return. By default, results are inserted as either a
14478 table or scalar depending on their value.
14481 @item @code{table}, @code{vector}
14482 The results should be interpreted as an Org mode table. If a single value is
14483 returned, it will be converted into a table with one row and one column.
14484 E.g., @code{:results value table}.
14486 The results should be interpreted as an Org mode list. If a single scalar
14487 value is returned it will be converted into a list with only one element.
14488 @item @code{scalar}, @code{verbatim}
14489 The results should be interpreted literally---they will not be
14490 converted into a table. The results will be inserted into the Org mode
14491 buffer as quoted text. E.g., @code{:results value verbatim}.
14493 The results will be interpreted as the path to a file, and will be inserted
14494 into the Org mode buffer as a file link. E.g., @code{:results value file}.
14497 @subsubheading Format
14499 The following options are mutually exclusive and specify what type of results
14500 the code block will return. By default, results are inserted according to the
14501 type as specified above.
14505 The results are interpreted as raw Org mode code and are inserted directly
14506 into the buffer. If the results look like a table they will be aligned as
14507 such by Org mode. E.g., @code{:results value raw}.
14509 The results are will be enclosed in a @code{BEGIN_SRC org} block.
14510 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
14511 in the block and/or if you export the file. E.g., @code{:results value org}.
14513 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
14514 block. E.g., @code{:results value html}.
14516 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
14517 E.g., @code{:results value latex}.
14519 Result are assumed to be parsable code and are enclosed in a code block.
14520 E.g., @code{:results value code}.
14522 The result is converted to pretty-printed code and is enclosed in a code
14523 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
14524 @code{:results value pp}.
14525 @item @code{drawer}
14526 The result is wrapped in a RESULTS drawer. This can be useful for
14527 inserting @code{raw} or @code{org} syntax results in such a way that their
14528 extent is known and they can be automatically removed or replaced.
14531 @subsubheading Handling
14532 The following results options indicate what happens with the
14533 results once they are collected.
14536 @item @code{silent}
14537 The results will be echoed in the minibuffer but will not be inserted into
14538 the Org mode buffer. E.g., @code{:results output silent}.
14539 @item @code{replace}
14540 The default value. Any existing results will be removed, and the new results
14541 will be inserted into the Org mode buffer in their place. E.g.,
14542 @code{:results output replace}.
14543 @item @code{append}
14544 If there are pre-existing results of the code block then the new results will
14545 be appended to the existing results. Otherwise the new results will be
14546 inserted as with @code{replace}.
14547 @item @code{prepend}
14548 If there are pre-existing results of the code block then the new results will
14549 be prepended to the existing results. Otherwise the new results will be
14550 inserted as with @code{replace}.
14553 @node file, file-desc, results, Specific header arguments
14554 @subsubsection @code{:file}
14556 The header argument @code{:file} is used to specify an external file in which
14557 to save code block results. After code block evaluation an Org mode style
14558 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
14559 into the Org mode buffer. Some languages including R, gnuplot, dot, and
14560 ditaa provide special handling of the @code{:file} header argument
14561 automatically wrapping the code block body in the boilerplate code required
14562 to save output to the specified file. This is often useful for saving
14563 graphical output of a code block to the specified file.
14565 The argument to @code{:file} should be either a string specifying the path to
14566 a file, or a list of two strings in which case the first element of the list
14567 should be the path to a file and the second a description for the link.
14569 @node file-desc, dir, file, Specific header arguments
14570 @subsubsection @code{:file-desc}
14572 The value of the @code{:file-desc} header argument is used to provide a
14573 description for file code block results which are inserted as Org mode links
14574 (see @ref{Link format}). If the @code{:file-desc} header argument is given
14575 with no value the link path will be placed in both the ``link'' and the
14576 ``description'' portion of the Org mode link.
14578 @node dir, exports, file-desc, Specific header arguments
14579 @subsubsection @code{:dir} and remote execution
14581 While the @code{:file} header argument can be used to specify the path to the
14582 output file, @code{:dir} specifies the default directory during code block
14583 execution. If it is absent, then the directory associated with the current
14584 buffer is used. In other words, supplying @code{:dir path} temporarily has
14585 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
14586 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
14587 the value of the Emacs variable @code{default-directory}.
14589 When using @code{:dir}, you should supply a relative path for file output
14590 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
14591 case that path will be interpreted relative to the default directory.
14593 In other words, if you want your plot to go into a folder called @file{Work}
14594 in your home directory, you could use
14597 #+BEGIN_SRC R :file myplot.png :dir ~/Work
14598 matplot(matrix(rnorm(100), 10), type="l")
14602 @subsubheading Remote execution
14603 A directory on a remote machine can be specified using tramp file syntax, in
14604 which case the code will be evaluated on the remote machine. An example is
14607 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
14608 plot(1:10, main=system("hostname", intern=TRUE))
14612 Text results will be returned to the local Org mode buffer as usual, and file
14613 output will be created on the remote machine with relative paths interpreted
14614 relative to the remote directory. An Org mode link to the remote file will be
14617 So, in the above example a plot will be created on the remote machine,
14618 and a link of the following form will be inserted in the org buffer:
14621 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
14624 Most of this functionality follows immediately from the fact that @code{:dir}
14625 sets the value of the Emacs variable @code{default-directory}, thanks to
14626 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
14627 install tramp separately in order for these features to work correctly.
14629 @subsubheading Further points
14633 If @code{:dir} is used in conjunction with @code{:session}, although it will
14634 determine the starting directory for a new session as expected, no attempt is
14635 currently made to alter the directory associated with an existing session.
14637 @code{:dir} should typically not be used to create files during export with
14638 @code{:exports results} or @code{:exports both}. The reason is that, in order
14639 to retain portability of exported material between machines, during export
14640 links inserted into the buffer will @emph{not} be expanded against @code{default
14641 directory}. Therefore, if @code{default-directory} is altered using
14642 @code{:dir}, it is probable that the file will be created in a location to
14643 which the link does not point.
14646 @node exports, tangle, dir, Specific header arguments
14647 @subsubsection @code{:exports}
14649 The @code{:exports} header argument specifies what should be included in HTML
14650 or @LaTeX{} exports of the Org mode file.
14654 The default. The body of code is included into the exported file. E.g.,
14655 @code{:exports code}.
14656 @item @code{results}
14657 The result of evaluating the code is included in the exported file. E.g.,
14658 @code{:exports results}.
14660 Both the code and results are included in the exported file. E.g.,
14661 @code{:exports both}.
14663 Nothing is included in the exported file. E.g., @code{:exports none}.
14666 @node tangle, mkdirp, exports, Specific header arguments
14667 @subsubsection @code{:tangle}
14669 The @code{:tangle} header argument specifies whether or not the code
14670 block should be included in tangled extraction of source code files.
14673 @item @code{tangle}
14674 The code block is exported to a source code file named after the full path
14675 (including the directory) and file name (w/o extension) of the Org mode file.
14676 E.g., @code{:tangle yes}.
14678 The default. The code block is not exported to a source code file.
14679 E.g., @code{:tangle no}.
14681 Any other string passed to the @code{:tangle} header argument is interpreted
14682 as a path (directory and file name relative to the directory of the Org mode
14683 file) to which the block will be exported. E.g., @code{:tangle path}.
14686 @node mkdirp, comments, tangle, Specific header arguments
14687 @subsubsection @code{:mkdirp}
14689 The @code{:mkdirp} header argument can be used to create parent directories
14690 of tangled files when missing. This can be set to @code{yes} to enable
14691 directory creation or to @code{no} to inhibit directory creation.
14693 @node comments, padline, mkdirp, Specific header arguments
14694 @subsubsection @code{:comments}
14695 By default code blocks are tangled to source-code files without any insertion
14696 of comments beyond those which may already exist in the body of the code
14697 block. The @code{:comments} header argument can be set as follows to control
14698 the insertion of extra comments into the tangled code file.
14702 The default. No extra comments are inserted during tangling.
14704 The code block is wrapped in comments which contain pointers back to the
14705 original Org file from which the code was tangled.
14707 A synonym for ``link'' to maintain backwards compatibility.
14709 Include text from the Org mode file as a comment.
14710 The text is picked from the leading context of the tangled code and is
14711 limited by the nearest headline or source block as the case may be.
14713 Turns on both the ``link'' and ``org'' comment options.
14715 Turns on the ``link'' comment option, and additionally wraps expanded noweb
14716 references in the code block body in link comments.
14719 @node padline, no-expand, comments, Specific header arguments
14720 @subsubsection @code{:padline}
14721 Control in insertion of padding lines around code block bodies in tangled
14722 code files. The default value is @code{yes} which results in insertion of
14723 newlines before and after each tangled code block. The following arguments
14728 Insert newlines before and after each code block body in tangled code files.
14730 Do not insert any newline padding in tangled output.
14733 @node no-expand, session, padline, Specific header arguments
14734 @subsubsection @code{:no-expand}
14736 By default, code blocks are expanded with @code{org-babel-expand-src-block}
14737 during tangling. This has the effect of assigning values to variables
14738 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
14739 references (see @ref{Noweb reference syntax}) with their targets. The
14740 @code{:no-expand} header argument can be used to turn off this behavior.
14742 @node session, noweb, no-expand, Specific header arguments
14743 @subsubsection @code{:session}
14745 The @code{:session} header argument starts a session for an interpreted
14746 language where state is preserved.
14748 By default, a session is not started.
14750 A string passed to the @code{:session} header argument will give the session
14751 a name. This makes it possible to run concurrent sessions for each
14752 interpreted language.
14754 @node noweb, noweb-ref, session, Specific header arguments
14755 @subsubsection @code{:noweb}
14757 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
14758 references (see @ref{Noweb reference syntax}) when the code block is
14759 evaluated, tangled, or exported. The @code{:noweb} header argument can have
14760 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
14761 @code{no-export} @code{strip-export}.
14765 The default. ``Noweb'' syntax references in the body of the code block will
14766 not be expanded before the code block is evaluated, tangled or exported.
14768 ``Noweb'' syntax references in the body of the code block will be
14769 expanded before the code block is evaluated, tangled or exported.
14770 @item @code{tangle}
14771 ``Noweb'' syntax references in the body of the code block will be expanded
14772 before the code block is tangled. However, ``noweb'' syntax references will
14773 not be expanded when the code block is evaluated or exported.
14774 @item @code{no-export}
14775 ``Noweb'' syntax references in the body of the code block will be expanded
14776 before the block is evaluated or tangled. However, ``noweb'' syntax
14777 references will not be expanded when the code block is exported.
14778 @item @code{strip-export}
14779 ``Noweb'' syntax references in the body of the code block will be expanded
14780 before the block is evaluated or tangled. However, ``noweb'' syntax
14781 references will not be removed when the code block is exported.
14783 ``Noweb'' syntax references in the body of the code block will only be
14784 expanded before the block is evaluated.
14787 @subsubheading Noweb prefix lines
14788 Noweb insertions are now placed behind the line prefix of the
14789 @code{<<reference>>}.
14790 This behavior is illustrated in the following example. Because the
14791 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
14792 each line of the expanded noweb reference will be commented.
14804 -- multi-line body of example
14807 Note that noweb replacement text that does not contain any newlines will not
14808 be affected by this change, so it is still possible to use inline noweb
14811 @node noweb-ref, noweb-sep, noweb, Specific header arguments
14812 @subsubsection @code{:noweb-ref}
14813 When expanding ``noweb'' style references the bodies of all code block with
14814 @emph{either} a block name matching the reference name @emph{or} a
14815 @code{:noweb-ref} header argument matching the reference name will be
14816 concatenated together to form the replacement text.
14818 By setting this header argument at the sub-tree or file level, simple code
14819 block concatenation may be achieved. For example, when tangling the
14820 following Org mode file, the bodies of code blocks will be concatenated into
14821 the resulting pure code file@footnote{(The example needs property inheritance
14822 to be turned on for the @code{noweb-ref} property, see @ref{Property
14826 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
14829 * the mount point of the fullest disk
14831 :noweb-ref: fullest-disk
14834 ** query all mounted disks
14839 ** strip the header row
14844 ** sort by the percent full
14846 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
14849 ** extract the mount point
14851 |awk '@{print $2@}'
14855 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
14856 used to separate accumulate noweb references like those above. By default a
14859 @node noweb-sep, cache, noweb-ref, Specific header arguments
14860 @subsubsection @code{:noweb-sep}
14862 The @code{:noweb-sep} header argument holds the string used to separate
14863 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
14866 @node cache, sep, noweb-sep, Specific header arguments
14867 @subsubsection @code{:cache}
14869 The @code{:cache} header argument controls the use of in-buffer caching of
14870 the results of evaluating code blocks. It can be used to avoid re-evaluating
14871 unchanged code blocks. Note that the @code{:cache} header argument will not
14872 attempt to cache results when the @code{:session} header argument is used,
14873 because the results of the code block execution may be stored in the session
14874 outside of the Org mode buffer. The @code{:cache} header argument can have
14875 one of two values: @code{yes} or @code{no}.
14879 The default. No caching takes place, and the code block will be evaluated
14880 every time it is called.
14882 Every time the code block is run a SHA1 hash of the code and arguments
14883 passed to the block will be generated. This hash is packed into the
14884 @code{#+RESULTS:} line and will be checked on subsequent
14885 executions of the code block. If the code block has not
14886 changed since the last time it was evaluated, it will not be re-evaluated.
14889 Code block caches notice if the value of a variable argument
14890 to the code block has changed. If this is the case, the cache is
14891 invalidated and the code block is re-run. In the following example,
14892 @code{caller} will not be re-run unless the results of @code{random} have
14893 changed since it was last run.
14897 #+BEGIN_SRC R :cache yes
14901 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
14905 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
14909 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
14913 @node sep, hlines, cache, Specific header arguments
14914 @subsubsection @code{:sep}
14916 The @code{:sep} header argument can be used to control the delimiter used
14917 when writing tabular results out to files external to Org mode. This is used
14918 either when opening tabular results of a code block by calling the
14919 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
14920 or when writing code block results to an external file (see @ref{file})
14923 By default, when @code{:sep} is not specified output tables are tab
14926 @node hlines, colnames, sep, Specific header arguments
14927 @subsubsection @code{:hlines}
14929 Tables are frequently represented with one or more horizontal lines, or
14930 hlines. The @code{:hlines} argument to a code block accepts the
14931 values @code{yes} or @code{no}, with a default value of @code{no}.
14935 Strips horizontal lines from the input table. In most languages this is the
14936 desired effect because an @code{hline} symbol is interpreted as an unbound
14937 variable and raises an error. Setting @code{:hlines no} or relying on the
14938 default value yields the following results.
14949 #+BEGIN_SRC python :var tab=many-cols
14953 #+RESULTS: echo-table
14960 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
14971 #+BEGIN_SRC python :var tab=many-cols :hlines yes
14975 #+RESULTS: echo-table
14984 @node colnames, rownames, hlines, Specific header arguments
14985 @subsubsection @code{:colnames}
14987 The @code{:colnames} header argument accepts the values @code{yes},
14988 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
14989 Note that the behavior of the @code{:colnames} header argument may differ
14994 If an input table looks like it has column names
14995 (because its second row is an hline), then the column
14996 names will be removed from the table before
14997 processing, then reapplied to the results.
15006 #+NAME: echo-table-again
15007 #+BEGIN_SRC python :var tab=less-cols
15008 return [[val + '*' for val in row] for row in tab]
15011 #+RESULTS: echo-table-again
15018 Please note that column names are not removed before the table is indexed
15019 using variable indexing @xref{var, Indexable variable values}.
15022 No column name pre-processing takes place
15025 Column names are removed and reapplied as with @code{nil} even if the table
15026 does not ``look like'' it has column names (i.e., the second row is not an
15030 @node rownames, shebang, colnames, Specific header arguments
15031 @subsubsection @code{:rownames}
15033 The @code{:rownames} header argument can take on the values @code{yes} or
15034 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
15035 blocks ignore the @code{:rownames} header argument entirely given the ease
15036 with which tables with row names may be handled directly in Emacs Lisp.
15040 No row name pre-processing will take place.
15043 The first column of the table is removed from the table before processing,
15044 and is then reapplied to the results.
15047 #+NAME: with-rownames
15048 | one | 1 | 2 | 3 | 4 | 5 |
15049 | two | 6 | 7 | 8 | 9 | 10 |
15051 #+NAME: echo-table-once-again
15052 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15053 return [[val + 10 for val in row] for row in tab]
15056 #+RESULTS: echo-table-once-again
15057 | one | 11 | 12 | 13 | 14 | 15 |
15058 | two | 16 | 17 | 18 | 19 | 20 |
15061 Please note that row names are not removed before the table is indexed using
15062 variable indexing @xref{var, Indexable variable values}.
15066 @node shebang, tangle-mode, rownames, Specific header arguments
15067 @subsubsection @code{:shebang}
15069 Setting the @code{:shebang} header argument to a string value
15070 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15071 first line of any tangled file holding the code block, and the file
15072 permissions of the tangled file are set to make it executable.
15075 @node tangle-mode, eval, shebang, Specific header arguments
15076 @subsubsection @code{:tangle-mode}
15078 The @code{tangle-mode} header argument controls the permission set on tangled
15079 files. The value of this header argument will be passed to
15080 @code{set-file-modes}. For example, to set a tangled file as read only use
15081 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15082 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
15083 (@ref{shebang}) header arguments will automatically be made executable unless
15084 the @code{tangle-mode} header argument is also used. The behavior is
15085 undefined if multiple code blocks with different values for the
15086 @code{tangle-mode} header argument are tangled to the same file.
15088 @node eval, wrap, tangle-mode, Specific header arguments
15089 @subsubsection @code{:eval}
15090 The @code{:eval} header argument can be used to limit the evaluation of
15091 specific code blocks. The @code{:eval} header argument can be useful for
15092 protecting against the evaluation of dangerous code blocks or to ensure that
15093 evaluation will require a query regardless of the value of the
15094 @code{org-confirm-babel-evaluate} variable. The possible values of
15095 @code{:eval} and their effects are shown below.
15099 The code block will not be evaluated under any circumstances.
15101 Evaluation of the code block will require a query.
15102 @item never-export or no-export
15103 The code block will not be evaluated during export but may still be called
15106 Evaluation of the code block during export will require a query.
15109 If this header argument is not set then evaluation is determined by the value
15110 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15113 @node wrap, post, eval, Specific header arguments
15114 @subsubsection @code{:wrap}
15115 The @code{:wrap} header argument is used to mark the results of source block
15116 evaluation. The header argument can be passed a string that will be appended
15117 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15118 results. If not string is specified then the results will be wrapped in a
15119 @code{#+BEGIN/END_RESULTS} block.
15121 @node post, , wrap, Specific header arguments
15122 @subsubsection @code{:post}
15123 The @code{:post} header argument is used to post-process the results of a
15124 code block execution. When a post argument is given, the results of the code
15125 block will temporarily be bound to the @code{*this*} variable. This variable
15126 may then be included in header argument forms such as those used in @ref{var}
15127 header argument specifications allowing passing of results to other code
15128 blocks, or direct execution via Emacs Lisp.
15130 The following example illustrates the usage of the @code{:post} header
15135 #+begin_src sh :var data="" :var width="\\textwidth" :results output
15136 echo "#+ATTR_LATEX :width $width"
15140 #+header: :file /tmp/it.png
15141 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
15151 #+ATTR_LATEX :width 5cm
15152 [[file:/tmp/it.png]]
15156 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
15157 @section Results of evaluation
15158 @cindex code block, results of evaluation
15159 @cindex source code, results of evaluation
15161 The way in which results are handled depends on whether a session is invoked,
15162 as well as on whether @code{:results value} or @code{:results output} is
15163 used. The following table shows the table possibilities. For a full listing
15164 of the possible results header arguments see @ref{results}.
15166 @multitable @columnfractions 0.26 0.33 0.41
15167 @item @tab @b{Non-session} @tab @b{Session}
15168 @item @code{:results value} @tab value of last expression @tab value of last expression
15169 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
15172 Note: With @code{:results value}, the result in both @code{:session} and
15173 non-session is returned to Org mode as a table (a one- or two-dimensional
15174 vector of strings or numbers) when appropriate.
15176 @subsection Non-session
15177 @subsubsection @code{:results value}
15178 This is the default. Internally, the value is obtained by wrapping the code
15179 in a function definition in the external language, and evaluating that
15180 function. Therefore, code should be written as if it were the body of such a
15181 function. In particular, note that Python does not automatically return a
15182 value from a function unless a @code{return} statement is present, and so a
15183 @samp{return} statement will usually be required in Python.
15185 This is the only one of the four evaluation contexts in which the code is
15186 automatically wrapped in a function definition.
15188 @subsubsection @code{:results output}
15189 The code is passed to the interpreter as an external process, and the
15190 contents of the standard output stream are returned as text. (In certain
15191 languages this also contains the error output stream; this is an area for
15194 @subsection Session
15195 @subsubsection @code{:results value}
15196 The code is passed to an interpreter running as an interactive Emacs inferior
15197 process. Only languages which provide tools for interactive evaluation of
15198 code have session support, so some language (e.g., C and ditaa) do not
15199 support the @code{:session} header argument, and in other languages (e.g.,
15200 Python and Haskell) which have limitations on the code which may be entered
15201 into interactive sessions, those limitations apply to the code in code blocks
15202 using the @code{:session} header argument as well.
15204 Unless the @code{:results output} option is supplied (see below) the result
15205 returned is the result of the last evaluation performed by the
15206 interpreter. (This is obtained in a language-specific manner: the value of
15207 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
15210 @subsubsection @code{:results output}
15211 The code is passed to the interpreter running as an interactive Emacs
15212 inferior process. The result returned is the concatenation of the sequence of
15213 (text) output from the interactive interpreter. Notice that this is not
15214 necessarily the same as what would be sent to @code{STDOUT} if the same code
15215 were passed to a non-interactive interpreter running as an external
15216 process. For example, compare the following two blocks:
15219 #+BEGIN_SRC python :results output
15230 In non-session mode, the `2' is not printed and does not appear.
15233 #+BEGIN_SRC python :results output :session
15245 But in @code{:session} mode, the interactive interpreter receives input `2'
15246 and prints out its value, `2'. (Indeed, the other print statements are
15249 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
15250 @section Noweb reference syntax
15251 @cindex code block, noweb reference
15252 @cindex syntax, noweb
15253 @cindex source code, noweb reference
15255 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
15256 Programming system allows named blocks of code to be referenced by using the
15257 familiar Noweb syntax:
15260 <<code-block-name>>
15263 When a code block is tangled or evaluated, whether or not ``noweb''
15264 references are expanded depends upon the value of the @code{:noweb} header
15265 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
15266 evaluation. If @code{:noweb no}, the default, then the reference is not
15267 expanded before evaluation. See the @ref{noweb-ref} header argument for
15268 a more flexible way to resolve noweb references.
15270 It is possible to include the @emph{results} of a code block rather than the
15271 body. This is done by appending parenthesis to the code block name which may
15272 optionally contain arguments to the code block as shown below.
15275 <<code-block-name(optional arguments)>>
15278 Note: the default value, @code{:noweb no}, was chosen to ensure that
15279 correct code is not broken in a language, such as Ruby, where
15280 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
15281 syntactically valid in languages that you use, then please consider setting
15284 Note: if noweb tangling is slow in large Org mode files consider setting the
15285 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
15286 This will result in faster noweb reference resolution at the expense of not
15287 correctly resolving inherited values of the @code{:noweb-ref} header
15290 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
15291 @section Key bindings and useful functions
15292 @cindex code block, key bindings
15294 Many common Org mode key sequences are re-bound depending on
15297 Within a code block, the following key bindings
15300 @multitable @columnfractions 0.25 0.75
15302 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
15304 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
15306 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
15308 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
15311 In an Org mode buffer, the following key bindings are active:
15313 @multitable @columnfractions 0.45 0.55
15315 @kindex C-c C-v C-p
15316 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
15318 @kindex C-c C-v C-n
15319 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
15321 @kindex C-c C-v C-e
15322 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
15324 @kindex C-c C-v C-o
15325 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
15327 @kindex C-c C-v C-v
15328 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
15330 @kindex C-c C-v C-u
15331 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
15333 @kindex C-c C-v C-g
15334 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
15336 @kindex C-c C-v C-r
15337 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
15339 @kindex C-c C-v C-b
15340 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15342 @kindex C-c C-v C-s
15343 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15345 @kindex C-c C-v C-d
15346 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
15348 @kindex C-c C-v C-t
15349 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15351 @kindex C-c C-v C-f
15352 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15354 @kindex C-c C-v C-c
15355 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
15357 @kindex C-c C-v C-j
15358 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
15360 @kindex C-c C-v C-l
15361 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
15363 @kindex C-c C-v C-i
15364 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
15366 @kindex C-c C-v C-I
15367 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
15369 @kindex C-c C-v C-z
15370 @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}
15372 @kindex C-c C-v C-a
15373 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15375 @kindex C-c C-v C-h
15376 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
15378 @kindex C-c C-v C-x
15379 @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}
15382 @c When possible these keybindings were extended to work when the control key is
15383 @c kept pressed, resulting in the following additional keybindings.
15385 @c @multitable @columnfractions 0.25 0.75
15386 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15387 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15388 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15389 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
15390 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
15391 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15392 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15393 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
15396 @node Batch execution, , Key bindings and useful functions, Working With Source Code
15397 @section Batch execution
15398 @cindex code block, batch execution
15399 @cindex source code, batch execution
15401 It is possible to call functions from the command line. This shell
15402 script calls @code{org-babel-tangle} on every one of its arguments.
15404 Be sure to adjust the paths to fit your system.
15408 # -*- mode: shell-script -*-
15410 # tangle files with org-mode
15415 # wrap each argument in the code required to call tangle on it
15417 FILES="$FILES \"$i\""
15422 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
15423 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
15424 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
15425 (mapc (lambda (file)
15426 (find-file (expand-file-name file \"$DIR\"))
15428 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
15431 @node Miscellaneous, Hacking, Working With Source Code, Top
15432 @chapter Miscellaneous
15435 * Completion:: M-TAB knows what you need
15436 * Easy Templates:: Quick insertion of structural elements
15437 * Speed keys:: Electric commands at the beginning of a headline
15438 * Code evaluation security:: Org mode files evaluate inline code
15439 * Customization:: Adapting Org to your taste
15440 * In-buffer settings:: Overview of the #+KEYWORDS
15441 * The very busy C-c C-c key:: When in doubt, press C-c C-c
15442 * Clean view:: Getting rid of leading stars in the outline
15443 * TTY keys:: Using Org on a tty
15444 * Interaction:: Other Emacs packages
15445 * org-crypt.el:: Encrypting Org files
15449 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
15450 @section Completion
15451 @cindex completion, of @TeX{} symbols
15452 @cindex completion, of TODO keywords
15453 @cindex completion, of dictionary words
15454 @cindex completion, of option keywords
15455 @cindex completion, of tags
15456 @cindex completion, of property keys
15457 @cindex completion, of link abbreviations
15458 @cindex @TeX{} symbol completion
15459 @cindex TODO keywords completion
15460 @cindex dictionary word completion
15461 @cindex option keyword completion
15462 @cindex tag completion
15463 @cindex link abbreviations, completion of
15465 Emacs would not be Emacs without completion, and Org mode uses it whenever it
15466 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
15467 some of the completion prompts, you can specify your preference by setting at
15468 most one of the variables @code{org-completion-use-iswitchb}
15469 @code{org-completion-use-ido}.
15471 Org supports in-buffer completion. This type of completion does
15472 not make use of the minibuffer. You simply type a few letters into
15473 the buffer and use the key to complete text right there.
15476 @kindex M-@key{TAB}
15478 Complete word at point
15481 At the beginning of a headline, complete TODO keywords.
15483 After @samp{\}, complete @TeX{} symbols supported by the exporter.
15485 After @samp{*}, complete headlines in the current buffer so that they
15486 can be used in search links like @samp{[[*find this headline]]}.
15488 After @samp{:} in a headline, complete tags. The list of tags is taken
15489 from the variable @code{org-tag-alist} (possibly set through the
15490 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
15491 dynamically from all tags used in the current buffer.
15493 After @samp{:} and not in a headline, complete property keys. The list
15494 of keys is constructed dynamically from all keys used in the current
15497 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
15499 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
15500 @samp{OPTIONS} which set file-specific options for Org mode. When the
15501 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
15502 will insert example settings for this keyword.
15504 In the line after @samp{#+STARTUP: }, complete startup keywords,
15505 i.e., valid keys for this line.
15507 Elsewhere, complete dictionary words using Ispell.
15511 @node Easy Templates, Speed keys, Completion, Miscellaneous
15512 @section Easy Templates
15513 @cindex template insertion
15514 @cindex insertion, of templates
15516 Org mode supports insertion of empty structural elements (like
15517 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
15518 strokes. This is achieved through a native template expansion mechanism.
15519 Note that Emacs has several other template mechanisms which could be used in
15520 a similar way, for example @file{yasnippet}.
15522 To insert a structural element, type a @samp{<}, followed by a template
15523 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
15524 keystrokes are typed on a line by itself.
15526 The following template selectors are currently supported.
15528 @multitable @columnfractions 0.1 0.9
15529 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
15530 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
15531 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
15532 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
15533 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
15534 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
15535 @item @kbd{L} @tab @code{#+LaTeX:}
15536 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
15537 @item @kbd{H} @tab @code{#+HTML:}
15538 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
15539 @item @kbd{A} @tab @code{#+ASCII:}
15540 @item @kbd{i} @tab @code{#+INDEX:} line
15541 @item @kbd{I} @tab @code{#+INCLUDE:} line
15544 For example, on an empty line, typing "<e" and then pressing TAB, will expand
15545 into a complete EXAMPLE template.
15547 You can install additional templates by customizing the variable
15548 @code{org-structure-template-alist}. See the docstring of the variable for
15549 additional details.
15551 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
15552 @section Speed keys
15554 @vindex org-use-speed-commands
15555 @vindex org-speed-commands-user
15557 Single keys can be made to execute commands when the cursor is at the
15558 beginning of a headline, i.e., before the first star. Configure the variable
15559 @code{org-use-speed-commands} to activate this feature. There is a
15560 pre-defined list of commands, and you can add more such commands using the
15561 variable @code{org-speed-commands-user}. Speed keys do not only speed up
15562 navigation and other commands, but they also provide an alternative way to
15563 execute commands bound to keys that are not or not easily available on a TTY,
15564 or on a small mobile device with a limited keyboard.
15566 To see which commands are available, activate the feature and press @kbd{?}
15567 with the cursor at the beginning of a headline.
15569 @node Code evaluation security, Customization, Speed keys, Miscellaneous
15570 @section Code evaluation and security issues
15572 Org provides tools to work with the code snippets, including evaluating them.
15574 Running code on your machine always comes with a security risk. Badly
15575 written or malicious code can be executed on purpose or by accident. Org has
15576 default settings which will only evaluate such code if you give explicit
15577 permission to do so, and as a casual user of these features you should leave
15578 these precautions intact.
15580 For people who regularly work with such code, the confirmation prompts can
15581 become annoying, and you might want to turn them off. This can be done, but
15582 you must be aware of the risks that are involved.
15584 Code evaluation can happen under the following circumstances:
15587 @item Source code blocks
15588 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
15589 C-c} in the block. The most important thing to realize here is that Org mode
15590 files which contain code snippets are, in a certain sense, like executable
15591 files. So you should accept them and load them into Emacs only from trusted
15592 sources---just like you would do with a program you install on your computer.
15594 Make sure you know what you are doing before customizing the variables
15595 which take off the default security brakes.
15597 @defopt org-confirm-babel-evaluate
15598 When t (the default), the user is asked before every code block evaluation.
15599 When @code{nil}, the user is not asked. When set to a function, it is called with
15600 two arguments (language and body of the code block) and should return t to
15601 ask and @code{nil} not to ask.
15604 For example, here is how to execute "ditaa" code (which is considered safe)
15608 (defun my-org-confirm-babel-evaluate (lang body)
15609 (not (string= lang "ditaa"))) ; don't ask for ditaa
15610 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
15613 @item Following @code{shell} and @code{elisp} links
15614 Org has two link types that can directly evaluate code (@pxref{External
15615 links}). These links can be problematic because the code to be evaluated is
15618 @defopt org-confirm-shell-link-function
15619 Function to queries user about shell link execution.
15621 @defopt org-confirm-elisp-link-function
15622 Functions to query user for Emacs Lisp link execution.
15625 @item Formulas in tables
15626 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
15627 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
15630 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
15631 @section Customization
15632 @cindex customization
15633 @cindex options, for customization
15634 @cindex variables, for customization
15636 There are more than 500 variables that can be used to customize
15637 Org. For the sake of compactness of the manual, I am not
15638 describing the variables here. A structured overview of customization
15639 variables is available with @kbd{M-x org-customize RET}. Or select
15640 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
15641 settings can also be activated on a per-file basis, by putting special
15642 lines into the buffer (@pxref{In-buffer settings}).
15644 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
15645 @section Summary of in-buffer settings
15646 @cindex in-buffer settings
15647 @cindex special keywords
15649 Org mode uses special lines in the buffer to define settings on a
15650 per-file basis. These lines start with a @samp{#+} followed by a
15651 keyword, a colon, and then individual words defining a setting. Several
15652 setting words can be in the same line, but you can also have multiple
15653 lines for the keyword. While these settings are described throughout
15654 the manual, here is a summary. After changing any of those lines in the
15655 buffer, press @kbd{C-c C-c} with the cursor still in the line to
15656 activate the changes immediately. Otherwise they become effective only
15657 when the file is visited again in a new Emacs session.
15659 @vindex org-archive-location
15661 @item #+ARCHIVE: %s_done::
15662 This line sets the archive location for the agenda file. It applies for
15663 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
15664 of the file. The first such line also applies to any entries before it.
15665 The corresponding variable is @code{org-archive-location}.
15667 This line sets the category for the agenda file. The category applies
15668 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
15669 end of the file. The first such line also applies to any entries before it.
15670 @item #+COLUMNS: %25ITEM .....
15671 @cindex property, COLUMNS
15672 Set the default format for columns view. This format applies when
15673 columns view is invoked in locations where no @code{COLUMNS} property
15675 @item #+CONSTANTS: name1=value1 ...
15676 @vindex org-table-formula-constants
15677 @vindex org-table-formula
15678 Set file-local values for constants to be used in table formulas. This
15679 line sets the local variable @code{org-table-formula-constants-local}.
15680 The global version of this variable is
15681 @code{org-table-formula-constants}.
15682 @item #+FILETAGS: :tag1:tag2:tag3:
15683 Set tags that can be inherited by any entry in the file, including the
15685 @item #+DRAWERS: NAME1 .....
15686 @vindex org-drawers
15687 Set the file-local set of additional drawers. The corresponding global
15688 variable is @code{org-drawers}.
15689 @item #+LINK: linkword replace
15690 @vindex org-link-abbrev-alist
15691 These lines (several are allowed) specify link abbreviations.
15692 @xref{Link abbreviations}. The corresponding variable is
15693 @code{org-link-abbrev-alist}.
15694 @item #+PRIORITIES: highest lowest default
15695 @vindex org-highest-priority
15696 @vindex org-lowest-priority
15697 @vindex org-default-priority
15698 This line sets the limits and the default for the priorities. All three
15699 must be either letters A--Z or numbers 0--9. The highest priority must
15700 have a lower ASCII number than the lowest priority.
15701 @item #+PROPERTY: Property_Name Value
15702 This line sets a default inheritance value for entries in the current
15703 buffer, most useful for specifying the allowed values of a property.
15704 @cindex #+SETUPFILE
15705 @item #+SETUPFILE: file
15706 This line defines a file that holds more in-buffer setup. Normally this is
15707 entirely ignored. Only when the buffer is parsed for option-setting lines
15708 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
15709 settings line, or when exporting), then the contents of this file are parsed
15710 as if they had been included in the buffer. In particular, the file can be
15711 any other Org mode file with internal setup. You can visit the file the
15712 cursor is in the line with @kbd{C-c '}.
15715 This line sets options to be used at startup of Org mode, when an
15716 Org file is being visited.
15718 The first set of options deals with the initial visibility of the outline
15719 tree. The corresponding variable for global default settings is
15720 @code{org-startup-folded}, with a default value @code{t}, which means
15722 @vindex org-startup-folded
15723 @cindex @code{overview}, STARTUP keyword
15724 @cindex @code{content}, STARTUP keyword
15725 @cindex @code{showall}, STARTUP keyword
15726 @cindex @code{showeverything}, STARTUP keyword
15728 overview @r{top-level headlines only}
15729 content @r{all headlines}
15730 showall @r{no folding of any entries}
15731 showeverything @r{show even drawer contents}
15734 @vindex org-startup-indented
15735 @cindex @code{indent}, STARTUP keyword
15736 @cindex @code{noindent}, STARTUP keyword
15737 Dynamic virtual indentation is controlled by the variable
15738 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
15740 indent @r{start with @code{org-indent-mode} turned on}
15741 noindent @r{start with @code{org-indent-mode} turned off}
15744 @vindex org-startup-align-all-tables
15745 Then there are options for aligning tables upon visiting a file. This
15746 is useful in files containing narrowed table columns. The corresponding
15747 variable is @code{org-startup-align-all-tables}, with a default value
15749 @cindex @code{align}, STARTUP keyword
15750 @cindex @code{noalign}, STARTUP keyword
15752 align @r{align all tables}
15753 noalign @r{don't align tables on startup}
15756 @vindex org-startup-with-inline-images
15757 When visiting a file, inline images can be automatically displayed. The
15758 corresponding variable is @code{org-startup-with-inline-images}, with a
15759 default value @code{nil} to avoid delays when visiting a file.
15760 @cindex @code{inlineimages}, STARTUP keyword
15761 @cindex @code{noinlineimages}, STARTUP keyword
15763 inlineimages @r{show inline images}
15764 noinlineimages @r{don't show inline images on startup}
15767 @vindex org-startup-with-latex-preview
15768 When visiting a file, @LaTeX{} fragments can be converted to images
15769 automatically. The variable @code{org-startup-with-latex-preview} which
15770 controls this behavior, is set to @code{nil} by default to avoid delays on
15772 @cindex @code{latexpreview}, STARTUP keyword
15773 @cindex @code{nolatexpreview}, STARTUP keyword
15775 latexpreview @r{preview @LaTeX{} fragments}
15776 nolatexpreview @r{don't preview @LaTeX{} fragments}
15779 @vindex org-log-done
15780 @vindex org-log-note-clock-out
15781 @vindex org-log-repeat
15782 Logging the closing and reopening of TODO items and clock intervals can be
15783 configured using these options (see variables @code{org-log-done},
15784 @code{org-log-note-clock-out} and @code{org-log-repeat})
15785 @cindex @code{logdone}, STARTUP keyword
15786 @cindex @code{lognotedone}, STARTUP keyword
15787 @cindex @code{nologdone}, STARTUP keyword
15788 @cindex @code{lognoteclock-out}, STARTUP keyword
15789 @cindex @code{nolognoteclock-out}, STARTUP keyword
15790 @cindex @code{logrepeat}, STARTUP keyword
15791 @cindex @code{lognoterepeat}, STARTUP keyword
15792 @cindex @code{nologrepeat}, STARTUP keyword
15793 @cindex @code{logreschedule}, STARTUP keyword
15794 @cindex @code{lognotereschedule}, STARTUP keyword
15795 @cindex @code{nologreschedule}, STARTUP keyword
15796 @cindex @code{logredeadline}, STARTUP keyword
15797 @cindex @code{lognoteredeadline}, STARTUP keyword
15798 @cindex @code{nologredeadline}, STARTUP keyword
15799 @cindex @code{logrefile}, STARTUP keyword
15800 @cindex @code{lognoterefile}, STARTUP keyword
15801 @cindex @code{nologrefile}, STARTUP keyword
15802 @cindex @code{logdrawer}, STARTUP keyword
15803 @cindex @code{nologdrawer}, STARTUP keyword
15804 @cindex @code{logstatesreversed}, STARTUP keyword
15805 @cindex @code{nologstatesreversed}, STARTUP keyword
15807 logdone @r{record a timestamp when an item is marked DONE}
15808 lognotedone @r{record timestamp and a note when DONE}
15809 nologdone @r{don't record when items are marked DONE}
15810 logrepeat @r{record a time when reinstating a repeating item}
15811 lognoterepeat @r{record a note when reinstating a repeating item}
15812 nologrepeat @r{do not record when reinstating repeating item}
15813 lognoteclock-out @r{record a note when clocking out}
15814 nolognoteclock-out @r{don't record a note when clocking out}
15815 logreschedule @r{record a timestamp when scheduling time changes}
15816 lognotereschedule @r{record a note when scheduling time changes}
15817 nologreschedule @r{do not record when a scheduling date changes}
15818 logredeadline @r{record a timestamp when deadline changes}
15819 lognoteredeadline @r{record a note when deadline changes}
15820 nologredeadline @r{do not record when a deadline date changes}
15821 logrefile @r{record a timestamp when refiling}
15822 lognoterefile @r{record a note when refiling}
15823 nologrefile @r{do not record when refiling}
15824 logdrawer @r{store log into drawer}
15825 nologdrawer @r{store log outside of drawer}
15826 logstatesreversed @r{reverse the order of states notes}
15827 nologstatesreversed @r{do not reverse the order of states notes}
15830 @vindex org-hide-leading-stars
15831 @vindex org-odd-levels-only
15832 Here are the options for hiding leading stars in outline headings, and for
15833 indenting outlines. The corresponding variables are
15834 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
15835 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
15836 @cindex @code{hidestars}, STARTUP keyword
15837 @cindex @code{showstars}, STARTUP keyword
15838 @cindex @code{odd}, STARTUP keyword
15839 @cindex @code{even}, STARTUP keyword
15841 hidestars @r{make all but one of the stars starting a headline invisible.}
15842 showstars @r{show all stars starting a headline}
15843 indent @r{virtual indentation according to outline level}
15844 noindent @r{no virtual indentation according to outline level}
15845 odd @r{allow only odd outline levels (1,3,...)}
15846 oddeven @r{allow all outline levels}
15849 @vindex org-put-time-stamp-overlays
15850 @vindex org-time-stamp-overlay-formats
15851 To turn on custom format overlays over timestamps (variables
15852 @code{org-put-time-stamp-overlays} and
15853 @code{org-time-stamp-overlay-formats}), use
15854 @cindex @code{customtime}, STARTUP keyword
15856 customtime @r{overlay custom time format}
15859 @vindex constants-unit-system
15860 The following options influence the table spreadsheet (variable
15861 @code{constants-unit-system}).
15862 @cindex @code{constcgs}, STARTUP keyword
15863 @cindex @code{constSI}, STARTUP keyword
15865 constcgs @r{@file{constants.el} should use the c-g-s unit system}
15866 constSI @r{@file{constants.el} should use the SI unit system}
15869 @vindex org-footnote-define-inline
15870 @vindex org-footnote-auto-label
15871 @vindex org-footnote-auto-adjust
15872 To influence footnote settings, use the following keywords. The
15873 corresponding variables are @code{org-footnote-define-inline},
15874 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
15875 @cindex @code{fninline}, STARTUP keyword
15876 @cindex @code{nofninline}, STARTUP keyword
15877 @cindex @code{fnlocal}, STARTUP keyword
15878 @cindex @code{fnprompt}, STARTUP keyword
15879 @cindex @code{fnauto}, STARTUP keyword
15880 @cindex @code{fnconfirm}, STARTUP keyword
15881 @cindex @code{fnplain}, STARTUP keyword
15882 @cindex @code{fnadjust}, STARTUP keyword
15883 @cindex @code{nofnadjust}, STARTUP keyword
15885 fninline @r{define footnotes inline}
15886 fnnoinline @r{define footnotes in separate section}
15887 fnlocal @r{define footnotes near first reference, but not inline}
15888 fnprompt @r{prompt for footnote labels}
15889 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
15890 fnconfirm @r{offer automatic label for editing or confirmation}
15891 fnplain @r{create @code{[1]}-like labels automatically}
15892 fnadjust @r{automatically renumber and sort footnotes}
15893 nofnadjust @r{do not renumber and sort automatically}
15896 @cindex org-hide-block-startup
15897 To hide blocks on startup, use these keywords. The corresponding variable is
15898 @code{org-hide-block-startup}.
15899 @cindex @code{hideblocks}, STARTUP keyword
15900 @cindex @code{nohideblocks}, STARTUP keyword
15902 hideblocks @r{Hide all begin/end blocks on startup}
15903 nohideblocks @r{Do not hide blocks on startup}
15906 @cindex org-pretty-entities
15907 The display of entities as UTF-8 characters is governed by the variable
15908 @code{org-pretty-entities} and the keywords
15909 @cindex @code{entitiespretty}, STARTUP keyword
15910 @cindex @code{entitiesplain}, STARTUP keyword
15912 entitiespretty @r{Show entities as UTF-8 characters where possible}
15913 entitiesplain @r{Leave entities plain}
15916 @item #+TAGS: TAG1(c1) TAG2(c2)
15917 @vindex org-tag-alist
15918 These lines (several such lines are allowed) specify the valid tags in
15919 this file, and (potentially) the corresponding @emph{fast tag selection}
15920 keys. The corresponding variable is @code{org-tag-alist}.
15923 This line contains the formulas for the table directly above the line.
15925 Table can have multiple lines containing @samp{#+TBLFM:}. Note
15926 that only the first line of @samp{#+TBLFM:} will be applied when
15927 you recalculate the table. For more details see @ref{Using
15928 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
15930 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
15931 @itemx #+OPTIONS:, #+BIND:,
15932 @itemx #+DESCRIPTION:, #+KEYWORDS:,
15933 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
15934 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
15935 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
15936 These lines provide settings for exporting files. For more details see
15937 @ref{Export settings}.
15938 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
15939 @vindex org-todo-keywords
15940 These lines set the TODO keywords and their interpretation in the
15941 current file. The corresponding variable is @code{org-todo-keywords}.
15944 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
15945 @section The very busy C-c C-c key
15947 @cindex C-c C-c, overview
15949 The key @kbd{C-c C-c} has many purposes in Org, which are all
15950 mentioned scattered throughout this manual. One specific function of
15951 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
15952 other circumstances it means something like @emph{``Hey Org, look
15953 here and update according to what you see here''}. Here is a summary of
15954 what this means in different contexts.
15958 If there are highlights in the buffer from the creation of a sparse
15959 tree, or from clock display, remove these highlights.
15961 If the cursor is in one of the special @code{#+KEYWORD} lines, this
15962 triggers scanning the buffer for these lines and updating the
15965 If the cursor is inside a table, realign the table. This command
15966 works even if the automatic table editor has been turned off.
15968 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
15971 If the current buffer is a capture buffer, close the note and file it.
15972 With a prefix argument, file it, without further interaction, to the
15975 If the cursor is on a @code{<<<target>>>}, update radio targets and
15976 corresponding links in this buffer.
15978 If the cursor is in a property line or at the start or end of a property
15979 drawer, offer property commands.
15981 If the cursor is at a footnote reference, go to the corresponding
15982 definition, and @emph{vice versa}.
15984 If the cursor is on a statistics cookie, update it.
15986 If the cursor is in a plain list item with a checkbox, toggle the status
15989 If the cursor is on a numbered item in a plain list, renumber the
15992 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
15995 If the cursor is at a timestamp, fix the day name in the timestamp.
15998 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
15999 @section A cleaner outline view
16000 @cindex hiding leading stars
16001 @cindex dynamic indentation
16002 @cindex odd-levels-only outlines
16003 @cindex clean outline view
16005 Some people find it noisy and distracting that the Org headlines start with a
16006 potentially large number of stars, and that text below the headlines is not
16007 indented. While this is no problem when writing a @emph{book-like} document
16008 where the outline headings are really section headings, in a more
16009 @emph{list-oriented} outline, indented structure is a lot cleaner:
16013 * Top level headline | * Top level headline
16014 ** Second level | * Second level
16015 *** 3rd level | * 3rd level
16016 some text | some text
16017 *** 3rd level | * 3rd level
16018 more text | more text
16019 * Another top level headline | * Another top level headline
16025 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16026 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16027 be achieved dynamically at display time using @code{org-indent-mode}. In
16028 this minor mode, all lines are prefixed for display with the necessary amount
16029 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16030 property, such that @code{visual-line-mode} (or purely setting
16031 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16032 }. Also headlines are prefixed with additional stars, so that the amount of
16033 indentation shifts by two@footnote{See the variable
16034 @code{org-indent-indentation-per-level}.} spaces per level. All headline
16035 stars but the last one are made invisible using the @code{org-hide}
16036 face@footnote{Turning on @code{org-indent-mode} sets
16037 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16038 @code{nil}.}; see below under @samp{2.} for more information on how this
16039 works. You can turn on @code{org-indent-mode} for all files by customizing
16040 the variable @code{org-startup-indented}, or you can turn it on for
16041 individual files using
16047 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16048 you want the indentation to be hard space characters so that the plain text
16049 file looks as similar as possible to the Emacs display, Org supports you in
16054 @emph{Indentation of text below headlines}@*
16055 You may indent text below each headline to make the left boundary line up
16056 with the headline, like
16060 more text, now indented
16063 @vindex org-adapt-indentation
16064 Org supports this with paragraph filling, line wrapping, and structure
16065 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16066 preserving or adapting the indentation as appropriate.
16069 @vindex org-hide-leading-stars
16070 @emph{Hiding leading stars}@* You can modify the display in such a way that
16071 all leading stars become invisible. To do this in a global way, configure
16072 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16076 #+STARTUP: hidestars
16077 #+STARTUP: showstars
16080 With hidden stars, the tree becomes:
16084 * Top level headline
16092 @vindex org-hide @r{(face)}
16093 The leading stars are not truly replaced by whitespace, they are only
16094 fontified with the face @code{org-hide} that uses the background color as
16095 font color. If you are not using either white or black background, you may
16096 have to customize this face to get the wanted effect. Another possibility is
16097 to set this font such that the extra stars are @i{almost} invisible, for
16098 example using the color @code{grey90} on a white background.
16101 @vindex org-odd-levels-only
16102 Things become cleaner still if you skip all the even levels and use only odd
16103 levels 1, 3, 5..., effectively adding two stars to go from one outline level
16104 to the next@footnote{When you need to specify a level for a property search
16105 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
16106 way we get the outline view shown at the beginning of this section. In order
16107 to make the structure editing and export commands handle this convention
16108 correctly, configure the variable @code{org-odd-levels-only}, or set this on
16109 a per-file basis with one of the following lines:
16116 You can convert an Org file from single-star-per-level to the
16117 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
16118 RET} in that file. The reverse operation is @kbd{M-x
16119 org-convert-to-oddeven-levels}.
16122 @node TTY keys, Interaction, Clean view, Miscellaneous
16123 @section Using Org on a tty
16124 @cindex tty key bindings
16126 Because Org contains a large number of commands, by default many of
16127 Org's core commands are bound to keys that are generally not
16128 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
16129 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
16130 together with modifiers like @key{Meta} and/or @key{Shift}. To access
16131 these commands on a tty when special keys are unavailable, the following
16132 alternative bindings can be used. The tty bindings below will likely be
16133 more cumbersome; you may find for some of the bindings below that a
16134 customized workaround suits you better. For example, changing a timestamp
16135 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
16136 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
16138 @multitable @columnfractions 0.15 0.2 0.1 0.2
16139 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
16140 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
16141 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
16142 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
16143 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
16144 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
16145 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
16146 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
16147 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
16148 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
16149 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
16150 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
16151 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
16152 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
16153 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
16154 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
16155 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
16156 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
16157 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
16161 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
16162 @section Interaction with other packages
16163 @cindex packages, interaction with other
16164 Org lives in the world of GNU Emacs and interacts in various ways
16165 with other code out there.
16168 * Cooperation:: Packages Org cooperates with
16169 * Conflicts:: Packages that lead to conflicts
16172 @node Cooperation, Conflicts, Interaction, Interaction
16173 @subsection Packages that Org cooperates with
16176 @cindex @file{calc.el}
16177 @cindex Gillespie, Dave
16178 @item @file{calc.el} by Dave Gillespie
16179 Org uses the Calc package for implementing spreadsheet
16180 functionality in its tables (@pxref{The spreadsheet}). Org
16181 checks for the availability of Calc by looking for the function
16182 @code{calc-eval} which will have been autoloaded during setup if Calc has
16183 been installed properly. As of Emacs 22, Calc is part of the Emacs
16184 distribution. Another possibility for interaction between the two
16185 packages is using Calc for embedded calculations. @xref{Embedded Mode,
16186 , Embedded Mode, calc, GNU Emacs Calc Manual}.
16187 @item @file{constants.el} by Carsten Dominik
16188 @cindex @file{constants.el}
16189 @cindex Dominik, Carsten
16190 @vindex org-table-formula-constants
16191 In a table formula (@pxref{The spreadsheet}), it is possible to use
16192 names for natural constants or units. Instead of defining your own
16193 constants in the variable @code{org-table-formula-constants}, install
16194 the @file{constants} package which defines a large number of constants
16195 and units, and lets you use unit prefixes like @samp{M} for
16196 @samp{Mega}, etc. You will need version 2.0 of this package, available
16197 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
16198 the function @code{constants-get}, which has to be autoloaded in your
16199 setup. See the installation instructions in the file
16200 @file{constants.el}.
16201 @item @file{cdlatex.el} by Carsten Dominik
16202 @cindex @file{cdlatex.el}
16203 @cindex Dominik, Carsten
16204 Org mode can make use of the CD@LaTeX{} package to efficiently enter
16205 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
16206 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
16207 @cindex @file{imenu.el}
16208 Imenu allows menu access to an index of items in a file. Org mode
16209 supports Imenu---all you need to do to get the index is the following:
16211 (add-hook 'org-mode-hook
16212 (lambda () (imenu-add-to-menubar "Imenu")))
16214 @vindex org-imenu-depth
16215 By default the index is two levels deep---you can modify the depth using
16216 the option @code{org-imenu-depth}.
16217 @item @file{remember.el} by John Wiegley
16218 @cindex @file{remember.el}
16219 @cindex Wiegley, John
16220 Org used to use this package for capture, but no longer does.
16221 @item @file{speedbar.el} by Eric M. Ludlam
16222 @cindex @file{speedbar.el}
16223 @cindex Ludlam, Eric M.
16224 Speedbar is a package that creates a special frame displaying files and
16225 index items in files. Org mode supports Speedbar and allows you to
16226 drill into Org files directly from the Speedbar. It also allows you to
16227 restrict the scope of agenda commands to a file or a subtree by using
16228 the command @kbd{<} in the Speedbar frame.
16229 @cindex @file{table.el}
16230 @item @file{table.el} by Takaaki Ota
16232 @cindex table editor, @file{table.el}
16233 @cindex @file{table.el}
16234 @cindex Ota, Takaaki
16236 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
16237 and alignment can be created using the Emacs table package by Takaaki Ota
16238 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
16239 Org mode will recognize these tables and export them properly. Because of
16240 interference with other Org mode functionality, you unfortunately cannot edit
16241 these tables directly in the buffer. Instead, you need to use the command
16242 @kbd{C-c '} to edit them, similar to source code snippets.
16245 @orgcmd{C-c ',org-edit-special}
16246 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
16248 @orgcmd{C-c ~,org-table-create-with-table.el}
16249 Insert a @file{table.el} table. If there is already a table at point, this
16250 command converts it between the @file{table.el} format and the Org mode
16251 format. See the documentation string of the command
16252 @code{org-convert-table} for the restrictions under which this is
16255 @file{table.el} is part of Emacs since Emacs 22.
16256 @item @file{footnote.el} by Steven L. Baur
16257 @cindex @file{footnote.el}
16258 @cindex Baur, Steven L.
16259 Org mode recognizes numerical footnotes as provided by this package.
16260 However, Org mode also has its own footnote support (@pxref{Footnotes}),
16261 which makes using @file{footnote.el} unnecessary.
16264 @node Conflicts, , Cooperation, Interaction
16265 @subsection Packages that lead to conflicts with Org mode
16269 @cindex @code{shift-selection-mode}
16270 @vindex org-support-shift-select
16271 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
16272 cursor motions combined with the shift key should start or enlarge regions.
16273 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
16274 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
16275 at such a location. By default, @kbd{S-@key{cursor}} commands outside
16276 special contexts don't do anything, but you can customize the variable
16277 @code{org-support-shift-select}. Org mode then tries to accommodate shift
16278 selection by (i) using it outside of the special contexts where special
16279 commands apply, and by (ii) extending an existing active region even if the
16280 cursor moves across a special context.
16282 @item @file{CUA.el} by Kim. F. Storm
16283 @cindex @file{CUA.el}
16284 @cindex Storm, Kim. F.
16285 @vindex org-replace-disputed-keys
16286 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
16287 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
16288 region. In fact, Emacs 23 has this built-in in the form of
16289 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
16290 23, you probably don't want to use another package for this purpose. However,
16291 if you prefer to leave these keys to a different package while working in
16292 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
16293 Org will move the following key bindings in Org files, and in the agenda
16294 buffer (but not during date selection).
16297 S-UP @result{} M-p S-DOWN @result{} M-n
16298 S-LEFT @result{} M-- S-RIGHT @result{} M-+
16299 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
16302 @vindex org-disputed-keys
16303 Yes, these are unfortunately more difficult to remember. If you want
16304 to have other replacement keys, look at the variable
16305 @code{org-disputed-keys}.
16307 @item @file{filladapt.el} by Kyle Jones
16308 @cindex @file{filladapt.el}
16310 Org mode tries to do the right thing when filling paragraphs, list items and
16311 other elements. Many users reported they had problems using both
16312 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
16316 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
16319 @item @file{yasnippet.el}
16320 @cindex @file{yasnippet.el}
16321 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
16322 @code{"\t"}) overrules YASnippet's access to this key. The following code
16323 fixed this problem:
16326 (add-hook 'org-mode-hook
16328 (org-set-local 'yas/trigger-key [tab])
16329 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
16332 The latest version of yasnippet doesn't play well with Org mode. If the
16333 above code does not fix the conflict, start by defining the following
16337 (defun yas/org-very-safe-expand ()
16338 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
16341 Then, tell Org mode what to do with the new function:
16344 (add-hook 'org-mode-hook
16346 (make-variable-buffer-local 'yas/trigger-key)
16347 (setq yas/trigger-key [tab])
16348 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
16349 (define-key yas/keymap [tab] 'yas/next-field)))
16352 @item @file{windmove.el} by Hovav Shacham
16353 @cindex @file{windmove.el}
16354 This package also uses the @kbd{S-<cursor>} keys, so everything written
16355 in the paragraph above about CUA mode also applies here. If you want make
16356 the windmove function active in locations where Org mode does not have
16357 special functionality on @kbd{S-@key{cursor}}, add this to your
16361 ;; Make windmove work in org-mode:
16362 (add-hook 'org-shiftup-final-hook 'windmove-up)
16363 (add-hook 'org-shiftleft-final-hook 'windmove-left)
16364 (add-hook 'org-shiftdown-final-hook 'windmove-down)
16365 (add-hook 'org-shiftright-final-hook 'windmove-right)
16368 @item @file{viper.el} by Michael Kifer
16369 @cindex @file{viper.el}
16371 Viper uses @kbd{C-c /} and therefore makes this key not access the
16372 corresponding Org mode command @code{org-sparse-tree}. You need to find
16373 another key for this command, or override the key in
16374 @code{viper-vi-global-user-map} with
16377 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
16382 @node org-crypt.el, , Interaction, Miscellaneous
16383 @section org-crypt.el
16384 @cindex @file{org-crypt.el}
16385 @cindex @code{org-decrypt-entry}
16387 Org-crypt will encrypt the text of an entry, but not the headline, or
16388 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
16391 Any text below a headline that has a @samp{:crypt:} tag will be automatically
16392 be encrypted when the file is saved. If you want to use a different tag just
16393 customize the @code{org-crypt-tag-matcher} setting.
16395 To use org-crypt it is suggested that you have the following in your
16399 (require 'org-crypt)
16400 (org-crypt-use-before-save-magic)
16401 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
16403 (setq org-crypt-key nil)
16404 ;; GPG key to use for encryption
16405 ;; Either the Key ID or set to nil to use symmetric encryption.
16407 (setq auto-save-default nil)
16408 ;; Auto-saving does not cooperate with org-crypt.el: so you need
16409 ;; to turn it off if you plan to use org-crypt.el quite often.
16410 ;; Otherwise, you'll get an (annoying) message each time you
16413 ;; To turn it off only locally, you can insert this:
16415 ;; # -*- buffer-auto-save-file-name: nil; -*-
16418 Excluding the crypt tag from inheritance prevents already encrypted text
16419 being encrypted again.
16421 @node Hacking, MobileOrg, Miscellaneous, Top
16425 This appendix covers some aspects where users can extend the functionality of
16429 * Hooks:: How to reach into Org's internals
16430 * Add-on packages:: Available extensions
16431 * Adding hyperlink types:: New custom link types
16432 * Adding export back-ends:: How to write new export back-ends
16433 * Context-sensitive commands:: How to add functionality to such commands
16434 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
16435 * Dynamic blocks:: Automatically filled blocks
16436 * Special agenda views:: Customized views
16437 * Speeding up your agendas:: Tips on how to speed up your agendas
16438 * Extracting agenda information:: Post-processing of agenda information
16439 * Using the property API:: Writing programs that use entry properties
16440 * Using the mapping API:: Mapping over all or selected entries
16443 @node Hooks, Add-on packages, Hacking, Hacking
16447 Org has a large number of hook variables that can be used to add
16448 functionality. This appendix about hacking is going to illustrate the
16449 use of some of them. A complete list of all hooks with documentation is
16450 maintained by the Worg project and can be found at
16451 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
16453 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
16454 @section Add-on packages
16455 @cindex add-on packages
16457 A large number of add-on packages have been written by various authors.
16459 These packages are not part of Emacs, but they are distributed as contributed
16460 packages with the separate release available at @uref{http://orgmode.org}.
16461 See the @file{contrib/README} file in the source code directory for a list of
16462 contributed files. You may also find some more information on the Worg page:
16463 @uref{http://orgmode.org/worg/org-contrib/}.
16465 @node Adding hyperlink types, Adding export back-ends, Add-on packages, Hacking
16466 @section Adding hyperlink types
16467 @cindex hyperlinks, adding new types
16469 Org has a large number of hyperlink types built-in
16470 (@pxref{Hyperlinks}). If you would like to add new link types, Org
16471 provides an interface for doing so. Let's look at an example file,
16472 @file{org-man.el}, that will add support for creating links like
16473 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
16477 ;;; org-man.el - Support for links to manpages in Org
16481 (org-add-link-type "man" 'org-man-open)
16482 (add-hook 'org-store-link-functions 'org-man-store-link)
16484 (defcustom org-man-command 'man
16485 "The Emacs command to be used to display a man page."
16487 :type '(choice (const man) (const woman)))
16489 (defun org-man-open (path)
16490 "Visit the manpage on PATH.
16491 PATH should be a topic that can be thrown at the man command."
16492 (funcall org-man-command path))
16494 (defun org-man-store-link ()
16495 "Store a link to a manpage."
16496 (when (memq major-mode '(Man-mode woman-mode))
16497 ;; This is a man page, we do make this link
16498 (let* ((page (org-man-get-page-name))
16499 (link (concat "man:" page))
16500 (description (format "Manpage for %s" page)))
16501 (org-store-link-props
16504 :description description))))
16506 (defun org-man-get-page-name ()
16507 "Extract the page name from the buffer name."
16508 ;; This works for both `Man-mode' and `woman-mode'.
16509 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
16510 (match-string 1 (buffer-name))
16511 (error "Cannot create link to this man page")))
16515 ;;; org-man.el ends here
16519 You would activate this new link type in @file{.emacs} with
16526 Let's go through the file and see what it does.
16529 It does @code{(require 'org)} to make sure that @file{org.el} has been
16532 The next line calls @code{org-add-link-type} to define a new link type
16533 with prefix @samp{man}. The call also contains the name of a function
16534 that will be called to follow such a link.
16536 @vindex org-store-link-functions
16537 The next line adds a function to @code{org-store-link-functions}, in
16538 order to allow the command @kbd{C-c l} to record a useful link in a
16539 buffer displaying a man page.
16542 The rest of the file defines the necessary variables and functions.
16543 First there is a customization variable that determines which Emacs
16544 command should be used to display man pages. There are two options,
16545 @code{man} and @code{woman}. Then the function to follow a link is
16546 defined. It gets the link path as an argument---in this case the link
16547 path is just a topic for the manual command. The function calls the
16548 value of @code{org-man-command} to display the man page.
16550 Finally the function @code{org-man-store-link} is defined. When you try
16551 to store a link with @kbd{C-c l}, this function will be called to
16552 try to make a link. The function must first decide if it is supposed to
16553 create the link for this buffer type; we do this by checking the value
16554 of the variable @code{major-mode}. If not, the function must exit and
16555 return the value @code{nil}. If yes, the link is created by getting the
16556 manual topic from the buffer name and prefixing it with the string
16557 @samp{man:}. Then it must call the command @code{org-store-link-props}
16558 and set the @code{:type} and @code{:link} properties. Optionally you
16559 can also set the @code{:description} property to provide a default for
16560 the link description when the link is later inserted into an Org
16561 buffer with @kbd{C-c C-l}.
16563 When it makes sense for your new link type, you may also define a function
16564 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
16565 support for inserting such a link with @kbd{C-c C-l}. Such a function should
16566 not accept any arguments, and return the full link with prefix.
16568 @node Adding export back-ends, Context-sensitive commands, Adding hyperlink types, Hacking
16569 @section Adding export back-ends
16570 @cindex Export, writing back-ends
16572 Org 8.0 comes with a completely rewritten export engine which makes it easy
16573 to write new export back-ends, either from scratch, or from deriving them
16574 from existing ones.
16576 Your two entry points are respectively @code{org-export-define-backend} and
16577 @code{org-export-define-derived-backend}. To grok these functions, you
16578 should first have a look at @file{ox-latex.el} (for how to define a new
16579 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
16580 back-end from an existing one.
16582 When creating a new back-end from scratch, the basic idea is to set the name
16583 of the back-end (as a symbol) and an an alist of elements and export
16584 functions. On top of this, you will need to set additional keywords like
16585 @code{:menu-entry} (to display the back-end in the export dispatcher),
16586 @code{:export-block} (to specify what blocks should not be exported by this
16587 back-end), and @code{:options-alist} (to let the user set export options that
16588 are specific to this back-end.)
16590 Deriving a new back-end is similar, except that you need to set
16591 @code{:translate-alist} to an alist of export functions that should be used
16592 instead of the parent back-end functions.
16594 For a complete reference documentation, see
16595 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
16596 Reference on Worg}.
16598 @node Context-sensitive commands, Tables in arbitrary syntax, Adding export back-ends, Hacking
16599 @section Context-sensitive commands
16600 @cindex context-sensitive commands, hooks
16601 @cindex add-ons, context-sensitive commands
16602 @vindex org-ctrl-c-ctrl-c-hook
16604 Org has several commands that act differently depending on context. The most
16605 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
16606 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
16608 Add-ons can tap into this functionality by providing a function that detects
16609 special context for that add-on and executes functionality appropriate for
16610 the context. Here is an example from Dan Davison's @file{org-R.el} which
16611 allows you to evaluate commands based on the @file{R} programming language
16612 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
16613 described in @ref{Working With Source Code} and is now obsolete.}. For this
16614 package, special contexts are lines that start with @code{#+R:} or
16618 (defun org-R-apply-maybe ()
16619 "Detect if this is context for org-R and execute R commands."
16620 (if (save-excursion
16621 (beginning-of-line 1)
16622 (looking-at "#\\+RR?:"))
16623 (progn (call-interactively 'org-R-apply)
16624 t) ;; to signal that we took action
16625 nil)) ;; to signal that we did not
16627 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
16630 The function first checks if the cursor is in such a line. If that is the
16631 case, @code{org-R-apply} is called and the function returns @code{t} to
16632 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
16633 contexts. If the function finds it should do nothing locally, it returns
16634 @code{nil} so that other, similar functions can have a try.
16637 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
16638 @section Tables and lists in arbitrary syntax
16639 @cindex tables, in other modes
16640 @cindex lists, in other modes
16641 @cindex Orgtbl mode
16643 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
16644 frequent feature request has been to make it work with native tables in
16645 specific languages, for example @LaTeX{}. However, this is extremely
16646 hard to do in a general way, would lead to a customization nightmare,
16647 and would take away much of the simplicity of the Orgtbl mode table
16650 This appendix describes a different approach. We keep the Orgtbl mode
16651 table in its native format (the @i{source table}), and use a custom
16652 function to @i{translate} the table to the correct syntax, and to
16653 @i{install} it in the right location (the @i{target table}). This puts
16654 the burden of writing conversion functions on the user, but it allows
16655 for a very flexible system.
16657 Bastien added the ability to do the same with lists, in Orgstruct mode. You
16658 can use Org's facilities to edit and structure lists by turning
16659 @code{orgstruct-mode} on, then locally exporting such lists in another format
16660 (HTML, @LaTeX{} or Texinfo.)
16664 * Radio tables:: Sending and receiving radio tables
16665 * A @LaTeX{} example:: Step by step, almost a tutorial
16666 * Translator functions:: Copy and modify
16667 * Radio lists:: Sending and receiving lists
16670 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
16671 @subsection Radio tables
16672 @cindex radio tables
16674 To define the location of the target table, you first need to create two
16675 lines that are comments in the current mode, but contain magic words for
16676 Orgtbl mode to find. Orgtbl mode will insert the translated table
16677 between these lines, replacing whatever was there before. For example:
16680 /* BEGIN RECEIVE ORGTBL table_name */
16681 /* END RECEIVE ORGTBL table_name */
16685 Just above the source table, we put a special line that tells
16686 Orgtbl mode how to translate this table and where to install it. For
16690 #+ORGTBL: SEND table_name translation_function arguments....
16694 @code{table_name} is the reference name for the table that is also used
16695 in the receiver lines. @code{translation_function} is the Lisp function
16696 that does the translation. Furthermore, the line can contain a list of
16697 arguments (alternating key and value) at the end. The arguments will be
16698 passed as a property list to the translation function for
16699 interpretation. A few standard parameters are already recognized and
16700 acted upon before the translation function is called:
16704 Skip the first N lines of the table. Hlines do count as separate lines for
16707 @item :skipcols (n1 n2 ...)
16708 List of columns that should be skipped. If the table has a column with
16709 calculation marks, that column is automatically discarded as well.
16710 Please note that the translator function sees the table @emph{after} the
16711 removal of these columns, the function never knows that there have been
16712 additional columns.
16715 When non-@code{nil}, do not escape special characters @code{&%#_^} when exporting
16716 the table. The default value is @code{nil}.
16720 The one problem remaining is how to keep the source table in the buffer
16721 without disturbing the normal workings of the file, for example during
16722 compilation of a C file or processing of a @LaTeX{} file. There are a
16723 number of different solutions:
16727 The table could be placed in a block comment if that is supported by the
16728 language. For example, in C mode you could wrap the table between
16729 @samp{/*} and @samp{*/} lines.
16731 Sometimes it is possible to put the table after some kind of @i{END}
16732 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
16735 You can just comment the table line-by-line whenever you want to process
16736 the file, and uncomment it whenever you need to edit the table. This
16737 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
16738 makes this comment-toggling very easy, in particular if you bind it to a
16742 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
16743 @subsection A @LaTeX{} example of radio tables
16744 @cindex @LaTeX{}, and Orgtbl mode
16746 The best way to wrap the source table in @LaTeX{} is to use the
16747 @code{comment} environment provided by @file{comment.sty}. It has to be
16748 activated by placing @code{\usepackage@{comment@}} into the document
16749 header. Orgtbl mode can insert a radio table skeleton@footnote{By
16750 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
16751 variable @code{orgtbl-radio-tables} to install templates for other
16752 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
16753 be prompted for a table name, let's say we use @samp{salesfigures}. You
16754 will then get the following template:
16756 @cindex #+ORGTBL, SEND
16758 % BEGIN RECEIVE ORGTBL salesfigures
16759 % END RECEIVE ORGTBL salesfigures
16761 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16767 @vindex @LaTeX{}-verbatim-environments
16768 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
16769 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
16770 into the receiver location with name @code{salesfigures}. You may now
16771 fill in the table---feel free to use the spreadsheet features@footnote{If
16772 the @samp{#+TBLFM} line contains an odd number of dollar characters,
16773 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
16774 example you can fix this by adding an extra line inside the
16775 @code{comment} environment that is used to balance the dollar
16776 expressions. If you are using AUC@TeX{} with the font-latex library, a
16777 much better solution is to add the @code{comment} environment to the
16778 variable @code{LaTeX-verbatim-environments}.}:
16781 % BEGIN RECEIVE ORGTBL salesfigures
16782 % END RECEIVE ORGTBL salesfigures
16784 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16785 | Month | Days | Nr sold | per day |
16786 |-------+------+---------+---------|
16787 | Jan | 23 | 55 | 2.4 |
16788 | Feb | 21 | 16 | 0.8 |
16789 | March | 22 | 278 | 12.6 |
16790 #+TBLFM: $4=$3/$2;%.1f
16791 % $ (optional extra dollar to keep font-lock happy, see footnote)
16796 When you are done, press @kbd{C-c C-c} in the table to get the converted
16797 table inserted between the two marker lines.
16799 Now let's assume you want to make the table header by hand, because you
16800 want to control how columns are aligned, etc. In this case we make sure
16801 that the table translator skips the first 2 lines of the source
16802 table, and tell the command to work as a @i{splice}, i.e., to not produce
16803 header and footer commands of the target table:
16806 \begin@{tabular@}@{lrrr@}
16807 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
16808 % BEGIN RECEIVE ORGTBL salesfigures
16809 % END RECEIVE ORGTBL salesfigures
16813 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
16814 | Month | Days | Nr sold | per day |
16815 |-------+------+---------+---------|
16816 | Jan | 23 | 55 | 2.4 |
16817 | Feb | 21 | 16 | 0.8 |
16818 | March | 22 | 278 | 12.6 |
16819 #+TBLFM: $4=$3/$2;%.1f
16823 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
16824 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
16825 and marks horizontal lines with @code{\hline}. Furthermore, it
16826 interprets the following parameters (see also @pxref{Translator functions}):
16829 @item :splice nil/t
16830 When set to t, return only table body lines, don't wrap them into a
16831 tabular environment. Default is @code{nil}.
16834 A format to be used to wrap each field, it should contain @code{%s} for the
16835 original field value. For example, to wrap each field value in dollars,
16836 you could use @code{:fmt "$%s$"}. This may also be a property list with
16837 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
16838 A function of one argument can be used in place of the strings; the
16839 function must return a formatted string.
16842 Use this format to print numbers with exponentials. The format should
16843 have @code{%s} twice for inserting mantissa and exponent, for example
16844 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
16845 may also be a property list with column numbers and formats, for example
16846 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
16847 @code{efmt} has been applied to a value, @code{fmt} will also be
16848 applied. Similar to @code{fmt}, functions of two arguments can be
16849 supplied instead of strings.
16852 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
16853 @subsection Translator functions
16854 @cindex HTML, and Orgtbl mode
16855 @cindex translator function
16857 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
16858 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
16859 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
16860 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
16861 code that produces tables during HTML export.}, these all use a generic
16862 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
16863 itself is a very short function that computes the column definitions for the
16864 @code{tabular} environment, defines a few field and line separators and then
16865 hands processing over to the generic translator. Here is the entire code:
16869 (defun orgtbl-to-latex (table params)
16870 "Convert the Orgtbl mode TABLE to LaTeX."
16871 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
16872 org-table-last-alignment ""))
16875 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
16876 :tend "\\end@{tabular@}"
16877 :lstart "" :lend " \\\\" :sep " & "
16878 :efmt "%s\\,(%s)" :hline "\\hline")))
16879 (orgtbl-to-generic table (org-combine-plists params2 params))))
16883 As you can see, the properties passed into the function (variable
16884 @var{PARAMS}) are combined with the ones newly defined in the function
16885 (variable @var{PARAMS2}). The ones passed into the function (i.e., the
16886 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
16887 would like to use the @LaTeX{} translator, but wanted the line endings to
16888 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
16889 overrule the default with
16892 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
16895 For a new language, you can either write your own converter function in
16896 analogy with the @LaTeX{} translator, or you can use the generic function
16897 directly. For example, if you have a language where a table is started
16898 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
16899 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
16900 separator is a TAB, you could call the generic translator like this (on
16904 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
16905 :lstart "!BL! " :lend " !EL!" :sep "\t"
16909 Please check the documentation string of the function
16910 @code{orgtbl-to-generic} for a full list of parameters understood by
16911 that function, and remember that you can pass each of them into
16912 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
16913 using the generic function.
16915 Of course you can also write a completely new function doing complicated
16916 things the generic translator cannot do. A translator function takes
16917 two arguments. The first argument is the table, a list of lines, each
16918 line either the symbol @code{hline} or a list of fields. The second
16919 argument is the property list containing all parameters specified in the
16920 @samp{#+ORGTBL: SEND} line. The function must return a single string
16921 containing the formatted table. If you write a generally useful
16922 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
16923 others can benefit from your work.
16925 @node Radio lists, , Translator functions, Tables in arbitrary syntax
16926 @subsection Radio lists
16927 @cindex radio lists
16928 @cindex org-list-insert-radio-list
16930 Sending and receiving radio lists works exactly the same way as sending and
16931 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
16932 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
16933 @code{org-list-insert-radio-list}.
16935 Here are the differences with radio tables:
16939 Orgstruct mode must be active.
16941 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
16943 The available translation functions for radio lists don't take
16946 @kbd{C-c C-c} will work when pressed on the first item of the list.
16949 Here is a @LaTeX{} example. Let's say that you have this in your
16954 % BEGIN RECEIVE ORGLST to-buy
16955 % END RECEIVE ORGLST to-buy
16957 #+ORGLST: SEND to-buy org-list-to-latex
16966 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
16967 @LaTeX{} list between the two marker lines.
16969 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
16970 @section Dynamic blocks
16971 @cindex dynamic blocks
16973 Org documents can contain @emph{dynamic blocks}. These are
16974 specially marked regions that are updated by some user-written function.
16975 A good example for such a block is the clock table inserted by the
16976 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
16978 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
16979 to the block and can also specify parameters for the function producing
16980 the content of the block.
16982 @cindex #+BEGIN:dynamic block
16984 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
16989 Dynamic blocks are updated with the following commands
16992 @orgcmd{C-c C-x C-u,org-dblock-update}
16993 Update dynamic block at point.
16994 @orgkey{C-u C-c C-x C-u}
16995 Update all dynamic blocks in the current file.
16998 Updating a dynamic block means to remove all the text between BEGIN and
16999 END, parse the BEGIN line for parameters and then call the specific
17000 writer function for this block to insert the new content. If you want
17001 to use the original content in the writer function, you can use the
17002 extra parameter @code{:content}.
17004 For a block with name @code{myblock}, the writer function is
17005 @code{org-dblock-write:myblock} with as only parameter a property list
17006 with the parameters given in the begin line. Here is a trivial example
17007 of a block that keeps track of when the block update function was last
17011 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17017 The corresponding block writer function could look like this:
17020 (defun org-dblock-write:block-update-time (params)
17021 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17022 (insert "Last block update at: "
17023 (format-time-string fmt (current-time)))))
17026 If you want to make sure that all dynamic blocks are always up-to-date,
17027 you could add the function @code{org-update-all-dblocks} to a hook, for
17028 example @code{before-save-hook}. @code{org-update-all-dblocks} is
17029 written in a way such that it does nothing in buffers that are not in
17032 You can narrow the current buffer to the current dynamic block (like any
17033 other block) with @code{org-narrow-to-block}.
17035 @node Special agenda views, Speeding up your agendas, Dynamic blocks, Hacking
17036 @section Special agenda views
17037 @cindex agenda views, user-defined
17039 @vindex org-agenda-skip-function
17040 @vindex org-agenda-skip-function-global
17041 Org provides a special hook that can be used to narrow down the selection
17042 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17043 @code{agenda*} view is the same than @code{agenda} except that it only
17044 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17045 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17046 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
17047 specify a function that is used at each match to verify if the match should
17048 indeed be part of the agenda view, and if not, how much should be skipped.
17049 You can specify a global condition that will be applied to all agenda views,
17050 this condition would be stored in the variable
17051 @code{org-agenda-skip-function-global}. More commonly, such a definition is
17052 applied only to specific custom searches, using
17053 @code{org-agenda-skip-function}.
17055 Let's say you want to produce a list of projects that contain a WAITING
17056 tag anywhere in the project tree. Let's further assume that you have
17057 marked all tree headings that define a project with the TODO keyword
17058 PROJECT@. In this case you would run a TODO search for the keyword
17059 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17060 the subtree belonging to the project line.
17062 To achieve this, you must write a function that searches the subtree for
17063 the tag. If the tag is found, the function must return @code{nil} to
17064 indicate that this match should not be skipped. If there is no such
17065 tag, return the location of the end of the subtree, to indicate that
17066 search should continue from there.
17069 (defun my-skip-unless-waiting ()
17070 "Skip trees that are not waiting"
17071 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17072 (if (re-search-forward ":waiting:" subtree-end t)
17073 nil ; tag found, do not skip
17074 subtree-end))) ; tag not found, continue after end of subtree
17077 Now you may use this function in an agenda custom command, for example
17081 (org-add-agenda-custom-command
17082 '("b" todo "PROJECT"
17083 ((org-agenda-skip-function 'my-skip-unless-waiting)
17084 (org-agenda-overriding-header "Projects waiting for something: "))))
17087 @vindex org-agenda-overriding-header
17088 Note that this also binds @code{org-agenda-overriding-header} to get a
17089 meaningful header in the agenda view.
17091 @vindex org-odd-levels-only
17092 @vindex org-agenda-skip-function
17093 A general way to create custom searches is to base them on a search for
17094 entries with a certain level limit. If you want to study all entries with
17095 your custom search function, simply do a search for
17096 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
17097 level number corresponds to order in the hierarchy, not to the number of
17098 stars.}, and then use @code{org-agenda-skip-function} to select the entries
17099 you really want to have.
17101 You may also put a Lisp form into @code{org-agenda-skip-function}. In
17102 particular, you may use the functions @code{org-agenda-skip-entry-if}
17103 and @code{org-agenda-skip-subtree-if} in this form, for example:
17106 @item (org-agenda-skip-entry-if 'scheduled)
17107 Skip current entry if it has been scheduled.
17108 @item (org-agenda-skip-entry-if 'notscheduled)
17109 Skip current entry if it has not been scheduled.
17110 @item (org-agenda-skip-entry-if 'deadline)
17111 Skip current entry if it has a deadline.
17112 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
17113 Skip current entry if it has a deadline, or if it is scheduled.
17114 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
17115 Skip current entry if the TODO keyword is TODO or WAITING.
17116 @item (org-agenda-skip-entry-if 'todo 'done)
17117 Skip current entry if the TODO keyword marks a DONE state.
17118 @item (org-agenda-skip-entry-if 'timestamp)
17119 Skip current entry if it has any timestamp, may also be deadline or scheduled.
17120 @anchor{x-agenda-skip-entry-regexp}
17121 @item (org-agenda-skip-entry-if 'regexp "regular expression")
17122 Skip current entry if the regular expression matches in the entry.
17123 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
17124 Skip current entry unless the regular expression matches.
17125 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
17126 Same as above, but check and skip the entire subtree.
17129 Therefore we could also have written the search for WAITING projects
17130 like this, even without defining a special function:
17133 (org-add-agenda-custom-command
17134 '("b" todo "PROJECT"
17135 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
17136 'regexp ":waiting:"))
17137 (org-agenda-overriding-header "Projects waiting for something: "))))
17140 @node Speeding up your agendas, Extracting agenda information, Special agenda views, Hacking
17141 @section Speeding up your agendas
17142 @cindex agenda views, optimization
17144 When your Org files grow in both number and size, agenda commands may start
17145 to become slow. Below are some tips on how to speed up the agenda commands.
17149 Reduce the number of Org agenda files: this will reduce the slowliness caused
17150 by accessing to a hard drive.
17152 Reduce the number of DONE and archived headlines: this way the agenda does
17153 not need to skip them.
17155 @vindex org-agenda-dim-blocked-tasks
17156 Inhibit the dimming of blocked tasks:
17158 (setq org-agenda-dim-blocked-tasks nil)
17161 @vindex org-startup-folded
17162 @vindex org-agenda-inhibit-startup
17163 Inhibit agenda files startup options:
17165 (setq org-agenda-inhibit-startup nil)
17168 @vindex org-agenda-show-inherited-tags
17169 @vindex org-agenda-use-tag-inheritance
17170 Disable tag inheritance in agenda:
17172 (setq org-agenda-use-tag-inheritance nil)
17176 You can set these options for specific agenda views only. See the docstrings
17177 of these variables for details on why they affect the agenda generation, and
17178 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
17179 page} for further explanations.
17181 @node Extracting agenda information, Using the property API, Speeding up your agendas, Hacking
17182 @section Extracting agenda information
17183 @cindex agenda, pipe
17184 @cindex Scripts, for agenda processing
17186 @vindex org-agenda-custom-commands
17187 Org provides commands to access agenda information for the command
17188 line in Emacs batch mode. This extracted information can be sent
17189 directly to a printer, or it can be read by a program that does further
17190 processing of the data. The first of these commands is the function
17191 @code{org-batch-agenda}, that produces an agenda view and sends it as
17192 ASCII text to STDOUT@. The command takes a single string as parameter.
17193 If the string has length 1, it is used as a key to one of the commands
17194 you have configured in @code{org-agenda-custom-commands}, basically any
17195 key you can use after @kbd{C-c a}. For example, to directly print the
17196 current TODO list, you could use
17199 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
17202 If the parameter is a string with 2 or more characters, it is used as a
17203 tags/TODO match string. For example, to print your local shopping list
17204 (all items with the tag @samp{shop}, but excluding the tag
17205 @samp{NewYork}), you could use
17208 emacs -batch -l ~/.emacs \
17209 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
17213 You may also modify parameters on the fly like this:
17216 emacs -batch -l ~/.emacs \
17217 -eval '(org-batch-agenda "a" \
17218 org-agenda-span (quote month) \
17219 org-agenda-include-diary nil \
17220 org-agenda-files (quote ("~/org/project.org")))' \
17225 which will produce a 30-day agenda, fully restricted to the Org file
17226 @file{~/org/projects.org}, not even including the diary.
17228 If you want to process the agenda data in more sophisticated ways, you
17229 can use the command @code{org-batch-agenda-csv} to get a comma-separated
17230 list of values for each agenda item. Each line in the output will
17231 contain a number of fields separated by commas. The fields in a line
17235 category @r{The category of the item}
17236 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
17237 type @r{The type of the agenda entry, can be}
17238 todo @r{selected in TODO match}
17239 tagsmatch @r{selected in tags match}
17240 diary @r{imported from diary}
17241 deadline @r{a deadline}
17242 scheduled @r{scheduled}
17243 timestamp @r{appointment, selected by timestamp}
17244 closed @r{entry was closed on date}
17245 upcoming-deadline @r{warning about nearing deadline}
17246 past-scheduled @r{forwarded scheduled item}
17247 block @r{entry has date block including date}
17248 todo @r{The TODO keyword, if any}
17249 tags @r{All tags including inherited ones, separated by colons}
17250 date @r{The relevant date, like 2007-2-14}
17251 time @r{The time, like 15:00-16:50}
17252 extra @r{String with extra planning info}
17253 priority-l @r{The priority letter if any was given}
17254 priority-n @r{The computed numerical priority}
17258 Time and date will only be given if a timestamp (or deadline/scheduled)
17259 led to the selection of the item.
17261 A CSV list like this is very easy to use in a post-processing script.
17262 For example, here is a Perl program that gets the TODO list from
17263 Emacs/Org and prints all the items, preceded by a checkbox:
17268 # define the Emacs command to run
17269 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
17271 # run it and capture the output
17272 $agenda = qx@{$cmd 2>/dev/null@};
17274 # loop over all lines
17275 foreach $line (split(/\n/,$agenda)) @{
17276 # get the individual values
17277 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
17278 $priority_l,$priority_n) = split(/,/,$line);
17279 # process and print
17280 print "[ ] $head\n";
17284 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
17285 @section Using the property API
17286 @cindex API, for properties
17287 @cindex properties, API
17289 Here is a description of the functions that can be used to work with
17292 @defun org-entry-properties &optional pom which
17293 Get all properties of the entry at point-or-marker POM.@*
17294 This includes the TODO keyword, the tags, time strings for deadline,
17295 scheduled, and clocking, and any additional properties defined in the
17296 entry. The return value is an alist. Keys may occur multiple times
17297 if the property key was used several times.@*
17298 POM may also be @code{nil}, in which case the current entry is used.
17299 If WHICH is @code{nil} or `all', get all properties. If WHICH is
17300 `special' or `standard', only get that subclass.
17302 @vindex org-use-property-inheritance
17303 @findex org-insert-property-drawer
17304 @defun org-entry-get pom property &optional inherit
17305 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
17306 this only looks at properties defined locally in the entry. If @code{INHERIT}
17307 is non-@code{nil} and the entry does not have the property, then also check
17308 higher levels of the hierarchy. If @code{INHERIT} is the symbol
17309 @code{selective}, use inheritance if and only if the setting of
17310 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
17313 @defun org-entry-delete pom property
17314 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
17317 @defun org-entry-put pom property value
17318 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
17321 @defun org-buffer-property-keys &optional include-specials
17322 Get all property keys in the current buffer.
17325 @defun org-insert-property-drawer
17326 Insert a property drawer for the current entry. Also
17329 @defun org-entry-put-multivalued-property pom property &rest values
17330 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
17331 @code{VALUES} should be a list of strings. They will be concatenated, with
17332 spaces as separators.
17335 @defun org-entry-get-multivalued-property pom property
17336 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17337 list of values and return the values as a list of strings.
17340 @defun org-entry-add-to-multivalued-property pom property value
17341 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17342 list of values and make sure that @code{VALUE} is in this list.
17345 @defun org-entry-remove-from-multivalued-property pom property value
17346 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17347 list of values and make sure that @code{VALUE} is @emph{not} in this list.
17350 @defun org-entry-member-in-multivalued-property pom property value
17351 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17352 list of values and check if @code{VALUE} is in this list.
17355 @defopt org-property-allowed-value-functions
17356 Hook for functions supplying allowed values for a specific property.
17357 The functions must take a single argument, the name of the property, and
17358 return a flat list of allowed values. If @samp{:ETC} is one of
17359 the values, use the values as completion help, but allow also other values
17360 to be entered. The functions must return @code{nil} if they are not
17361 responsible for this property.
17364 @node Using the mapping API, , Using the property API, Hacking
17365 @section Using the mapping API
17366 @cindex API, for mapping
17367 @cindex mapping entries, API
17369 Org has sophisticated mapping capabilities to find all entries satisfying
17370 certain criteria. Internally, this functionality is used to produce agenda
17371 views, but there is also an API that can be used to execute arbitrary
17372 functions for each or selected entries. The main entry point for this API
17375 @defun org-map-entries func &optional match scope &rest skip
17376 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
17378 @code{FUNC} is a function or a Lisp form. The function will be called
17379 without arguments, with the cursor positioned at the beginning of the
17380 headline. The return values of all calls to the function will be collected
17381 and returned as a list.
17383 The call to @code{FUNC} will be wrapped into a save-excursion form, so
17384 @code{FUNC} does not need to preserve point. After evaluation, the cursor
17385 will be moved to the end of the line (presumably of the headline of the
17386 processed entry) and search continues from there. Under some circumstances,
17387 this may not produce the wanted results. For example, if you have removed
17388 (e.g., archived) the current (sub)tree it could mean that the next entry will
17389 be skipped entirely. In such cases, you can specify the position from where
17390 search should continue by making @code{FUNC} set the variable
17391 @code{org-map-continue-from} to the desired buffer position.
17393 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
17394 view. Only headlines that are matched by this query will be considered
17395 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
17396 headlines will be visited by the iteration.
17398 @code{SCOPE} determines the scope of this command. It can be any of:
17401 nil @r{the current buffer, respecting the restriction if any}
17402 tree @r{the subtree started with the entry at point}
17403 region @r{The entries within the active region, if any}
17404 file @r{the current buffer, without restriction}
17406 @r{the current buffer, and any archives associated with it}
17407 agenda @r{all agenda files}
17408 agenda-with-archives
17409 @r{all agenda files with any archive files associated with them}
17411 @r{if this is a list, all files in the list will be scanned}
17414 The remaining args are treated as settings for the skipping facilities of
17415 the scanner. The following items can be given here:
17417 @vindex org-agenda-skip-function
17419 archive @r{skip trees with the archive tag}
17420 comment @r{skip trees with the COMMENT keyword}
17421 function or Lisp form
17422 @r{will be used as value for @code{org-agenda-skip-function},}
17423 @r{so whenever the function returns t, FUNC}
17424 @r{will not be called for that entry and search will}
17425 @r{continue from the point where the function leaves it}
17429 The function given to that mapping routine can really do anything you like.
17430 It can use the property API (@pxref{Using the property API}) to gather more
17431 information about the entry, or in order to change metadata in the entry.
17432 Here are a couple of functions that might be handy:
17434 @defun org-todo &optional arg
17435 Change the TODO state of the entry. See the docstring of the functions for
17436 the many possible values for the argument @code{ARG}.
17439 @defun org-priority &optional action
17440 Change the priority of the entry. See the docstring of this function for the
17441 possible values for @code{ACTION}.
17444 @defun org-toggle-tag tag &optional onoff
17445 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
17446 either @code{on} or @code{off} will not toggle tag, but ensure that it is
17451 Promote the current entry.
17455 Demote the current entry.
17458 Here is a simple example that will turn all entries in the current file with
17459 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
17460 Entries in comment trees and in archive trees will be ignored.
17464 '(org-todo "UPCOMING")
17465 "+TOMORROW" 'file 'archive 'comment)
17468 The following example counts the number of entries with TODO keyword
17469 @code{WAITING}, in all agenda files.
17472 (length (org-map-entries t "/+WAITING" 'agenda))
17475 @node MobileOrg, History and Acknowledgments, Hacking, Top
17476 @appendix MobileOrg
17480 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
17481 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
17482 capture support for an Org mode system rooted on a ``real'' computer. It
17483 does also allow you to record changes to existing entries. The
17484 @uref{https://github.com/MobileOrg/, iOS implementation} for the
17485 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
17486 and is now in the hands Sean Escriva. Android users should check out
17487 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
17488 by Matt Jones. The two implementations are not identical but offer similar
17491 This appendix describes the support Org has for creating agenda views in a
17492 format that can be displayed by @i{MobileOrg}, and for integrating notes
17493 captured and changes made by @i{MobileOrg} into the main system.
17495 For changing tags and TODO states in MobileOrg, you should have set up the
17496 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
17497 cover all important tags and TODO keywords, even if individual files use only
17498 part of these. MobileOrg will also offer you states and tags set up with
17499 in-buffer settings, but it will understand the logistics of TODO state
17500 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
17501 (@pxref{Setting tags}) only for those set in these variables.
17504 * Setting up the staging area:: Where to interact with the mobile device
17505 * Pushing to MobileOrg:: Uploading Org files and agendas
17506 * Pulling from MobileOrg:: Integrating captured and flagged items
17509 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
17510 @section Setting up the staging area
17512 MobileOrg needs to interact with Emacs through a directory on a server. If you
17513 are using a public server, you should consider to encrypt the files that are
17514 uploaded to the server. This can be done with Org mode 7.02 and with
17515 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
17516 installation on your system. To turn on encryption, set a password in
17517 @i{MobileOrg} and, on the Emacs side, configure the variable
17518 @code{org-mobile-use-encryption}@footnote{If you can safely store the
17519 password in your Emacs setup, you might also want to configure
17520 @code{org-mobile-encryption-password}. Please read the docstring of that
17521 variable. Note that encryption will apply only to the contents of the
17522 @file{.org} files. The file names themselves will remain visible.}.
17524 The easiest way to create that directory is to use a free
17525 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
17526 Dropbox, or if your version of MobileOrg does not support it, you can use a
17527 webdav server. For more information, check out the documentation of MobileOrg and also this
17528 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
17529 When MobileOrg first connects to your Dropbox, it will create a directory
17530 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
17534 (setq org-mobile-directory "~/Dropbox/MobileOrg")
17537 Org mode has commands to put files for @i{MobileOrg} into that directory,
17538 and to read captured notes from there.
17540 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
17541 @section Pushing to MobileOrg
17543 This operation copies all files currently listed in @code{org-mobile-files}
17544 to the directory @code{org-mobile-directory}. By default this list contains
17545 all agenda files (as listed in @code{org-agenda-files}), but additional files
17546 can be included by customizing @code{org-mobile-files}. File names will be
17547 staged with paths relative to @code{org-directory}, so all files should be
17548 inside this directory@footnote{Symbolic links in @code{org-directory} need to
17549 have the same name than their targets.}.
17551 The push operation also creates a special Org file @file{agendas.org} with
17552 all custom agenda view defined by the user@footnote{While creating the
17553 agendas, Org mode will force ID properties on all referenced entries, so that
17554 these entries can be uniquely identified if @i{MobileOrg} flags them for
17555 further action. If you do not want to get these properties in so many
17556 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
17557 to @code{nil}. Org mode will then rely on outline paths, in the hope that
17558 these will be unique enough.}.
17560 Finally, Org writes the file @file{index.org}, containing links to all other
17561 files. @i{MobileOrg} first reads this file from the server, and then
17562 downloads all agendas and Org files listed in it. To speed up the download,
17563 MobileOrg will only read files whose checksums@footnote{Checksums are stored
17564 automatically in the file @file{checksums.dat}} have changed.
17566 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
17567 @section Pulling from MobileOrg
17569 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
17570 files for viewing. It also appends captured entries and pointers to flagged
17571 and changed entries to the file @file{mobileorg.org} on the server. Org has
17572 a @emph{pull} operation that integrates this information into an inbox file
17573 and operates on the pointers to flagged entries. Here is how it works:
17577 Org moves all entries found in
17578 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
17579 operation.} and appends them to the file pointed to by the variable
17580 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
17581 will be a top-level entry in the inbox file.
17583 After moving the entries, Org will attempt to implement the changes made in
17584 @i{MobileOrg}. Some changes are applied directly and without user
17585 interaction. Examples are all changes to tags, TODO state, headline and body
17586 text that can be cleanly applied. Entries that have been flagged for further
17587 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
17588 again. When there is a problem finding an entry or applying the change, the
17589 pointer entry will remain in the inbox and will be marked with an error
17590 message. You need to later resolve these issues by hand.
17592 Org will then generate an agenda view with all flagged entries. The user
17593 should then go through these entries and do whatever actions are necessary.
17594 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
17595 will be displayed in the echo area when the cursor is on the corresponding
17601 Pressing @kbd{?} in that special agenda will display the full flagging note in
17602 another window and also push it onto the kill ring. So you could use @kbd{?
17603 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
17604 Pressing @kbd{?} twice in succession will offer to remove the
17605 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
17606 in a property). In this way you indicate that the intended processing for
17607 this flagged entry is finished.
17612 If you are not able to process all flagged entries directly, you can always
17613 return to this agenda view@footnote{Note, however, that there is a subtle
17614 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
17615 is guaranteed to search all files that have been addressed by the last pull.
17616 This might include a file that is not currently in your list of agenda files.
17617 If you later use @kbd{C-c a ?} to regenerate the view, only the current
17618 agenda files will be searched.} using @kbd{C-c a ?}.
17620 @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
17621 @appendix History and acknowledgments
17622 @cindex acknowledgments
17626 @section From Carsten
17628 Org was born in 2003, out of frustration over the user interface of the Emacs
17629 Outline mode. I was trying to organize my notes and projects, and using
17630 Emacs seemed to be the natural way to go. However, having to remember eleven
17631 different commands with two or three keys per command, only to hide and show
17632 parts of the outline tree, that seemed entirely unacceptable to me. Also,
17633 when using outlines to take notes, I constantly wanted to restructure the
17634 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
17635 cycling} and @emph{structure editing} were originally implemented in the
17636 package @file{outline-magic.el}, but quickly moved to the more general
17637 @file{org.el}. As this environment became comfortable for project planning,
17638 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
17639 @emph{table support}. These areas highlighted the two main goals that Org
17640 still has today: to be a new, outline-based, plain text mode with innovative
17641 and intuitive editing features, and to incorporate project planning
17642 functionality directly into a notes file.
17644 Since the first release, literally thousands of emails to me or to
17645 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
17646 reports, feedback, new ideas, and sometimes patches and add-on code.
17647 Many thanks to everyone who has helped to improve this package. I am
17648 trying to keep here a list of the people who had significant influence
17649 in shaping one or more aspects of Org. The list may not be
17650 complete, if I have forgotten someone, please accept my apologies and
17653 Before I get to this list, a few special mentions are in order:
17656 @item Bastien Guerry
17657 Bastien has written a large number of extensions to Org (most of them
17658 integrated into the core by now), including the @LaTeX{} exporter and the plain
17659 list parser. His support during the early days, when he basically acted as
17660 co-maintainer, was central to the success of this project. Bastien also
17661 invented Worg, helped establishing the Web presence of Org, and sponsored
17662 hosting costs for the orgmode.org website.
17663 @item Eric Schulte and Dan Davison
17664 Eric and Dan are jointly responsible for the Org-babel system, which turns
17665 Org into a multi-language environment for evaluating code and doing literate
17666 programming and reproducible research.
17668 John has contributed a number of great ideas and patches directly to Org,
17669 including the attachment system (@file{org-attach.el}), integration with
17670 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
17671 items, habit tracking (@file{org-habits.el}), and encryption
17672 (@file{org-crypt.el}). Also, the capture system is really an extended copy
17673 of his great @file{remember.el}.
17674 @item Sebastian Rose
17675 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
17676 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
17677 higher level. He also wrote @file{org-info.js}, a Java script for displaying
17678 web pages derived from Org using an Info-like or a folding interface with
17679 single-key navigation.
17682 @noindent See below for the full list of contributions! Again, please
17683 let me know what I am missing here!
17685 @section From Bastien
17687 I (Bastien) have been maintaining Org since January 2011. This appendix
17688 would not be complete without adding a few more acknowledgements and thanks
17689 to Carsten's ones above.
17691 I am first grateful to Carsten for his trust while handing me over the
17692 maintainership of Org. His unremitting support is what really helped me
17693 getting more confident over time, with both the community and the code.
17695 When I took over maintainership, I knew I would have to make Org more
17696 collaborative than ever, as I would have to rely on people that are more
17697 knowledgeable than I am on many parts of the code. Here is a list of the
17698 persons I could rely on, they should really be considered co-maintainers,
17699 either of the code or the community:
17703 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
17704 from worrying about possible bugs here and let me focus on other parts.
17706 @item Nicolas Goaziou
17707 Nicolas is maintaining the consistency of the deepest parts of Org. His
17708 work on @file{org-element.el} and @file{ox.el} has been outstanding, and
17709 opened the doors for many new ideas and features. He rewrote many of the
17710 old exporters to use the new export engine, and helped with documenting
17711 this major change. More importantly (if that's possible), he has been more
17712 than reliable during all the work done for Org 8.0, and always very
17713 reactive on the mailing list.
17716 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
17717 into a flexible and conceptually clean process. He patiently coped with the
17718 many hiccups that such a change can create for users.
17721 The Org mode mailing list would not be such a nice place without Nick, who
17722 patiently helped users so many times. It is impossible to overestimate such
17723 a great help, and the list would not be so active without him.
17726 I received support from so many users that it is clearly impossible to be
17727 fair when shortlisting a few of them, but Org's history would not be
17728 complete if the ones above were not mentioned in this manual.
17730 @section List of contributions
17735 @i{Russel Adams} came up with the idea for drawers.
17737 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
17738 feedback on many features and several patches.
17740 @i{Luis Anaya} wrote @file{ox-man.el}.
17742 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
17744 @i{Michael Brand} helped by reporting many bugs and testing many features.
17745 He also implemented the distinction between empty fields and 0-value fields
17746 in Org's spreadsheets.
17748 @i{Christophe Bataillon} created the great unicorn logo that we use on the
17751 @i{Alex Bochannek} provided a patch for rounding timestamps.
17753 @i{Jan Böcker} wrote @file{org-docview.el}.
17755 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
17757 @i{Tom Breton} wrote @file{org-choose.el}.
17759 @i{Charles Cave}'s suggestion sparked the implementation of templates
17760 for Remember, which are now templates for capture.
17762 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
17765 @i{Gregory Chernov} patched support for Lisp forms into table
17766 calculations and improved XEmacs compatibility, in particular by porting
17767 @file{nouline.el} to XEmacs.
17769 @i{Sacha Chua} suggested copying some linking code from Planner.
17771 @i{Toby S. Cubitt} contributed to the code for clock formats.
17773 @i{Baoqiu Cui} contributed the DocBook exporter. It has been deleted from
17774 Org 8.0: you can now export to Texinfo and export the @file{.texi} file to
17775 DocBook using @code{makeinfo}.
17777 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
17778 came up with the idea of properties, and that there should be an API for
17781 @i{Nick Dokos} tracked down several nasty bugs.
17783 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
17784 inspired some of the early development, including HTML export. He also
17785 asked for a way to narrow wide table columns.
17787 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
17788 the Org-Babel documentation into the manual.
17790 @i{Christian Egli} converted the documentation into Texinfo format, inspired
17791 the agenda, patched CSS formatting into the HTML exporter, and wrote
17792 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
17793 @file{ox-taskjuggler.el} for Org 8.0.
17795 @i{David Emery} provided a patch for custom CSS support in exported
17798 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
17800 @i{Nic Ferrier} contributed mailcap and XOXO support.
17802 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
17804 @i{John Foerch} figured out how to make incremental search show context
17805 around a match in a hidden outline tree.
17807 @i{Raimar Finken} wrote @file{org-git-line.el}.
17809 @i{Mikael Fornius} works as a mailing list moderator.
17811 @i{Austin Frank} works as a mailing list moderator.
17813 @i{Eric Fraga} drove the development of BEAMER export with ideas and
17816 @i{Barry Gidden} did proofreading the manual in preparation for the book
17817 publication through Network Theory Ltd.
17819 @i{Niels Giesen} had the idea to automatically archive DONE trees.
17821 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
17822 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
17823 in implementing a clean framework for Org exporters.
17825 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
17827 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
17830 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
17831 task state change logging, and the clocktable. His clear explanations have
17832 been critical when we started to adopt the Git version control system.
17834 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
17837 @i{Phil Jackson} wrote @file{org-irc.el}.
17839 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
17840 folded entries, and column view for properties.
17842 @i{Matt Jones} wrote @i{MobileOrg Android}.
17844 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
17846 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
17848 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
17849 provided frequent feedback and some patches.
17851 @i{Matt Lundin} has proposed last-row references for table formulas and named
17852 invisible anchors. He has also worked a lot on the FAQ.
17854 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
17855 and is a prolific contributor on the mailing list with competent replies,
17856 small fixes and patches.
17858 @i{Jason F. McBrayer} suggested agenda export to CSV format.
17860 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
17862 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
17865 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
17868 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
17870 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
17871 and being able to quickly restrict the agenda to a subtree.
17873 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
17875 @i{Greg Newman} refreshed the unicorn logo into its current form.
17877 @i{Tim O'Callaghan} suggested in-file links, search options for general
17878 file links, and TAGS.
17880 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
17881 version of the reference card.
17883 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
17886 @i{Oliver Oppitz} suggested multi-state TODO items.
17888 @i{Scott Otterson} sparked the introduction of descriptive text for
17889 links, among other things.
17891 @i{Pete Phillips} helped during the development of the TAGS feature, and
17892 provided frequent feedback.
17894 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
17897 @i{Martin Pohlack} provided the code snippet to bundle character insertion
17898 into bundles of 20 for undo.
17900 @i{T.V. Raman} reported bugs and suggested improvements.
17902 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
17905 @i{Paul Rivier} provided the basic implementation of named footnotes. He
17906 also acted as mailing list moderator for some time.
17908 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
17910 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
17911 conflict with @file{allout.el}.
17913 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
17916 @i{Philip Rooke} created the Org reference card, provided lots
17917 of feedback, developed and applied standards to the Org documentation.
17919 @i{Christian Schlauer} proposed angular brackets around links, among
17922 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
17923 enjoy folding in non-org buffers by using Org headlines in comments.
17925 @i{Paul Sexton} wrote @file{org-ctags.el}.
17927 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
17928 @file{organizer-mode.el}.
17930 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
17931 examples, and remote highlighting for referenced code lines.
17933 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
17934 now packaged into Org's @file{contrib} directory.
17936 @i{Daniel Sinder} came up with the idea of internal archiving by locking
17939 @i{Dale Smith} proposed link abbreviations.
17941 @i{James TD Smith} has contributed a large number of patches for useful
17942 tweaks and features.
17944 @i{Adam Spiers} asked for global linking commands, inspired the link
17945 extension system, added support for mairix, and proposed the mapping API.
17947 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
17948 @LaTeX{}, UTF-8, Latin-1 and ASCII.
17950 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
17951 with links transformation to Org syntax.
17953 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
17954 chapter about publishing.
17956 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
17958 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
17959 enabled source code highlighting in Gnus.
17961 @i{Stefan Vollmar} organized a video-recorded talk at the
17962 Max-Planck-Institute for Neurology. He also inspired the creation of a
17963 concept index for HTML export.
17965 @i{J@"urgen Vollmer} contributed code generating the table of contents
17968 @i{Samuel Wales} has provided important feedback and bug reports.
17970 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
17973 @i{David Wainberg} suggested archiving, and improvements to the linking
17976 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
17979 @i{Roland Winkler} requested additional key bindings to make Org
17982 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
17983 and contributed various ideas and code snippets.
17987 @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
17988 @appendix GNU Free Documentation License
17989 @include doclicense.texi
17992 @node Main Index, Key Index, GNU Free Documentation License, Top
17993 @unnumbered Concept index
17997 @node Key Index, Command and Function Index, Main Index, Top
17998 @unnumbered Key index
18002 @node Command and Function Index, Variable Index, Key Index, Top
18003 @unnumbered Command and function index
18007 @node Variable Index, , Command and Function Index, Top
18008 @unnumbered Variable index
18010 This is not a complete index of variables and faces, only the ones that are
18011 mentioned in the manual. For a more complete list, use @kbd{M-x
18012 org-customize @key{RET}} and then click yourself through the tree.
18018 @c Local variables:
18020 @c indent-tabs-mode: nil
18021 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
18022 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
18026 @c LocalWords: webdavhost pre