1 \input texinfo @c -*- coding: utf-8 -*-
3 @setfilename ../../info/org.info
4 @settitle The Org Manual
7 @include org-version.inc
9 @c Version and Contact Info
10 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
11 @set AUTHOR Carsten Dominik
12 @set MAINTAINER Carsten Dominik
13 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
14 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
19 @c -----------------------------------------------------------------------------
21 @c Macro definitions for commands and keys
22 @c =======================================
24 @c The behavior of the key/command macros will depend on the flag cmdnames
25 @c When set, commands names are shown. When clear, they are not shown.
29 @c Below we define the following macros for Org key tables:
31 @c orgkey{key} A key item
32 @c orgcmd{key,cmd} Key with command name
33 @c xorgcmd{key,cmd} Key with command name as @itemx
34 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
35 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
36 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
37 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
38 @c different functions, so format as @itemx
39 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
40 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
41 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
43 @c a key but no command
55 @c one key with a command
56 @c Inserts: @item KEY COMMAND
57 @macro orgcmd{key,command}
62 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
65 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
74 @c One key with one command, formatted using @itemx
75 @c Inserts: @itemx KEY COMMAND
76 @macro xorgcmd{key,command}
81 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
84 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
93 @c one key with a command, bit do not index the key
94 @c Inserts: @item KEY COMMAND
95 @macro orgcmdnki{key,command}
99 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
102 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
110 @c one key with a command, and special text to replace key in item
111 @c Inserts: @item TEXT COMMAND
112 @macro orgcmdtkc{text,key,command}
117 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
120 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
129 @c two keys with one command
130 @c Inserts: @item KEY1 or KEY2 COMMAND
131 @macro orgcmdkkc{key1,key2,command}
137 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
140 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
150 @c Two keys with one command name, but different functions, so format as
152 @c Inserts: @item KEY1
153 @c @itemx KEY2 COMMAND
154 @macro orgcmdkxkc{key1,key2,command}
161 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
165 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
176 @c Same as previous, but use "or short"
177 @c Inserts: @item KEY1 or short KEY2 COMMAND
178 @macro orgcmdkskc{key1,key2,command}
184 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
187 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
197 @c Same as previous, but use @itemx
198 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
199 @macro xorgcmdkskc{key1,key2,command}
205 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
208 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
218 @c two keys with two commands
219 @c Inserts: @item KEY1 COMMAND1
220 @c @itemx KEY2 COMMAND2
221 @macro orgcmdkkcc{key1,key2,command1,command2}
228 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
229 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
232 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
233 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
243 @c -----------------------------------------------------------------------------
246 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
249 @c Subheadings inside a table.
250 @macro tsubheading{text}
252 @subsubheading \text\
260 This manual is for Org version @value{VERSION}.
262 Copyright @copyright{} 2004--2016 Free Software Foundation, Inc.
265 Permission is granted to copy, distribute and/or modify this document
266 under the terms of the GNU Free Documentation License, Version 1.3 or
267 any later version published by the Free Software Foundation; with no
268 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
269 and with the Back-Cover Texts as in (a) below. A copy of the license
270 is included in the section entitled ``GNU Free Documentation License.''
272 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
273 modify this GNU manual.''
277 @dircategory Emacs editing modes
279 * Org Mode: (org). Outline-based notes management and organizer
283 @title The Org Manual
285 @subtitle Release @value{VERSION}
286 @author by Carsten Dominik
287 with contributions by Bastien Guerry, Nicolas Goaziou, Eric Schulte,
288 Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
290 @c The following two commands start the copyright page.
292 @vskip 0pt plus 1filll
296 @c Output the short table of contents at the beginning.
299 @c Output the table of contents at the beginning.
303 @c FIXME These hand-written next,prev,up node pointers make editing a lot
304 @c harder. There should be no need for them, makeinfo can do it
305 @c automatically for any document with a normal structure.
306 @node Top, Introduction, (dir), (dir)
313 * Introduction:: Getting started
314 * Document structure:: A tree works like your brain
315 * Tables:: Pure magic for quick formatting
316 * Hyperlinks:: Notes in context
317 * TODO items:: Every tree branch can be a TODO item
318 * Tags:: Tagging headlines and matching sets of tags
319 * Properties and columns:: Storing information about an entry
320 * Dates and times:: Making items useful for planning
321 * Capture - Refile - Archive:: The ins and outs for projects
322 * Agenda views:: Collecting information into views
323 * Markup:: Prepare text for rich export
324 * Exporting:: Sharing and publishing notes
325 * Publishing:: Create a web site of linked Org files
326 * Working with source code:: Export, evaluate, and tangle code blocks
327 * Miscellaneous:: All the rest which did not fit elsewhere
328 * Hacking:: How to hack your way around
329 * MobileOrg:: Viewing and capture on a mobile device
330 * History and acknowledgments:: How Org came into being
331 * GNU Free Documentation License:: The license for this documentation.
332 * Main Index:: An index of Org's concepts and features
333 * Key Index:: Key bindings and where they are described
334 * Command and Function Index:: Command names and some internal functions
335 * Variable Index:: Variables mentioned in the manual
338 --- The Detailed Node Listing ---
342 * Summary:: Brief summary of what Org does
343 * Installation:: Installing Org
344 * Activation:: How to activate Org for certain buffers
345 * Feedback:: Bug reports, ideas, patches etc.
346 * Conventions:: Typesetting conventions in the manual
350 * Outlines:: Org is based on Outline mode
351 * Headlines:: How to typeset Org tree headlines
352 * Visibility cycling:: Show and hide, much simplified
353 * Motion:: Jumping to other headlines
354 * Structure editing:: Changing sequence and level of headlines
355 * Sparse trees:: Matches embedded in context
356 * Plain lists:: Additional structure within an entry
357 * Drawers:: Tucking stuff away
358 * Blocks:: Folding blocks
359 * Footnotes:: How footnotes are defined in Org's syntax
360 * Orgstruct mode:: Structure editing outside Org
361 * Org syntax:: Formal description of Org's syntax
365 * Global and local cycling:: Cycling through various visibility states
366 * Initial visibility:: Setting the initial visibility state
367 * Catching invisible edits:: Preventing mistakes when editing invisible parts
371 * Built-in table editor:: Simple tables
372 * Column width and alignment:: Overrule the automatic settings
373 * Column groups:: Grouping to trigger vertical lines
374 * Orgtbl mode:: The table editor as minor mode
375 * The spreadsheet:: The table editor has spreadsheet capabilities
376 * Org-Plot:: Plotting from org tables
380 * References:: How to refer to another field or range
381 * Formula syntax for Calc:: Using Calc to compute stuff
382 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
383 * Durations and time values:: How to compute durations and time values
384 * Field and range formulas:: Formula for specific (ranges of) fields
385 * Column formulas:: Formulas valid for an entire column
386 * Lookup functions:: Lookup functions for searching tables
387 * Editing and debugging formulas:: Fixing formulas
388 * Updating the table:: Recomputing all dependent fields
389 * Advanced features:: Field and column names, parameters and automatic recalc
393 * Link format:: How links in Org are formatted
394 * Internal links:: Links to other places in the current file
395 * External links:: URL-like links to the world
396 * Handling links:: Creating, inserting and following
397 * Using links outside Org:: Linking from my C source code?
398 * Link abbreviations:: Shortcuts for writing complex links
399 * Search options:: Linking to a specific location
400 * Custom searches:: When the default search is not enough
404 * Radio targets:: Make targets trigger links in plain text
408 * TODO basics:: Marking and displaying TODO entries
409 * TODO extensions:: Workflow and assignments
410 * Progress logging:: Dates and notes for progress
411 * Priorities:: Some things are more important than others
412 * Breaking down tasks:: Splitting a task into manageable pieces
413 * Checkboxes:: Tick-off lists
415 Extended use of TODO keywords
417 * Workflow states:: From TODO to DONE in steps
418 * TODO types:: I do this, Fred does the rest
419 * Multiple sets in one file:: Mixing it all, and still finding your way
420 * Fast access to TODO states:: Single letter selection of a state
421 * Per-file keywords:: Different files, different requirements
422 * Faces for TODO keywords:: Highlighting states
423 * TODO dependencies:: When one task needs to wait for others
427 * Closing items:: When was this entry marked DONE?
428 * Tracking TODO state changes:: When did the status change?
429 * Tracking your habits:: How consistent have you been?
433 * Tag inheritance:: Tags use the tree structure of the outline
434 * Setting tags:: How to assign tags to a headline
435 * Tag hierarchy:: Create a hierarchy of tags
436 * Tag searches:: Searching for combinations of tags
438 Properties and columns
440 * Property syntax:: How properties are spelled out
441 * Special properties:: Access to other Org mode features
442 * Property searches:: Matching property values
443 * Property inheritance:: Passing values down the tree
444 * Column view:: Tabular viewing and editing
445 * Property API:: Properties for Lisp programmers
449 * Defining columns:: The COLUMNS format property
450 * Using column view:: How to create and use column view
451 * Capturing column view:: A dynamic block for column view
455 * Scope of column definitions:: Where defined, where valid?
456 * Column attributes:: Appearance and content of a column
460 * Timestamps:: Assigning a time to a tree entry
461 * Creating timestamps:: Commands which insert timestamps
462 * Deadlines and scheduling:: Planning your work
463 * Clocking work time:: Tracking how long you spend on a task
464 * Effort estimates:: Planning work effort in advance
465 * Timers:: Notes with a running timer
469 * The date/time prompt:: How Org mode helps you entering date and time
470 * Custom time format:: Making dates look different
472 Deadlines and scheduling
474 * Inserting deadline/schedule:: Planning items
475 * Repeated tasks:: Items that show up again and again
479 * Clocking commands:: Starting and stopping a clock
480 * The clock table:: Detailed reports
481 * Resolving idle time:: Resolving time when you've been idle
483 Capture - Refile - Archive
485 * Capture:: Capturing new stuff
486 * Attachments:: Add files to tasks
487 * RSS feeds:: Getting input from RSS feeds
488 * Protocols:: External (e.g., Browser) access to Emacs and Org
489 * Refile and copy:: Moving/copying a tree from one place to another
490 * Archiving:: What to do with finished projects
494 * Setting up capture:: Where notes will be stored
495 * Using capture:: Commands to invoke and terminate capture
496 * Capture templates:: Define the outline of different note types
500 * Template elements:: What is needed for a complete template entry
501 * Template expansion:: Filling in information about time and context
502 * Templates in contexts:: Only show a template in a specific context
506 * Moving subtrees:: Moving a tree to an archive file
507 * Internal archiving:: Switch off a tree but keep it in the file
511 * Agenda files:: Files being searched for agenda information
512 * Agenda dispatcher:: Keyboard access to agenda views
513 * Built-in agenda views:: What is available out of the box?
514 * Presentation and sorting:: How agenda items are prepared for display
515 * Agenda commands:: Remote editing of Org trees
516 * Custom agenda views:: Defining special searches and views
517 * Exporting agenda views:: Writing a view to a file
518 * Agenda column view:: Using column view for collected entries
520 The built-in agenda views
522 * Weekly/daily agenda:: The calendar page with current tasks
523 * Global TODO list:: All unfinished action items
524 * Matching tags and properties:: Structured information with fine-tuned search
525 * Timeline:: Time-sorted view for single file
526 * Search view:: Find entries by searching for text
527 * Stuck projects:: Find projects you need to review
529 Presentation and sorting
531 * Categories:: Not all tasks are equal
532 * Time-of-day specifications:: How the agenda knows the time
533 * Sorting agenda items:: The order of things
534 * Filtering/limiting agenda items:: Dynamically narrow the agenda
538 * Storing searches:: Type once, use often
539 * Block agenda:: All the stuff you need in a single buffer
540 * Setting options:: Changing the rules
542 Markup for rich export
544 * Structural markup elements:: The basic structure as seen by the exporter
545 * Images and tables:: Images, tables and caption mechanism
546 * Literal examples:: Source code examples with special formatting
547 * Include files:: Include additional files into a document
548 * Index entries:: Making an index
549 * Macro replacement:: Use macros to create templates
550 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
551 * Special blocks:: Containers targeted at export back-ends
553 Structural markup elements
555 * Document title:: Where the title is taken from
556 * Headings and sections:: The document structure as seen by the exporter
557 * Table of contents:: The if and where of the table of contents
559 * Paragraphs:: Paragraphs
560 * Footnote markup:: Footnotes
561 * Emphasis and monospace:: Bold, italic, etc.
562 * Horizontal rules:: Make a line
563 * Comment lines:: What will *not* be exported
567 * Special symbols:: Greek letters and other symbols
568 * Subscripts and superscripts:: Simple syntax for raising/lowering text
569 * @LaTeX{} fragments:: Complex formulas made easy
570 * Previewing @LaTeX{} fragments:: What will this snippet look like?
571 * CDLaTeX mode:: Speed up entering of formulas
575 * The export dispatcher:: The main exporter interface
576 * Export back-ends:: Built-in export formats
577 * Export settings:: Generic export settings
578 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
579 * Beamer export:: Exporting as a Beamer presentation
580 * HTML export:: Exporting to HTML
581 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
582 * Markdown export:: Exporting to Markdown
583 * OpenDocument Text export:: Exporting to OpenDocument Text
584 * Org export:: Exporting to Org
585 * Texinfo export:: Exporting to Texinfo
586 * iCalendar export:: Exporting to iCalendar
587 * Other built-in back-ends:: Exporting to a man page
588 * Export in foreign buffers:: Author tables and lists in Org syntax
589 * Advanced configuration:: Fine-tuning the export output
593 * HTML Export commands:: How to invoke HTML export
594 * HTML doctypes:: Org can export to various (X)HTML flavors
595 * HTML preamble and postamble:: How to insert a preamble and a postamble
596 * Quoting HTML tags:: Using direct HTML in Org mode
597 * Links in HTML export:: How links will be interpreted and formatted
598 * Tables in HTML export:: How to modify the formatting of tables
599 * Images in HTML export:: How to insert figures into HTML output
600 * Math formatting in HTML export:: Beautiful math also on the web
601 * Text areas in HTML export:: An alternative way to show an example
602 * CSS support:: Changing the appearance of the output
603 * JavaScript support:: Info and Folding in a web browser
605 @LaTeX{} and PDF export
607 * @LaTeX{} export commands:: How to export to LaTeX and PDF
608 * Header and sectioning:: Setting up the export file structure
609 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
610 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
612 OpenDocument text export
614 * Pre-requisites for ODT export:: What packages ODT exporter relies on
615 * ODT export commands:: How to invoke ODT export
616 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
617 * Applying custom styles:: How to apply custom styles to the output
618 * Links in ODT export:: How links will be interpreted and formatted
619 * Tables in ODT export:: How Tables are exported
620 * Images in ODT export:: How to insert images
621 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
622 * Labels and captions in ODT export:: How captions are rendered
623 * Literal examples in ODT export:: How source and example blocks are formatted
624 * Advanced topics in ODT export:: Read this if you are a power user
626 Math formatting in ODT export
628 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
629 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
631 Advanced topics in ODT export
633 * Configuring a document converter:: How to register a document converter
634 * Working with OpenDocument style files:: Explore the internals
635 * Creating one-off styles:: How to produce custom highlighting etc
636 * Customizing tables in ODT export:: How to define and use Table templates
637 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
641 * Texinfo export commands:: How to invoke Texinfo export
642 * Document preamble:: File header, title and copyright page
643 * Headings and sectioning structure:: Building document structure
644 * Indices:: Creating indices
645 * Quoting Texinfo code:: Incorporating literal Texinfo code
646 * Texinfo specific attributes:: Controlling Texinfo output
651 * Configuration:: Defining projects
652 * Uploading files:: How to get files up on the server
653 * Sample configuration:: Example projects
654 * Triggering publication:: Publication commands
658 * Project alist:: The central configuration variable
659 * Sources and destinations:: From here to there
660 * Selecting files:: What files are part of the project?
661 * Publishing action:: Setting the function doing the publishing
662 * Publishing options:: Tweaking HTML/@LaTeX{} export
663 * Publishing links:: Which links keep working after publishing?
664 * Sitemap:: Generating a list of all pages
665 * Generating an index:: An index that reaches across pages
669 * Simple example:: One-component publishing
670 * Complex example:: A multi-component publishing example
672 Working with source code
674 * Structure of code blocks:: Code block syntax described
675 * Editing source code:: Language major-mode editing
676 * Exporting code blocks:: Export contents and/or results
677 * Extracting source code:: Create pure source code files
678 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
679 * Library of Babel:: Use and contribute to a library of useful code blocks
680 * Languages:: List of supported code block languages
681 * Header arguments:: Configure code block functionality
682 * Results of evaluation:: How evaluation results are handled
683 * Noweb reference syntax:: Literate programming in Org mode
684 * Key bindings and useful functions:: Work quickly with code blocks
685 * Batch execution:: Call functions from the command line
689 * Using header arguments:: Different ways to set header arguments
690 * Specific header arguments:: List of header arguments
692 Using header arguments
694 * System-wide header arguments:: Set global default values
695 * Language-specific header arguments:: Set default values by language
696 * Header arguments in Org mode properties:: Set default values for a buffer or heading
697 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
698 * Code block specific header arguments:: The most common way to set values
699 * Header arguments in function calls:: The most specific level
701 Specific header arguments
703 * var:: Pass arguments to code blocks
704 * results:: Specify the type of results and how they will
705 be collected and handled
706 * file:: Specify a path for file output
707 * file-desc:: Specify a description for file results
708 * dir:: Specify the default (possibly remote)
709 directory for code block execution
710 * exports:: Export code and/or results
711 * tangle:: Toggle tangling and specify file name
712 * mkdirp:: Toggle creation of parent directories of target
713 files during tangling
714 * comments:: Toggle insertion of comments in tangled
716 * padline:: Control insertion of padding lines in tangled
718 * no-expand:: Turn off variable assignment and noweb
719 expansion during tangling
720 * session:: Preserve the state of code evaluation
721 * noweb:: Toggle expansion of noweb references
722 * noweb-ref:: Specify block's noweb reference resolution target
723 * noweb-sep:: String used to separate noweb references
724 * cache:: Avoid re-evaluating unchanged code blocks
725 * sep:: Delimiter for writing tabular results outside Org
726 * hlines:: Handle horizontal lines in tables
727 * colnames:: Handle column names in tables
728 * rownames:: Handle row names in tables
729 * shebang:: Make tangled files executable
730 * tangle-mode:: Set permission of tangled files
731 * eval:: Limit evaluation of specific code blocks
732 * wrap:: Mark source block evaluation results
733 * post:: Post processing of code block results
734 * prologue:: Text to prepend to code block body
735 * epilogue:: Text to append to code block body
739 * Completion:: M-TAB knows what you need
740 * Easy templates:: Quick insertion of structural elements
741 * Speed keys:: Electric commands at the beginning of a headline
742 * Code evaluation security:: Org mode files evaluate inline code
743 * Customization:: Adapting Org to your taste
744 * In-buffer settings:: Overview of the #+KEYWORDS
745 * The very busy C-c C-c key:: When in doubt, press C-c C-c
746 * Clean view:: Getting rid of leading stars in the outline
747 * TTY keys:: Using Org on a tty
748 * Interaction:: Other Emacs packages
749 * org-crypt:: Encrypting Org files
751 Interaction with other packages
753 * Cooperation:: Packages Org cooperates with
754 * Conflicts:: Packages that lead to conflicts
758 * Hooks:: How to reach into Org's internals
759 * Add-on packages:: Available extensions
760 * Adding hyperlink types:: New custom link types
761 * Adding export back-ends:: How to write new export back-ends
762 * Context-sensitive commands:: How to add functionality to such commands
763 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
764 * Dynamic blocks:: Automatically filled blocks
765 * Special agenda views:: Customized views
766 * Speeding up your agendas:: Tips on how to speed up your agendas
767 * Extracting agenda information:: Post-processing of agenda information
768 * Using the property API:: Writing programs that use entry properties
769 * Using the mapping API:: Mapping over all or selected entries
771 Tables and lists in arbitrary syntax
773 * Radio tables:: Sending and receiving radio tables
774 * A @LaTeX{} example:: Step by step, almost a tutorial
775 * Translator functions:: Copy and modify
776 * Radio lists:: Sending and receiving lists
780 * Setting up the staging area:: Where to interact with the mobile device
781 * Pushing to MobileOrg:: Uploading Org files and agendas
782 * Pulling from MobileOrg:: Integrating captured and flagged items
788 @chapter Introduction
792 * Summary:: Brief summary of what Org does
793 * Installation:: Installing Org
794 * Activation:: How to activate Org for certain buffers
795 * Feedback:: Bug reports, ideas, patches etc.
796 * Conventions:: Typesetting conventions in the manual
803 Org is a mode for keeping notes, maintaining TODO lists, and project planning
804 with a fast and effective plain-text system. It also is an authoring system
805 with unique support for literate programming and reproducible research.
807 Org is implemented on top of Outline mode, which makes it possible to keep
808 the content of large files well structured. Visibility cycling and structure
809 editing help to work with the tree. Tables are easily created with a
810 built-in table editor. Plain text URL-like links connect to websites,
811 emails, Usenet messages, BBDB entries, and any files related to the projects.
813 Org develops organizational tasks around notes files that contain lists or
814 information about projects as plain text. Project planning and task
815 management makes use of metadata which is part of an outline node. Based on
816 this data, specific entries can be extracted in queries and create dynamic
817 @i{agenda views} that also integrate the Emacs calendar and diary. Org can
818 be used to implement many different project planning schemes, such as David
821 Org files can serve as a single source authoring system with export to many
822 different formats such as HTML, @LaTeX{}, Open Document, and Markdown. New
823 export backends can be derived from existing ones, or defined from scratch.
825 Org files can include source code blocks, which makes Org uniquely suited for
826 authoring technical documents with code examples. Org source code blocks are
827 fully functional; they can be evaluated in place and their results can be
828 captured in the file. This makes it possible to create a single file
829 reproducible research compendium.
831 Org keeps simple things simple. When first fired up, it should feel like a
832 straightforward, easy to use outliner. Complexity is not imposed, but a
833 large amount of functionality is available when needed. Org is a toolbox.
834 Many users actually run only a (very personal) fraction of Org's capabilities, and
835 know that there is more whenever they need it.
837 All of this is achieved with strictly plain text files, the most portable and
838 future-proof file format. Org runs in Emacs. Emacs is one of the most
839 widely ported programs, so that Org mode is available on every major
843 There is a website for Org which provides links to the newest
844 version of Org, as well as additional information, frequently asked
845 questions (FAQ), links to tutorials, etc. This page is located at
846 @uref{http://orgmode.org}.
847 @cindex print edition
849 An earlier version (7.3) of this manual is available as a
850 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
856 @section Installation
860 Org is part of recent distributions of GNU Emacs, so you normally don't need
861 to install it. If, for one reason or another, you want to install Org on top
862 of this pre-packaged version, there are three ways to do it:
865 @item By using Emacs package system.
866 @item By downloading Org as an archive.
867 @item By using Org's git repository.
870 We @b{strongly recommend} to stick to a single installation method.
872 @subsubheading Using Emacs packaging system
874 Recent Emacs distributions include a packaging system which lets you install
875 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
877 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
878 been visited, i.e., where no Org built-in function have been loaded.
879 Otherwise autoload Org functions will mess up the installation.
881 Then, to make sure your Org configuration is taken into account, initialize
882 the package system with @code{(package-initialize)} in your @file{.emacs}
883 before setting any Org option. If you want to use Org's package repository,
884 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
886 @subsubheading Downloading Org as an archive
888 You can download Org latest release from @uref{http://orgmode.org/, Org's
889 website}. In this case, make sure you set the load-path correctly in your
893 (add-to-list 'load-path "~/path/to/orgdir/lisp")
896 The downloaded archive contains contributed libraries that are not included
897 in Emacs. If you want to use them, add the @file{contrib} directory to your
901 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
904 Optionally, you can compile the files and/or install them in your system.
905 Run @code{make help} to list compilation and installation options.
907 @subsubheading Using Org's git repository
909 You can clone Org's repository and install Org like this:
913 $ git clone git://orgmode.org/org-mode.git
917 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
918 version in @file{org-version.el} and Org's autoloads in
919 @file{org-loaddefs.el}.
921 Remember to add the correct load-path as described in the method above.
923 You can also compile with @code{make}, generate the documentation with
924 @code{make doc}, create a local configuration with @code{make config} and
925 install Org with @code{make install}. Please run @code{make help} to get
926 the list of compilation/installation options.
928 For more detailed explanations on Org's build system, please check the Org
929 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
937 @cindex global key bindings
938 @cindex key bindings, global
941 @findex org-store-link
944 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
945 default. If you are using an earlier version of Emacs, add this line to your
949 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
952 Org mode buffers need font-lock to be turned on: this is the default in
953 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
954 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
956 There are compatibility issues between Org mode and some other Elisp
957 packages, please take the time to check the list (@pxref{Conflicts}).
959 The four Org commands @command{org-store-link}, @command{org-capture},
960 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
961 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
962 suggested bindings for these keys, please modify the keys to your own
965 (global-set-key "\C-cl" 'org-store-link)
966 (global-set-key "\C-ca" 'org-agenda)
967 (global-set-key "\C-cc" 'org-capture)
968 (global-set-key "\C-cb" 'org-iswitchb)
971 @cindex Org mode, turning on
972 To turn on Org mode in a file that does not have the extension @file{.org},
973 make the first line of a file look like this:
976 MY PROJECTS -*- mode: org; -*-
979 @vindex org-insert-mode-line-in-empty-file
980 @noindent which will select Org mode for this buffer no matter what
981 the file's name is. See also the variable
982 @code{org-insert-mode-line-in-empty-file}.
984 Many commands in Org work on the region if the region is @i{active}. To make
985 use of this, you need to have @code{transient-mark-mode}
986 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
987 in Emacs 22 you need to do this yourself with
989 (transient-mark-mode 1)
991 @noindent If you do not like @code{transient-mark-mode}, you can create an
992 active region by using the mouse to select a region, or pressing
993 @kbd{C-@key{SPC}} twice before moving the cursor.
1002 If you find problems with Org, or if you have questions, remarks, or ideas
1003 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1004 You can subscribe to the list
1005 @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, on this web page}.
1006 If you are not a member of the mailing list, your mail will be passed to the
1007 list after a moderator has approved it@footnote{Please consider subscribing
1008 to the mailing list, in order to minimize the work the mailing list
1009 moderators have to do.}.
1011 For bug reports, please first try to reproduce the bug with the latest
1012 version of Org available---if you are running an outdated version, it is
1013 quite possible that the bug has been fixed already. If the bug persists,
1014 prepare a report and provide as much information as possible, including the
1015 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1016 (@kbd{M-x org-version RET}), as well as the Org related setup in
1017 @file{.emacs}. The easiest way to do this is to use the command
1019 @kbd{M-x org-submit-bug-report RET}
1021 @noindent which will put all this information into an Emacs mail buffer so
1022 that you only need to add your description. If you are not sending the Email
1023 from within Emacs, please copy and paste the content into your Email program.
1025 Sometimes you might face a problem due to an error in your Emacs or Org mode
1026 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1027 customizations and reproduce the problem. Doing so often helps you determine
1028 if the problem is with your customization or with Org mode itself. You can
1029 start a typical minimal session with a command like the example below.
1032 $ emacs -Q -l /path/to/minimal-org.el
1035 However if you are using Org mode as distributed with Emacs, a minimal setup
1036 is not necessary. In that case it is sufficient to start Emacs as
1037 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1041 ;;; Minimal setup to load latest 'org-mode'
1043 ;; activate debugging
1044 (setq debug-on-error t
1048 ;; add latest org-mode to load path
1049 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1050 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1053 If an error occurs, a backtrace can be very useful (see below on how to
1054 create one). Often a small example file helps, along with clear information
1058 @item What exactly did you do?
1059 @item What did you expect to happen?
1060 @item What happened instead?
1062 @noindent Thank you for helping to improve this program.
1064 @subsubheading How to create a useful backtrace
1066 @cindex backtrace of an error
1067 If working with Org produces an error with a message you don't
1068 understand, you may have hit a bug. The best way to report this is by
1069 providing, in addition to what was mentioned above, a @emph{backtrace}.
1070 This is information from the built-in debugger about where and how the
1071 error occurred. Here is how to produce a useful backtrace:
1075 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1076 contains much more information if it is produced with uncompiled code.
1079 @kbd{C-u M-x org-reload RET}
1082 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1085 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1086 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1088 Do whatever you have to do to hit the error. Don't forget to
1089 document the steps you take.
1091 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1092 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1093 attach it to your bug report.
1097 @section Typesetting conventions used in this manual
1099 @subsubheading TODO keywords, tags, properties, etc.
1101 Org mainly uses three types of keywords: TODO keywords, tags and property
1102 names. In this manual we use the following conventions:
1107 TODO keywords are written with all capitals, even if they are
1111 User-defined tags are written in lowercase; built-in tags with special
1112 meaning are written with all capitals.
1115 User-defined properties are capitalized; built-in properties with
1116 special meaning are written with all capitals.
1119 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1120 and @i{environment keywords} (like @code{#+BEGIN_EXPORT html} to start
1121 a @code{HTML} environment). They are written in uppercase in the manual to
1122 enhance its readability, but you can use lowercase in your Org
1123 files@footnote{Easy templates insert lowercase keywords and Babel dynamically
1124 inserts @code{#+results}.}.
1126 @subsubheading Key bindings and commands
1132 The manual suggests a few global key bindings, in particular @kbd{C-c a} for
1133 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}. These are only
1134 suggestions, but the rest of the manual assumes that these key bindings are in
1135 place in order to list commands by key access.
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
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
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.
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 than 30 stars.}. For example:
1201 * Top level headline
1208 * Another top level headline
1211 @vindex org-footnote-section
1212 @noindent Note that a headline named after @code{org-footnote-section},
1213 which defaults to @samp{Footnotes}, is considered as special. A subtree with
1214 this headline will be silently ignored by exporting functions.
1216 Some people find the many stars too noisy and would prefer an
1217 outline that has whitespace followed by a single star as headline
1218 starters. @ref{Clean view}, describes a setup to realize this.
1220 @vindex org-cycle-separator-lines
1221 An empty line after the end of a subtree is considered part of it and
1222 will be hidden when the subtree is folded. However, if you leave at
1223 least two empty lines, one empty line will remain visible after folding
1224 the subtree, in order to structure the collapsed view. See the
1225 variable @code{org-cycle-separator-lines} to modify this behavior.
1227 @node Visibility cycling
1228 @section Visibility cycling
1229 @cindex cycling, visibility
1230 @cindex visibility cycling
1231 @cindex trees, visibility
1232 @cindex show hidden text
1236 * Global and local cycling:: Cycling through various visibility states
1237 * Initial visibility:: Setting the initial visibility state
1238 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1241 @node Global and local cycling
1242 @subsection Global and local cycling
1244 Outlines make it possible to hide parts of the text in the buffer.
1245 Org uses just two commands, bound to @key{TAB} and
1246 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1248 @cindex subtree visibility states
1249 @cindex subtree cycling
1250 @cindex folded, subtree visibility state
1251 @cindex children, subtree visibility state
1252 @cindex subtree, subtree visibility state
1254 @orgcmd{@key{TAB},org-cycle}
1255 @emph{Subtree cycling}: Rotate current subtree among the states
1258 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1259 '-----------------------------------'
1262 @vindex org-cycle-emulate-tab
1263 @vindex org-cycle-global-at-bob
1264 The cursor must be on a headline for this to work@footnote{see, however,
1265 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1266 beginning of the buffer and the first line is not a headline, then
1267 @key{TAB} actually runs global cycling (see below)@footnote{see the
1268 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1269 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1271 @cindex global visibility states
1272 @cindex global cycling
1273 @cindex overview, global visibility state
1274 @cindex contents, global visibility state
1275 @cindex show all, global visibility state
1276 @orgcmd{S-@key{TAB},org-global-cycle}
1277 @itemx C-u @key{TAB}
1278 @emph{Global cycling}: Rotate the entire buffer among the states
1281 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1282 '--------------------------------------'
1285 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1286 CONTENTS view up to headlines of level N will be shown. Note that inside
1287 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1289 @cindex set startup visibility, command
1290 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1291 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1292 @cindex show all, command
1293 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1294 Show all, including drawers.
1295 @cindex revealing context
1296 @orgcmd{C-c C-r,org-reveal}
1297 Reveal context around point, showing the current entry, the following heading
1298 and the hierarchy above. Useful for working near a location that has been
1299 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1300 (@pxref{Agenda commands}). With a prefix argument show, on each
1301 level, all sibling headings. With a double prefix argument, also show the
1302 entire subtree of the parent.
1303 @cindex show branches, command
1304 @orgcmd{C-c C-k,show-branches}
1305 Expose all the headings of the subtree, CONTENT view for just one subtree.
1306 @cindex show children, command
1307 @orgcmd{C-c @key{TAB},show-children}
1308 Expose all direct children of the subtree. With a numeric prefix argument N,
1309 expose all children down to level N@.
1310 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1311 Show the current subtree in an indirect buffer@footnote{The indirect buffer
1312 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
1313 buffer, but will be narrowed to the current tree. Editing the indirect
1314 buffer will also change the original buffer, but without affecting visibility
1315 in that buffer.}. With a numeric prefix argument N, go up to level N and
1316 then take that tree. If N is negative then go up that many levels. With a
1317 @kbd{C-u} prefix, do not remove the previously used indirect buffer.
1318 @orgcmd{C-c C-x v,org-copy-visible}
1319 Copy the @i{visible} text in the region into the kill ring.
1322 @node Initial visibility
1323 @subsection Initial visibility
1325 @cindex visibility, initialize
1326 @vindex org-startup-folded
1327 @vindex org-agenda-inhibit-startup
1328 @cindex @code{overview}, STARTUP keyword
1329 @cindex @code{content}, STARTUP keyword
1330 @cindex @code{showall}, STARTUP keyword
1331 @cindex @code{showeverything}, STARTUP keyword
1333 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1334 i.e., only the top level headlines are visible@footnote{When
1335 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1336 visibility state when first opening a file for the agenda (@pxref{Speeding up
1337 your agendas}).}. This can be configured through the variable
1338 @code{org-startup-folded}, or on a per-file basis by adding one of the
1339 following lines anywhere in the buffer:
1345 #+STARTUP: showeverything
1348 The startup visibility options are ignored when the file is open for the
1349 first time during the agenda generation: if you want the agenda to honor
1350 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1352 @cindex property, VISIBILITY
1354 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1355 and columns}) will get their visibility adapted accordingly. Allowed values
1356 for this property are @code{folded}, @code{children}, @code{content}, and
1360 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1361 Switch back to the startup visibility of the buffer, i.e., whatever is
1362 requested by startup options and @samp{VISIBILITY} properties in individual
1366 @node Catching invisible edits
1367 @subsection Catching invisible edits
1369 @vindex org-catch-invisible-edits
1370 @cindex edits, catching invisible
1371 Sometimes you may inadvertently edit an invisible part of the buffer and be
1372 confused on what has been edited and how to undo the mistake. Setting
1373 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
1374 docstring of this option on how Org should catch invisible edits and process
1379 @cindex motion, between headlines
1380 @cindex jumping, to headlines
1381 @cindex headline navigation
1382 The following commands jump to other headlines in the buffer.
1385 @orgcmd{C-c C-n,outline-next-visible-heading}
1387 @orgcmd{C-c C-p,outline-previous-visible-heading}
1389 @orgcmd{C-c C-f,org-forward-same-level}
1390 Next heading same level.
1391 @orgcmd{C-c C-b,org-backward-same-level}
1392 Previous heading same level.
1393 @orgcmd{C-c C-u,outline-up-heading}
1394 Backward to higher level heading.
1395 @orgcmd{C-c C-j,org-goto}
1396 Jump to a different place without changing the current outline
1397 visibility. Shows the document structure in a temporary buffer, where
1398 you can use the following keys to find your destination:
1399 @vindex org-goto-auto-isearch
1401 @key{TAB} @r{Cycle visibility.}
1402 @key{down} / @key{up} @r{Next/previous visible headline.}
1403 @key{RET} @r{Select this location.}
1404 @kbd{/} @r{Do a Sparse-tree search}
1405 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1406 n / p @r{Next/previous visible headline.}
1407 f / b @r{Next/previous headline same level.}
1409 0-9 @r{Digit argument.}
1412 @vindex org-goto-interface
1414 See also the option @code{org-goto-interface}.
1417 @node Structure editing
1418 @section Structure editing
1419 @cindex structure editing
1420 @cindex headline, promotion and demotion
1421 @cindex promotion, of subtrees
1422 @cindex demotion, of subtrees
1423 @cindex subtree, cut and paste
1424 @cindex pasting, of subtrees
1425 @cindex cutting, of subtrees
1426 @cindex copying, of subtrees
1427 @cindex sorting, of subtrees
1428 @cindex subtrees, cut and paste
1431 @orgcmd{M-@key{RET},org-insert-heading}
1432 @vindex org-M-RET-may-split-line
1433 Insert a new heading/item with the same level as the one at point.
1435 If the cursor is in a plain list item, a new item is created (@pxref{Plain
1436 lists}). To prevent this behavior in lists, call the command with one prefix
1437 argument. When this command is used in the middle of a line, the line is
1438 split and the rest of the line becomes the new item or headline. If you do
1439 not want the line to be split, customize @code{org-M-RET-may-split-line}.
1441 If the command is used at the @emph{beginning} of a line, and if there is a
1442 heading or an item at point, the new heading/item is created @emph{before}
1443 the current line. If the command is used at the @emph{end} of a folded
1444 subtree (i.e., behind the ellipses at the end of a headline), then a headline
1445 will be inserted after the end of the subtree.
1447 Calling this command with @kbd{C-u C-u} will unconditionally respect the
1448 headline's content and create a new item at the end of the parent subtree.
1450 If point is at the beginning of a normal line, turn this line into a heading.
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
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-context-detail
1566 An important feature of Org mode is the ability to construct @emph{sparse
1567 trees} for selected information in an outline tree, so that the entire
1568 document is folded as much as possible, but the selected information is made
1569 visible along with the headline structure above it@footnote{See also the
1570 variable @code{org-show-context-detail} to decide how much context is shown
1571 around each match.}. Just try it out and you will see immediately how it
1574 Org mode contains several commands for creating such trees, all these
1575 commands can be accessed through a dispatcher:
1578 @orgcmd{C-c /,org-sparse-tree}
1579 This prompts for an extra key to select a sparse-tree creating command.
1580 @orgcmd{C-c / r,org-occur}
1581 @vindex org-remove-highlights-with-change
1582 Prompts for a regexp and shows a sparse tree with all matches. If
1583 the match is in a headline, the headline is made visible. If the match is in
1584 the body of an entry, headline and body are made visible. In order to
1585 provide minimal context, also the full hierarchy of headlines above the match
1586 is shown, as well as the headline following the match. Each match is also
1587 highlighted; the highlights disappear when the buffer is changed by an
1588 editing command@footnote{This depends on the option
1589 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1590 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1591 so several calls to this command can be stacked.
1592 @orgcmdkkc{M-g n,M-g M-n,next-error}
1593 Jump to the next sparse tree match in this buffer.
1594 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1595 Jump to the previous sparse tree match in this buffer.
1599 @vindex org-agenda-custom-commands
1600 For frequently used sparse trees of specific search strings, you can
1601 use the option @code{org-agenda-custom-commands} to define fast
1602 keyboard access to specific sparse trees. These commands will then be
1603 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1607 (setq org-agenda-custom-commands
1608 '(("f" occur-tree "FIXME")))
1611 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1612 a sparse tree matching the string @samp{FIXME}.
1614 The other sparse tree commands select headings based on TODO keywords,
1615 tags, or properties and will be discussed later in this manual.
1618 @cindex printing sparse trees
1619 @cindex visible text, printing
1620 To print a sparse tree, you can use the Emacs command
1621 @code{ps-print-buffer-with-faces} which does not print invisible parts
1622 of the document @footnote{This does not work under XEmacs, because
1623 XEmacs uses selective display for outlining, not text properties.}.
1624 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1625 the document and print the resulting file.
1628 @section Plain lists
1630 @cindex lists, plain
1631 @cindex lists, ordered
1632 @cindex ordered lists
1634 Within an entry of the outline tree, hand-formatted lists can provide
1635 additional structure. They also provide a way to create lists of checkboxes
1636 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1637 (@pxref{Exporting}) can parse and format them.
1639 Org knows ordered lists, unordered lists, and description lists.
1642 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1643 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1644 they will be seen as top-level headlines. Also, when you are hiding leading
1645 stars to get a clean outline view, plain list items starting with a star may
1646 be hard to distinguish from true headlines. In short: even though @samp{*}
1647 is supported, it may be better to not use it for plain list items.} as
1650 @vindex org-plain-list-ordered-item-terminator
1651 @vindex org-list-allow-alphabetical
1652 @emph{Ordered} list items start with a numeral followed by either a period or
1653 a right parenthesis@footnote{You can filter out any of them by configuring
1654 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1655 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1656 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1657 confusion with normal text, those are limited to one character only. Beyond
1658 that limit, bullets will automatically fallback to numbers.}. If you want a
1659 list to start with a different value (e.g., 20), start the text of the item
1660 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1661 must be put @emph{before} the checkbox. If you have activated alphabetical
1662 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1663 be used in any item of the list in order to enforce a particular numbering.
1665 @emph{Description} list items are unordered list items, and contain the
1666 separator @samp{ :: } to distinguish the description @emph{term} from the
1670 Items belonging to the same list must have the same indentation on the first
1671 line. In particular, if an ordered list reaches number @samp{10.}, then the
1672 2--digit numbers must be written left-aligned with the other numbers in the
1673 list. An item ends before the next line that is less or equally indented
1674 than its bullet/number.
1676 @vindex org-list-empty-line-terminates-plain-lists
1677 A list ends whenever every item has ended, which means before any line less
1678 or equally indented than items at top level. It also ends before two blank
1679 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1680 In that case, all items are closed. Here is an example:
1684 ** Lord of the Rings
1685 My favorite scenes are (in this order)
1686 1. The attack of the Rohirrim
1687 2. Eowyn's fight with the witch king
1688 + this was already my favorite scene in the book
1689 + I really like Miranda Otto.
1690 3. Peter Jackson being shot by Legolas
1692 He makes a really funny face when it happens.
1693 But in the end, no individual scenes matter but the film as a whole.
1694 Important actors in this film are:
1695 - @b{Elijah Wood} :: He plays Frodo
1696 - @b{Sean Astin} :: He plays Sam, Frodo's friend. I still remember
1697 him very well from his role as Mikey Walsh in @i{The Goonies}.
1701 Org supports these lists by tuning filling and wrapping commands to deal with
1702 them correctly@footnote{Org only changes the filling settings for Emacs. For
1703 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1704 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1705 properly (@pxref{Exporting}). Since indentation is what governs the
1706 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1707 blocks can be indented to signal that they belong to a particular item.
1709 @vindex org-list-demote-modify-bullet
1710 @vindex org-list-indent-offset
1711 If you find that using a different bullet for a sub-list (than that used for
1712 the current list-level) improves readability, customize the variable
1713 @code{org-list-demote-modify-bullet}. To get a greater difference of
1714 indentation between items and their sub-items, customize
1715 @code{org-list-indent-offset}.
1717 @vindex org-list-automatic-rules
1718 The following commands act on items when the cursor is in the first line of
1719 an item (the line with the bullet or number). Some of them imply the
1720 application of automatic rules to keep list structure intact. If some of
1721 these actions get in your way, configure @code{org-list-automatic-rules}
1722 to disable them individually.
1725 @orgcmd{@key{TAB},org-cycle}
1726 @cindex cycling, in plain lists
1727 @vindex org-cycle-include-plain-lists
1728 Items can be folded just like headline levels. Normally this works only if
1729 the cursor is on a plain list item. For more details, see the variable
1730 @code{org-cycle-include-plain-lists}. If this variable is set to
1731 @code{integrate}, plain list items will be treated like low-level
1732 headlines. The level of an item is then given by the indentation of the
1733 bullet/number. Items are always subordinate to real headlines, however; the
1734 hierarchies remain completely separated. In a new item with no text yet, the
1735 first @key{TAB} demotes the item to become a child of the previous
1736 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1737 and eventually get it back to its initial position.
1738 @orgcmd{M-@key{RET},org-insert-heading}
1739 @vindex org-M-RET-may-split-line
1740 @vindex org-list-automatic-rules
1741 Insert new item at current level. With a prefix argument, force a new
1742 heading (@pxref{Structure editing}). If this command is used in the middle
1743 of an item, that item is @emph{split} in two, and the second part becomes the
1744 new item@footnote{If you do not want the item to be split, customize the
1745 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1746 @emph{before item's body}, the new item is created @emph{before} the current
1751 @kindex M-S-@key{RET}
1753 Insert a new item with a checkbox (@pxref{Checkboxes}).
1754 @kindex S-@key{down}
1757 @cindex shift-selection-mode
1758 @vindex org-support-shift-select
1759 @vindex org-list-use-circular-motion
1760 Jump to the previous/next item in the current list@footnote{If you want to
1761 cycle around items that way, you may customize
1762 @code{org-list-use-circular-motion}.}, but only if
1763 @code{org-support-shift-select} is off. If not, you can still use paragraph
1764 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1767 @kindex M-@key{down}
1770 Move the item including subitems up/down@footnote{See
1771 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1772 previous/next item of same indentation). If the list is ordered, renumbering
1774 @kindex M-@key{left}
1775 @kindex M-@key{right}
1778 Decrease/increase the indentation of an item, leaving children alone.
1779 @kindex M-S-@key{left}
1780 @kindex M-S-@key{right}
1781 @item M-S-@key{left}
1782 @itemx M-S-@key{right}
1783 Decrease/increase the indentation of the item, including subitems.
1784 Initially, the item tree is selected based on current indentation. When
1785 these commands are executed several times in direct succession, the initially
1786 selected region is used, even if the new indentation would imply a different
1787 hierarchy. To use the new hierarchy, break the command chain with a cursor
1790 As a special case, using this command on the very first item of a list will
1791 move the whole list. This behavior can be disabled by configuring
1792 @code{org-list-automatic-rules}. The global indentation of a list has no
1793 influence on the text @emph{after} the list.
1796 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1797 state of the checkbox. In any case, verify bullets and indentation
1798 consistency in the whole list.
1800 @vindex org-plain-list-ordered-item-terminator
1802 Cycle the entire list level through the different itemize/enumerate bullets
1803 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1804 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1805 and its indentation. With a numeric prefix argument N, select the Nth bullet
1806 from this list. If there is an active region when calling this, selected
1807 text will be changed into an item. With a prefix argument, all lines will be
1808 converted to list items. If the first line already was a list item, any item
1809 marker will be removed from the list. Finally, even without an active
1810 region, a normal line will be converted into a list item.
1813 Turn a plain list item into a headline (so that it becomes a subheading at
1814 its location). @xref{Structure editing}, for a detailed explanation.
1817 Turn the whole plain list into a subtree of the current heading. Checkboxes
1818 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1820 @kindex S-@key{left}
1821 @kindex S-@key{right}
1823 @vindex org-support-shift-select
1824 This command also cycles bullet styles when the cursor in on the bullet or
1825 anywhere in an item line, details depending on
1826 @code{org-support-shift-select}.
1828 @cindex sorting, of plain list
1830 Sort the plain list. You will be prompted for the sorting method:
1831 numerically, alphabetically, by time, by checked status for check lists,
1832 or by a custom function.
1838 @cindex visibility cycling, drawers
1840 @cindex org-insert-drawer
1842 Sometimes you want to keep information associated with an entry, but you
1843 normally don't want to see it. For this, Org mode has @emph{drawers}. They
1844 can contain anything but a headline and another drawer. Drawers look like
1848 ** This is a headline
1849 Still outside the drawer
1851 This is inside the drawer.
1856 You can interactively insert drawers at point by calling
1857 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1858 region, this command will put the region inside the drawer. With a prefix
1859 argument, this command calls @code{org-insert-property-drawer} and add a
1860 property drawer right below the current headline. Completion over drawer
1861 keywords is also possible using @key{M-TAB}.
1863 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1864 show the entry, but keep the drawer collapsed to a single line. In order to
1865 look inside the drawer, you need to move the cursor to the drawer line and
1866 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1867 storing properties (@pxref{Properties and columns}), and you can also arrange
1868 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1869 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1870 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1876 Add a time-stamped note to the LOGBOOK drawer.
1879 @vindex org-export-with-drawers
1880 @vindex org-export-with-properties
1881 You can select the name of the drawers which should be exported with
1882 @code{org-export-with-drawers}. In that case, drawer contents will appear in
1883 export output. Property drawers are not affected by this variable: configure
1884 @code{org-export-with-properties} instead.
1889 @vindex org-hide-block-startup
1890 @cindex blocks, folding
1891 Org mode uses begin...end blocks for various purposes from including source
1892 code examples (@pxref{Literal examples}) to capturing time logging
1893 information (@pxref{Clocking work time}). These blocks can be folded and
1894 unfolded by pressing TAB in the begin line. You can also get all blocks
1895 folded at startup by configuring the option @code{org-hide-block-startup}
1896 or on a per-file basis by using
1898 @cindex @code{hideblocks}, STARTUP keyword
1899 @cindex @code{nohideblocks}, STARTUP keyword
1901 #+STARTUP: hideblocks
1902 #+STARTUP: nohideblocks
1909 Org mode supports the creation of footnotes.
1911 A footnote is started by a footnote marker in square brackets in column 0, no
1912 indentation allowed. It ends at the next footnote definition, headline, or
1913 after two consecutive empty lines. The footnote reference is simply the
1914 marker in square brackets, inside text. Markers always start with
1915 @code{fn:}. For example:
1918 The Org homepage[fn:1] now looks a lot better than it used to.
1920 [fn:1] The link is: http://orgmode.org
1923 Org mode extends the number-based syntax to @emph{named} footnotes and
1924 optional inline definition. Here are the valid references:
1928 A named footnote reference, where @code{name} is a unique label word, or, for
1929 simplicity of automatic creation, a number.
1930 @item [fn::This is the inline definition of this footnote]
1931 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1933 @item [fn:name:a definition]
1934 An inline definition of a footnote, which also specifies a name for the note.
1935 Since Org allows multiple references to the same note, you can then use
1936 @code{[fn:name]} to create additional references.
1939 @vindex org-footnote-auto-label
1940 Footnote labels can be created automatically, or you can create names yourself.
1941 This is handled by the variable @code{org-footnote-auto-label} and its
1942 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1945 @noindent The following command handles footnotes:
1950 The footnote action command.
1952 When the cursor is on a footnote reference, jump to the definition. When it
1953 is at a definition, jump to the (first) reference.
1955 @vindex org-footnote-define-inline
1956 @vindex org-footnote-section
1957 @vindex org-footnote-auto-adjust
1958 Otherwise, create a new footnote. Depending on the option
1959 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1960 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1961 definition will be placed right into the text as part of the reference, or
1962 separately into the location determined by the option
1963 @code{org-footnote-section}.
1965 When this command is called with a prefix argument, a menu of additional
1968 s @r{Sort the footnote definitions by reference sequence. During editing,}
1969 @r{Org makes no effort to sort footnote definitions into a particular}
1970 @r{sequence. If you want them sorted, use this command, which will}
1971 @r{also move entries according to @code{org-footnote-section}. Automatic}
1972 @r{sorting after each insertion/deletion can be configured using the}
1973 @r{option @code{org-footnote-auto-adjust}.}
1974 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1975 @r{after each insertion/deletion can be configured using the option}
1976 @r{@code{org-footnote-auto-adjust}.}
1977 S @r{Short for first @code{r}, then @code{s} action.}
1978 n @r{Normalize the footnotes by collecting all definitions (including}
1979 @r{inline definitions) into a special section, and then numbering them}
1980 @r{in sequence. The references will then also be numbers.}
1981 d @r{Delete the footnote at point, and all definitions of and references}
1984 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1985 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1986 renumbering and sorting footnotes can be automatic after each insertion or
1991 If the cursor is on a footnote reference, jump to the definition. If it is a
1992 the definition, jump back to the reference. When called at a footnote
1993 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1997 @item C-c C-o @r{or} mouse-1/2
1998 Footnote labels are also links to the corresponding definition/reference, and
1999 you can use the usual commands to follow these links.
2001 @vindex org-edit-footnote-reference
2005 Edit the footnote definition corresponding to the reference at point in
2006 a seperate window. The window can be closed by pressing @kbd{C-c '}.
2010 @node Orgstruct mode
2011 @section The Orgstruct minor mode
2012 @cindex Orgstruct mode
2013 @cindex minor mode for structure editing
2015 If you like the intuitive way the Org mode structure editing and list
2016 formatting works, you might want to use these commands in other modes like
2017 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2018 this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2019 turn it on by default, for example in Message mode, with one of:
2022 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2023 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2026 When this mode is active and the cursor is on a line that looks to Org like a
2027 headline or the first line of a list item, most structure editing commands
2028 will work, even if the same keys normally have different functionality in the
2029 major mode you are using. If the cursor is not in one of those special
2030 lines, Orgstruct mode lurks silently in the shadows.
2032 When you use @code{orgstruct++-mode}, Org will also export indentation and
2033 autofill settings into that mode, and detect item context after the first
2036 @vindex orgstruct-heading-prefix-regexp
2037 You can also use Org structure editing to fold and unfold headlines in
2038 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2039 the regular expression must match the local prefix to use before Org's
2040 headlines. For example, if you set this variable to @code{";; "} in Emacs
2041 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2042 commented lines. Some commands like @code{org-demote} are disabled when the
2043 prefix is set, but folding/unfolding will work correctly.
2049 A reference document providing a formal description of Org's syntax is
2050 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2051 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2052 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2053 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2054 file falls into one of the categories above.
2056 To explore the abstract structure of an Org buffer, run this in a buffer:
2059 M-: (org-element-parse-buffer) RET
2062 It will output a list containing the buffer's content represented as an
2063 abstract structure. The export engine relies on the information stored in
2064 this list. Most interactive commands (e.g., for structure editing) also
2065 rely on the syntactic meaning of the surrounding context.
2067 @cindex syntax checker
2069 You can check syntax in your documents using @code{org-lint} command.
2074 @cindex editing tables
2076 Org comes with a fast and intuitive table editor. Spreadsheet-like
2077 calculations are supported using the Emacs @file{calc} package
2078 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2081 * Built-in table editor:: Simple tables
2082 * Column width and alignment:: Overrule the automatic settings
2083 * Column groups:: Grouping to trigger vertical lines
2084 * Orgtbl mode:: The table editor as minor mode
2085 * The spreadsheet:: The table editor has spreadsheet capabilities
2086 * Org-Plot:: Plotting from org tables
2089 @node Built-in table editor
2090 @section The built-in table editor
2091 @cindex table editor, built-in
2093 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2094 the first non-whitespace character is considered part of a table. @samp{|}
2095 is also the column separator@footnote{To insert a vertical bar into a table
2096 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2097 might look like this:
2100 | Name | Phone | Age |
2101 |-------+-------+-----|
2102 | Peter | 1234 | 17 |
2103 | Anna | 4321 | 25 |
2106 A table is re-aligned automatically each time you press @key{TAB} or
2107 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2108 the next field (@key{RET} to the next row) and creates new table rows
2109 at the end of the table or before horizontal lines. The indentation
2110 of the table is set by the first line. Any line starting with
2111 @samp{|-} is considered as a horizontal separator line and will be
2112 expanded on the next re-align to span the whole table width. So, to
2113 create the above table, you would only type
2120 @noindent and then press @key{TAB} to align the table and start filling in
2121 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2122 @kbd{C-c @key{RET}}.
2124 @vindex org-enable-table-editor
2125 @vindex org-table-auto-blank-field
2126 When typing text into a field, Org treats @key{DEL},
2127 @key{Backspace}, and all character keys in a special way, so that
2128 inserting and deleting avoids shifting other fields. Also, when
2129 typing @emph{immediately after the cursor was moved into a new field
2130 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2131 field is automatically made blank. If this behavior is too
2132 unpredictable for you, configure the options
2133 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2136 @tsubheading{Creation and conversion}
2137 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2138 Convert the active region to a table. If every line contains at least one
2139 TAB character, the function assumes that the material is tab separated.
2140 If every line contains a comma, comma-separated values (CSV) are assumed.
2141 If not, lines are split at whitespace into fields. You can use a prefix
2142 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2143 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2144 match the separator, and a numeric argument N indicates that at least N
2145 consecutive spaces, or alternatively a TAB will be the separator.
2147 If there is no active region, this command creates an empty Org
2148 table. But it is easier just to start typing, like
2149 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2151 @tsubheading{Re-aligning and field motion}
2152 @orgcmd{C-c C-c,org-table-align}
2153 Re-align the table and don't move to another field.
2155 @orgcmd{C-c SPC,org-table-blank-field}
2156 Blank the field at point.
2158 @orgcmd{<TAB>,org-table-next-field}
2159 Re-align the table, move to the next field. Creates a new row if
2162 @orgcmd{S-@key{TAB},org-table-previous-field}
2163 Re-align, move to previous field.
2165 @orgcmd{@key{RET},org-table-next-row}
2166 Re-align the table and move down to next row. Creates a new row if
2167 necessary. At the beginning or end of a line, @key{RET} still does
2168 NEWLINE, so it can be used to split a table.
2170 @orgcmd{M-a,org-table-beginning-of-field}
2171 Move to beginning of the current table field, or on to the previous field.
2172 @orgcmd{M-e,org-table-end-of-field}
2173 Move to end of the current table field, or on to the next field.
2175 @tsubheading{Column and row editing}
2176 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2177 Move the current column left/right.
2179 @orgcmd{M-S-@key{left},org-table-delete-column}
2180 Kill the current column.
2182 @orgcmd{M-S-@key{right},org-table-insert-column}
2183 Insert a new column to the left of the cursor position.
2185 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2186 Move the current row up/down.
2188 @orgcmd{M-S-@key{up},org-table-kill-row}
2189 Kill the current row or horizontal line.
2191 @orgcmd{M-S-@key{down},org-table-insert-row}
2192 Insert a new row above the current row. With a prefix argument, the line is
2193 created below the current one.
2195 @orgcmd{C-c -,org-table-insert-hline}
2196 Insert a horizontal line below current row. With a prefix argument, the line
2197 is created above the current line.
2199 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2200 Insert a horizontal line below current row, and move the cursor into the row
2203 @orgcmd{C-c ^,org-table-sort-lines}
2204 Sort the table lines in the region. The position of point indicates the
2205 column to be used for sorting, and the range of lines is the range
2206 between the nearest horizontal separator lines, or the entire table. If
2207 point is before the first column, you will be prompted for the sorting
2208 column. If there is an active region, the mark specifies the first line
2209 and the sorting column, while point should be in the last line to be
2210 included into the sorting. The command prompts for the sorting type
2211 (alphabetically, numerically, or by time). You can sort in normal or
2212 reverse order. You can also supply your own key extraction and comparison
2213 functions. When called with a prefix argument, alphabetic sorting will be
2216 @tsubheading{Regions}
2217 @orgcmd{C-c C-x M-w,org-table-copy-region}
2218 Copy a rectangular region from a table to a special clipboard. Point and
2219 mark determine edge fields of the rectangle. If there is no active region,
2220 copy just the current field. The process ignores horizontal separator lines.
2222 @orgcmd{C-c C-x C-w,org-table-cut-region}
2223 Copy a rectangular region from a table to a special clipboard, and
2224 blank all fields in the rectangle. So this is the ``cut'' operation.
2226 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2227 Paste a rectangular region into a table.
2228 The upper left corner ends up in the current field. All involved fields
2229 will be overwritten. If the rectangle does not fit into the present table,
2230 the table is enlarged as needed. The process ignores horizontal separator
2233 @orgcmd{M-@key{RET},org-table-wrap-region}
2234 Split the current field at the cursor position and move the rest to the line
2235 below. If there is an active region, and both point and mark are in the same
2236 column, the text in the column is wrapped to minimum width for the given
2237 number of lines. A numeric prefix argument may be used to change the number
2238 of desired lines. If there is no region, but you specify a prefix argument,
2239 the current field is made blank, and the content is appended to the field
2242 @tsubheading{Calculations}
2243 @cindex formula, in tables
2244 @cindex calculations, in tables
2245 @cindex region, active
2246 @cindex active region
2247 @cindex transient mark mode
2248 @orgcmd{C-c +,org-table-sum}
2249 Sum the numbers in the current column, or in the rectangle defined by
2250 the active region. The result is shown in the echo area and can
2251 be inserted with @kbd{C-y}.
2253 @orgcmd{S-@key{RET},org-table-copy-down}
2254 @vindex org-table-copy-increment
2255 When current field is empty, copy from first non-empty field above. When not
2256 empty, copy current field down to next row and move cursor along with it.
2257 Depending on the option @code{org-table-copy-increment}, integer field
2258 values will be incremented during copy. Integers that are too large will not
2259 be incremented. Also, a @code{0} prefix argument temporarily disables the
2260 increment. This key is also used by shift-selection and related modes
2261 (@pxref{Conflicts}).
2263 @tsubheading{Miscellaneous}
2264 @orgcmd{C-c `,org-table-edit-field}
2265 Edit the current field in a separate window. This is useful for fields that
2266 are not fully visible (@pxref{Column width and alignment}). When called with
2267 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2268 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2269 window follow the cursor through the table and always show the current
2270 field. The follow mode exits automatically when the cursor leaves the table,
2271 or when you repeat this command with @kbd{C-u C-u C-c `}.
2273 @item M-x org-table-import RET
2274 Import a file as a table. The table should be TAB or whitespace
2275 separated. Use, for example, to import a spreadsheet table or data
2276 from a database, because these programs generally can write
2277 TAB-separated text files. This command works by inserting the file into
2278 the buffer and then converting the region to a table. Any prefix
2279 argument is passed on to the converter, which uses it to determine the
2281 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2282 Tables can also be imported by pasting tabular text into the Org
2283 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2284 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2286 @item M-x org-table-export RET
2287 @findex org-table-export
2288 @vindex org-table-export-default-format
2289 Export the table, by default as a TAB-separated file. Use for data
2290 exchange with, for example, spreadsheet or database programs. The format
2291 used to export the file can be configured in the option
2292 @code{org-table-export-default-format}. You may also use properties
2293 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2294 name and the format for table export in a subtree. Org supports quite
2295 general formats for exported tables. The exporter format is the same as the
2296 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2297 detailed description.
2300 If you don't like the automatic table editor because it gets in your
2301 way on lines which you would like to start with @samp{|}, you can turn
2305 (setq org-enable-table-editor nil)
2308 @noindent Then the only table command that still works is
2309 @kbd{C-c C-c} to do a manual re-align.
2311 @node Column width and alignment
2312 @section Column width and alignment
2313 @cindex narrow columns in tables
2314 @cindex alignment in tables
2316 The width of columns is automatically determined by the table editor. And
2317 also the alignment of a column is determined automatically from the fraction
2318 of number-like versus non-number fields in the column.
2320 Sometimes a single field or a few fields need to carry more text, leading to
2321 inconveniently wide columns. Or maybe you want to make a table with several
2322 columns having a fixed width, regardless of content. To set@footnote{This
2323 feature does not work on XEmacs.} the width of a column, one field anywhere
2324 in the column may contain just the string @samp{<N>} where @samp{N} is an
2325 integer specifying the width of the column in characters. The next re-align
2326 will then set the width of this column to this value.
2330 |---+------------------------------| |---+--------|
2332 | 1 | one | | 1 | one |
2333 | 2 | two | ----\ | 2 | two |
2334 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2335 | 4 | four | | 4 | four |
2336 |---+------------------------------| |---+--------|
2341 Fields that are wider become clipped and end in the string @samp{=>}.
2342 Note that the full text is still in the buffer but is hidden.
2343 To see the full text, hold the mouse over the field---a tool-tip window
2344 will show the full content. To edit such a field, use the command
2345 @kbd{C-c `} (that is @kbd{C-c} followed by the grave accent). This will
2346 open a new window with the full field. Edit it and finish with @kbd{C-c
2349 @vindex org-startup-align-all-tables
2350 When visiting a file containing a table with narrowed columns, the
2351 necessary character hiding has not yet happened, and the table needs to
2352 be aligned before it looks nice. Setting the option
2353 @code{org-startup-align-all-tables} will realign all tables in a file
2354 upon visiting, but also slow down startup. You can also set this option
2355 on a per-file basis with:
2362 If you would like to overrule the automatic alignment of number-rich columns
2363 to the right and of string-rich column to the left, you can use @samp{<r>},
2364 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2365 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2366 also combine alignment and field width like this: @samp{<r10>}.
2368 Lines which only contain these formatting cookies will be removed
2369 automatically when exporting the document.
2372 @section Column groups
2373 @cindex grouping columns in tables
2375 When Org exports tables, it does so by default without vertical
2376 lines because that is visually more satisfying in general. Occasionally
2377 however, vertical lines can be useful to structure a table into groups
2378 of columns, much like horizontal lines can do for groups of rows. In
2379 order to specify column groups, you can use a special row where the
2380 first field contains only @samp{/}. The further fields can either
2381 contain @samp{<} to indicate that this column should start a group,
2382 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2383 and @samp{>}) to make a column
2384 a group of its own. Boundaries between column groups will upon export be
2385 marked with vertical lines. Here is an example:
2388 | N | N^2 | N^3 | N^4 | ~sqrt(n)~ | ~sqrt[4](N)~ |
2389 |---+-----+-----+-----+-----------+--------------|
2390 | / | < | | > | < | > |
2391 | 1 | 1 | 1 | 1 | 1 | 1 |
2392 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2393 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2394 |---+-----+-----+-----+-----------+--------------|
2395 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2398 It is also sufficient to just insert the column group starters after
2399 every vertical line you would like to have:
2402 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2403 |----+-----+-----+-----+---------+------------|
2408 @section The Orgtbl minor mode
2410 @cindex minor mode for tables
2412 If you like the intuitive way the Org table editor works, you
2413 might also want to use it in other modes like Text mode or Mail mode.
2414 The minor mode Orgtbl mode makes this possible. You can always toggle
2415 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2416 example in Message mode, use
2419 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2422 Furthermore, with some special setup, it is possible to maintain tables
2423 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2424 construct @LaTeX{} tables with the underlying ease and power of
2425 Orgtbl mode, including spreadsheet capabilities. For details, see
2426 @ref{Tables in arbitrary syntax}.
2428 @node The spreadsheet
2429 @section The spreadsheet
2430 @cindex calculations, in tables
2431 @cindex spreadsheet capabilities
2432 @cindex @file{calc} package
2434 The table editor makes use of the Emacs @file{calc} package to implement
2435 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2436 derive fields from other fields. While fully featured, Org's implementation
2437 is not identical to other spreadsheets. For example, Org knows the concept
2438 of a @emph{column formula} that will be applied to all non-header fields in a
2439 column without having to copy the formula to each relevant field. There is
2440 also a formula debugger, and a formula editor with features for highlighting
2441 fields in the table corresponding to the references at the point in the
2442 formula, moving these references by arrow keys
2445 * References:: How to refer to another field or range
2446 * Formula syntax for Calc:: Using Calc to compute stuff
2447 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2448 * Durations and time values:: How to compute durations and time values
2449 * Field and range formulas:: Formula for specific (ranges of) fields
2450 * Column formulas:: Formulas valid for an entire column
2451 * Lookup functions:: Lookup functions for searching tables
2452 * Editing and debugging formulas:: Fixing formulas
2453 * Updating the table:: Recomputing all dependent fields
2454 * Advanced features:: Field and column names, parameters and automatic recalc
2458 @subsection References
2461 To compute fields in the table from other fields, formulas must
2462 reference other fields or ranges. In Org, fields can be referenced
2463 by name, by absolute coordinates, and by relative coordinates. To find
2464 out what the coordinates of a field are, press @kbd{C-c ?} in that
2465 field, or press @kbd{C-c @}} to toggle the display of a grid.
2467 @subsubheading Field references
2468 @cindex field references
2469 @cindex references, to fields
2471 Formulas can reference the value of another field in two ways. Like in
2472 any other spreadsheet, you may reference fields with a letter/number
2473 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2474 @vindex org-table-use-standard-references
2475 However, Org prefers@footnote{Org will understand references typed by the
2476 user as @samp{B4}, but it will not use this syntax when offering a formula
2477 for editing. You can customize this behavior using the option
2478 @code{org-table-use-standard-references}.} to use another, more general
2479 representation that looks like this:
2481 @@@var{row}$@var{column}
2484 Column specifications can be absolute like @code{$1},
2485 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2486 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2487 @code{$<} and @code{$>} are immutable references to the first and last
2488 column, respectively, and you can use @code{$>>>} to indicate the third
2489 column from the right.
2491 The row specification only counts data lines and ignores horizontal separator
2492 lines (hlines). Like with columns, you can use absolute row numbers
2493 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2494 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2495 immutable references the first and last@footnote{For backward compatibility
2496 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2497 a stable way to the 5th and 12th field in the last row of the table.
2498 However, this syntax is deprecated, it should not be used for new documents.
2499 Use @code{@@>$} instead.} row in the table, respectively. You may also
2500 specify the row relative to one of the hlines: @code{@@I} refers to the first
2501 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2502 line above the current line, @code{@@+I} to the first such line below the
2503 current line. You can also write @code{@@III+2} which is the second data line
2504 after the third hline in the table.
2506 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2507 i.e., to the row/column for the field being computed. Also, if you omit
2508 either the column or the row part of the reference, the current row/column is
2511 Org's references with @emph{unsigned} numbers are fixed references
2512 in the sense that if you use the same reference in the formula for two
2513 different fields, the same field will be referenced each time.
2514 Org's references with @emph{signed} numbers are floating
2515 references because the same reference operator can reference different
2516 fields depending on the field being calculated by the formula.
2518 Here are a few examples:
2521 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2522 $5 @r{column 5 in the current row (same as @code{E&})}
2523 @@2 @r{current column, row 2}
2524 @@-1$-3 @r{the field one row up, three columns to the left}
2525 @@-I$2 @r{field just under hline above current row, column 2}
2526 @@>$5 @r{field in the last row, in column 5}
2529 @subsubheading Range references
2530 @cindex range references
2531 @cindex references, to ranges
2533 You may reference a rectangular range of fields by specifying two field
2534 references connected by two dots @samp{..}. If both fields are in the
2535 current row, you may simply use @samp{$2..$7}, but if at least one field
2536 is in a different row, you need to use the general @code{@@row$column}
2537 format at least for the first field (i.e the reference must start with
2538 @samp{@@} in order to be interpreted correctly). Examples:
2541 $1..$3 @r{first three fields in the current row}
2542 $P..$Q @r{range, using column names (see under Advanced)}
2543 $<<<..$>> @r{start in third column, continue to the last but one}
2544 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2545 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2546 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2549 @noindent Range references return a vector of values that can be fed
2550 into Calc vector functions. Empty fields in ranges are normally suppressed,
2551 so that the vector contains only the non-empty fields. For other options
2552 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2555 @subsubheading Field coordinates in formulas
2556 @cindex field coordinates
2557 @cindex coordinates, of field
2558 @cindex row, of field coordinates
2559 @cindex column, of field coordinates
2561 One of the very first actions during evaluation of Calc formulas and Lisp
2562 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2563 row or column number of the field where the current result will go to. The
2564 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2565 @code{org-table-current-column}. Examples:
2568 @item if(@@# % 2, $#, string(""))
2569 Insert column number on odd rows, set field to empty on even rows.
2570 @item $2 = '(identity remote(FOO, @@@@#$1))
2571 Copy text or values of each row of column 1 of the table named @code{FOO}
2572 into column 2 of the current table.
2573 @item @@3 = 2 * remote(FOO, @@1$$#)
2574 Insert the doubled value of each column of row 1 of the table named
2575 @code{FOO} into row 3 of the current table.
2578 @noindent For the second/third example, the table named @code{FOO} must have
2579 at least as many rows/columns as the current table. Note that this is
2580 inefficient@footnote{The computation time scales as O(N^2) because the table
2581 named @code{FOO} is parsed for each field to be read.} for large number of
2584 @subsubheading Named references
2585 @cindex named references
2586 @cindex references, named
2587 @cindex name, of column or field
2588 @cindex constants, in calculations
2591 @vindex org-table-formula-constants
2592 @samp{$name} is interpreted as the name of a column, parameter or
2593 constant. Constants are defined globally through the option
2594 @code{org-table-formula-constants}, and locally (for the file) through a
2598 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2602 @vindex constants-unit-system
2603 @pindex constants.el
2604 Also properties (@pxref{Properties and columns}) can be used as
2605 constants in table formulas: for a property @samp{:Xyz:} use the name
2606 @samp{$PROP_Xyz}, and the property will be searched in the current
2607 outline entry and in the hierarchy above it. If you have the
2608 @file{constants.el} package, it will also be used to resolve constants,
2609 including natural constants like @samp{$h} for Planck's constant, and
2610 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2611 supply the values of constants in two different unit systems, @code{SI}
2612 and @code{cgs}. Which one is used depends on the value of the variable
2613 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2614 @code{constSI} and @code{constcgs} to set this value for the current
2615 buffer.}. Column names and parameters can be specified in special table
2616 lines. These are described below, see @ref{Advanced features}. All
2617 names must start with a letter, and further consist of letters and
2620 @subsubheading Remote references
2621 @cindex remote references
2622 @cindex references, remote
2623 @cindex references, to a different table
2624 @cindex name, of column or field
2625 @cindex constants, in calculations
2626 @cindex #+NAME, for table
2628 You may also reference constants, fields and ranges from a different table,
2629 either in the current file or even in a different file. The syntax is
2632 remote(NAME-OR-ID,REF)
2636 where NAME can be the name of a table in the current file as set by a
2637 @code{#+NAME: Name} line before the table. It can also be the ID of an
2638 entry, even in a different file, and the reference then refers to the first
2639 table in that entry. REF is an absolute field or range reference as
2640 described above for example @code{@@3$3} or @code{$somename}, valid in the
2643 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2644 it will be substituted with the name or ID found in this field of the current
2645 table. For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2646 @@>$1)}. The format @code{B3} is not supported because it can not be
2647 distinguished from a plain table name or ID.
2649 @node Formula syntax for Calc
2650 @subsection Formula syntax for Calc
2651 @cindex formula syntax, Calc
2652 @cindex syntax, of formulas
2654 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2655 package. Note that @file{calc} has the non-standard convention that @samp{/}
2656 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2657 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2658 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2659 GNU Emacs Calc Manual}), variable substitution takes place according to the
2660 rules described above.
2661 @cindex vectors, in table calculations
2662 The range vectors can be directly fed into the Calc vector functions
2663 like @samp{vmean} and @samp{vsum}.
2665 @cindex format specifier
2666 @cindex mode, for @file{calc}
2667 @vindex org-calc-default-modes
2668 A formula can contain an optional mode string after a semicolon. This
2669 string consists of flags to influence Calc and other modes during
2670 execution. By default, Org uses the standard Calc modes (precision
2671 12, angular units degrees, fraction and symbolic modes off). The display
2672 format, however, has been changed to @code{(float 8)} to keep tables
2673 compact. The default settings can be configured using the option
2674 @code{org-calc-default-modes}.
2676 @noindent List of modes:
2680 Set the internal Calc calculation precision to 20 digits.
2681 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2682 Normal, scientific, engineering or fixed format of the result of Calc passed
2683 back to Org. Calc formatting is unlimited in precision as long as the Calc
2684 calculation precision is greater.
2685 @item @code{D}, @code{R}
2686 Degree and radian angle modes of Calc.
2687 @item @code{F}, @code{S}
2688 Fraction and symbolic modes of Calc.
2689 @item @code{T}, @code{t}
2690 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2692 If and how to consider empty fields. Without @samp{E} empty fields in range
2693 references are suppressed so that the Calc vector or Lisp list contains only
2694 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2695 fields in ranges or empty field references the value @samp{nan} (not a
2696 number) is used in Calc formulas and the empty string is used for Lisp
2697 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2698 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2700 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2701 to see how this is essential for computations with Lisp formulas. In Calc
2702 formulas it is used only occasionally because there number strings are
2703 already interpreted as numbers without @samp{N}.
2705 Literal, for Lisp formulas only. See the next section.
2709 Unless you use large integer numbers or high-precision-calculation and
2710 -display for floating point numbers you may alternatively provide a
2711 @samp{printf} format specifier to reformat the Calc result after it has been
2712 passed back to Org instead of letting Calc already do the
2713 formatting@footnote{The @samp{printf} reformatting is limited in precision
2714 because the value passed to it is converted into an @samp{integer} or
2715 @samp{double}. The @samp{integer} is limited in size by truncating the
2716 signed value to 32 bits. The @samp{double} is limited in precision to 64
2717 bits overall which leaves approximately 16 significant decimal digits.}. A
2721 $1+$2 @r{Sum of first and second field}
2722 $1+$2;%.2f @r{Same, format result to two decimals}
2723 exp($2)+exp($1) @r{Math functions can be used}
2724 $0;%.1f @r{Reformat current cell to 1 decimal}
2725 ($3-32)*5/9 @r{Degrees F -> C conversion}
2726 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2727 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2728 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2729 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2732 Calc also contains a complete set of logical operations, (@pxref{Logical
2733 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2736 @item if($1 < 20, teen, string(""))
2737 "teen" if age $1 is less than 20, else the Org table result field is set to
2738 empty with the empty string.
2739 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2740 Sum of the first two columns. When at least one of the input fields is empty
2741 the Org table result field is set to empty. @samp{E} is required to not
2742 convert empty fields to 0. @samp{f-1} is an optional Calc format string
2743 similar to @samp{%.1f} but leaves empty results empty.
2744 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2745 Mean value of a range unless there is any empty field. Every field in the
2746 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2747 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2748 @samp{vmean} and the Org table result field is set to empty. Use this when
2749 the sample set is expected to never have missing values.
2750 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2751 Mean value of a range with empty fields skipped. Every field in the range
2752 that is empty is skipped. When all fields in the range are empty the mean
2753 value is not defined and the Org table result field is set to empty. Use
2754 this when the sample set can have a variable size.
2755 @item vmean($1..$7); EN
2756 To complete the example before: Mean value of a range with empty fields
2757 counting as samples with value 0. Use this only when incomplete sample sets
2758 should be padded with 0 to the full size.
2761 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2762 and use them in formula syntax for Calc.
2764 @node Formula syntax for Lisp
2765 @subsection Emacs Lisp forms as formulas
2766 @cindex Lisp forms, as table formulas
2768 It is also possible to write a formula in Emacs Lisp. This can be useful
2769 for string manipulation and control structures, if Calc's functionality is
2772 If a formula starts with an apostrophe followed by an opening parenthesis,
2773 then it is evaluated as a Lisp form. The evaluation should return either a
2774 string or a number. Just as with @file{calc} formulas, you can specify modes
2775 and a printf format after a semicolon.
2777 With Emacs Lisp forms, you need to be conscious about the way field
2778 references are interpolated into the form. By default, a reference will be
2779 interpolated as a Lisp string (in double-quotes) containing the field. If
2780 you provide the @samp{N} mode switch, all referenced elements will be numbers
2781 (non-number fields will be zero) and interpolated as Lisp numbers, without
2782 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2783 literally, without quotes. I.e., if you want a reference to be interpreted
2784 as a string by the Lisp form, enclose the reference operator itself in
2785 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2786 fields, so you can embed them in list or vector syntax.
2788 Here are a few examples---note how the @samp{N} mode is used when we do
2789 computations in Lisp:
2792 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2793 Swap the first two characters of the content of column 1.
2795 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2796 @item '(apply '+ '($1..$4));N
2797 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2800 @node Durations and time values
2801 @subsection Durations and time values
2802 @cindex Duration, computing
2803 @cindex Time, computing
2804 @vindex org-table-duration-custom-format
2806 If you want to compute time values use the @code{T} flag, either in Calc
2807 formulas or Elisp formulas:
2811 | Task 1 | Task 2 | Total |
2812 |---------+----------+----------|
2813 | 2:12 | 1:47 | 03:59:00 |
2814 | 3:02:20 | -2:07:00 | 0.92 |
2815 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2819 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2820 are optional. With the @code{T} flag, computed durations will be displayed
2821 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2822 computed durations will be displayed according to the value of the option
2823 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2824 will display the result as a fraction of hours (see the second formula in the
2827 Negative duration values can be manipulated as well, and integers will be
2828 considered as seconds in addition and subtraction.
2830 @node Field and range formulas
2831 @subsection Field and range formulas
2832 @cindex field formula
2833 @cindex range formula
2834 @cindex formula, for individual table field
2835 @cindex formula, for range of fields
2837 To assign a formula to a particular field, type it directly into the field,
2838 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2839 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2840 the formula will be stored as the formula for this field, evaluated, and the
2841 current field will be replaced with the result.
2844 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2845 below the table. If you type the equation in the 4th field of the 3rd data
2846 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2847 inserting/deleting/swapping columns and rows with the appropriate commands,
2848 @i{absolute references} (but not relative ones) in stored formulas are
2849 modified in order to still reference the same field. To avoid this, in
2850 particular in range references, anchor ranges at the table borders (using
2851 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2852 @code{@@I} notation. Automatic adaptation of field references does of course
2853 not happen if you edit the table structure with normal editing
2854 commands---then you must fix the equations yourself.
2856 Instead of typing an equation into the field, you may also use the following
2860 @orgcmd{C-u C-c =,org-table-eval-formula}
2861 Install a new formula for the current field. The command prompts for a
2862 formula with default taken from the @samp{#+TBLFM:} line, applies
2863 it to the current field, and stores it.
2866 The left-hand side of a formula can also be a special expression in order to
2867 assign the formula to a number of different fields. There is no keyboard
2868 shortcut to enter such range formulas. To add them, use the formula editor
2869 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2874 Column formula, valid for the entire column. This is so common that Org
2875 treats these formulas in a special way, see @ref{Column formulas}.
2877 Row formula, applies to all fields in the specified row. @code{@@>=} means
2880 Range formula, applies to all fields in the given rectangular range. This
2881 can also be used to assign a formula to some but not all fields in a row.
2883 Named field, see @ref{Advanced features}.
2886 @node Column formulas
2887 @subsection Column formulas
2888 @cindex column formula
2889 @cindex formula, for table column
2891 When you assign a formula to a simple column reference like @code{$3=}, the
2892 same formula will be used in all fields of that column, with the following
2893 very convenient exceptions: (i) If the table contains horizontal separator
2894 hlines with rows above and below, everything before the first such hline is
2895 considered part of the table @emph{header} and will not be modified by column
2896 formulas. Therefore a header is mandatory when you use column formulas and
2897 want to add hlines to group rows, like for example to separate a total row at
2898 the bottom from the summand rows above. (ii) Fields that already get a value
2899 from a field/range formula will be left alone by column formulas. These
2900 conditions make column formulas very easy to use.
2902 To assign a formula to a column, type it directly into any field in the
2903 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2904 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2905 the formula will be stored as the formula for the current column, evaluated
2906 and the current field replaced with the result. If the field contains only
2907 @samp{=}, the previously stored formula for this column is used. For each
2908 column, Org will only remember the most recently used formula. In the
2909 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2910 left-hand side of a column formula cannot be the name of column, it must be
2911 the numeric column reference or @code{$>}.
2913 Instead of typing an equation into the field, you may also use the
2917 @orgcmd{C-c =,org-table-eval-formula}
2918 Install a new formula for the current column and replace current field with
2919 the result of the formula. The command prompts for a formula, with default
2920 taken from the @samp{#+TBLFM} line, applies it to the current field and
2921 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2922 will apply it to that many consecutive fields in the current column.
2925 @node Lookup functions
2926 @subsection Lookup functions
2927 @cindex lookup functions in tables
2928 @cindex table lookup functions
2930 Org has three predefined Emacs Lisp functions for lookups in tables.
2932 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2933 @findex org-lookup-first
2934 Searches for the first element @code{S} in list @code{S-LIST} for which
2938 is @code{t}; returns the value from the corresponding position in list
2939 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2940 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2941 order as the corresponding parameters are in the call to
2942 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2943 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2945 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2946 @findex org-lookup-last
2947 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2948 element for which @code{PREDICATE} is @code{t}.
2949 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2950 @findex org-lookup-all
2951 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2952 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2953 values. This function can not be used by itself in a formula, because it
2954 returns a list of values. However, powerful lookups can be built when this
2955 function is combined with other Emacs Lisp functions.
2958 If the ranges used in these functions contain empty fields, the @code{E} mode
2959 for the formula should usually be specified: otherwise empty fields will not be
2960 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2961 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2962 element of @code{R-LIST}.
2964 These three functions can be used to implement associative arrays, count
2965 matching cells, rank results, group data etc. For practical examples
2966 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2969 @node Editing and debugging formulas
2970 @subsection Editing and debugging formulas
2971 @cindex formula editing
2972 @cindex editing, of table formulas
2974 @vindex org-table-use-standard-references
2975 You can edit individual formulas in the minibuffer or directly in the field.
2976 Org can also prepare a special buffer with all active formulas of a table.
2977 When offering a formula for editing, Org converts references to the standard
2978 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2979 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2980 option @code{org-table-use-standard-references}.
2983 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2984 Edit the formula associated with the current column/field in the
2985 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2986 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2987 Re-insert the active formula (either a
2988 field formula, or a column formula) into the current field, so that you
2989 can edit it directly in the field. The advantage over editing in the
2990 minibuffer is that you can use the command @kbd{C-c ?}.
2991 @orgcmd{C-c ?,org-table-field-info}
2992 While editing a formula in a table field, highlight the field(s)
2993 referenced by the reference at the cursor position in the formula.
2995 @findex org-table-toggle-coordinate-overlays
2997 Toggle the display of row and column numbers for a table, using overlays
2998 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2999 time the table is aligned; you can force it with @kbd{C-c C-c}.
3001 @findex org-table-toggle-formula-debugger
3003 Toggle the formula debugger on and off
3004 (@command{org-table-toggle-formula-debugger}). See below.
3005 @orgcmd{C-c ',org-table-edit-formulas}
3006 Edit all formulas for the current table in a special buffer, where the
3007 formulas will be displayed one per line. If the current field has an
3008 active formula, the cursor in the formula editor will mark it.
3009 While inside the special buffer, Org will automatically highlight
3010 any field or range reference at the cursor position. You may edit,
3011 remove and add formulas, and use the following commands:
3014 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3015 Exit the formula editor and store the modified formulas. With @kbd{C-u}
3016 prefix, also apply the new formulas to the entire table.
3017 @orgcmd{C-c C-q,org-table-fedit-abort}
3018 Exit the formula editor without installing changes.
3019 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3020 Toggle all references in the formula editor between standard (like
3021 @code{B3}) and internal (like @code{@@3$2}).
3022 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3023 Pretty-print or indent Lisp formula at point. When in a line containing
3024 a Lisp formula, format the formula according to Emacs Lisp rules.
3025 Another @key{TAB} collapses the formula back again. In the open
3026 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3027 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3028 Complete Lisp symbols, just like in Emacs Lisp mode.
3030 @kindex S-@key{down}
3031 @kindex S-@key{left}
3032 @kindex S-@key{right}
3033 @findex org-table-fedit-ref-up
3034 @findex org-table-fedit-ref-down
3035 @findex org-table-fedit-ref-left
3036 @findex org-table-fedit-ref-right
3037 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3038 Shift the reference at point. For example, if the reference is
3039 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3040 This also works for relative references and for hline references.
3041 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3042 Move the test line for column formulas in the Org buffer up and
3044 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3045 Scroll the window displaying the table.
3047 @findex org-table-toggle-coordinate-overlays
3049 Turn the coordinate grid in the table on and off.
3053 Making a table field blank does not remove the formula associated with
3054 the field, because that is stored in a different line (the @samp{#+TBLFM}
3055 line)---during the next recalculation the field will be filled again.
3056 To remove a formula from a field, you have to give an empty reply when
3057 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3060 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3061 equations with @kbd{C-c C-c} in that line or with the normal
3062 recalculation commands in the table.
3064 @anchor{Using multiple #+TBLFM lines}
3065 @subsubheading Using multiple #+TBLFM lines
3066 @cindex #+TBLFM line, multiple
3068 @cindex #+TBLFM, switching
3071 You may apply the formula temporarily. This is useful when you
3072 switch the formula. Place multiple @samp{#+TBLFM} lines right
3073 after the table, and then press @kbd{C-c C-c} on the formula to
3074 apply. Here is an example:
3086 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3098 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3099 will get the following result of applying only the first @samp{#+TBLFM} line.
3110 @subsubheading Debugging formulas
3111 @cindex formula debugging
3112 @cindex debugging, of table formulas
3113 When the evaluation of a formula leads to an error, the field content
3114 becomes the string @samp{#ERROR}. If you would like see what is going
3115 on during variable substitution and calculation in order to find a bug,
3116 turn on formula debugging in the @code{Tbl} menu and repeat the
3117 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3118 field. Detailed information will be displayed.
3120 @node Updating the table
3121 @subsection Updating the table
3122 @cindex recomputing table fields
3123 @cindex updating, table
3125 Recalculation of a table is normally not automatic, but needs to be
3126 triggered by a command. See @ref{Advanced features}, for a way to make
3127 recalculation at least semi-automatic.
3129 In order to recalculate a line of a table or the entire table, use the
3133 @orgcmd{C-c *,org-table-recalculate}
3134 Recalculate the current row by first applying the stored column formulas
3135 from left to right, and all field/range formulas in the current row.
3141 Recompute the entire table, line by line. Any lines before the first
3142 hline are left alone, assuming that these are part of the table header.
3144 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3145 Iterate the table by recomputing it until no further changes occur.
3146 This may be necessary if some computed fields use the value of other
3147 fields that are computed @i{later} in the calculation sequence.
3148 @item M-x org-table-recalculate-buffer-tables RET
3149 @findex org-table-recalculate-buffer-tables
3150 Recompute all tables in the current buffer.
3151 @item M-x org-table-iterate-buffer-tables RET
3152 @findex org-table-iterate-buffer-tables
3153 Iterate all tables in the current buffer, in order to converge table-to-table
3157 @node Advanced features
3158 @subsection Advanced features
3160 If you want the recalculation of fields to happen automatically, or if you
3161 want to be able to assign @i{names}@footnote{Such names must start by an
3162 alphabetic character and use only alphanumeric/underscore characters.} to
3163 fields and columns, you need to reserve the first column of the table for
3164 special marking characters.
3167 @orgcmd{C-#,org-table-rotate-recalc-marks}
3168 Rotate the calculation mark in first column through the states @samp{ },
3169 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3170 change all marks in the region.
3173 Here is an example of a table that collects exam results of students and
3174 makes use of these features:
3178 |---+---------+--------+--------+--------+-------+------|
3179 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3180 |---+---------+--------+--------+--------+-------+------|
3181 | ! | | P1 | P2 | P3 | Tot | |
3182 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3183 | ^ | | m1 | m2 | m3 | mt | |
3184 |---+---------+--------+--------+--------+-------+------|
3185 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3186 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3187 |---+---------+--------+--------+--------+-------+------|
3188 | | Average | | | | 25.0 | |
3189 | ^ | | | | | at | |
3190 | $ | max=50 | | | | | |
3191 |---+---------+--------+--------+--------+-------+------|
3192 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3196 @noindent @b{Important}: please note that for these special tables,
3197 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3198 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3199 to the field itself. The column formulas are not applied in rows with
3202 @cindex marking characters, tables
3203 The marking characters have the following meaning:
3207 The fields in this line define names for the columns, so that you may
3208 refer to a column as @samp{$Tot} instead of @samp{$6}.
3210 This row defines names for the fields @emph{above} the row. With such
3211 a definition, any formula in the table may use @samp{$m1} to refer to
3212 the value @samp{10}. Also, if you assign a formula to a names field, it
3213 will be stored as @samp{$name=...}.
3215 Similar to @samp{^}, but defines names for the fields in the row
3218 Fields in this row can define @emph{parameters} for formulas. For
3219 example, if a field in a @samp{$} row contains @samp{max=50}, then
3220 formulas in this table can refer to the value 50 using @samp{$max}.
3221 Parameters work exactly like constants, only that they can be defined on
3224 Fields in this row are automatically recalculated when pressing
3225 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3226 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3227 lines will be left alone by this command.
3229 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3230 not for automatic recalculation. Use this when automatic
3231 recalculation slows down editing too much.
3233 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3234 All lines that should be recalculated should be marked with @samp{#}
3237 Do not export this line. Useful for lines that contain the narrowing
3238 @samp{<N>} markers or column group markers.
3241 Finally, just to whet your appetite for what can be done with the
3242 fantastic @file{calc.el} package, here is a table that computes the Taylor
3243 series of degree @code{n} at location @code{x} for a couple of
3248 |---+-------------+---+-----+--------------------------------------|
3249 | | Func | n | x | Result |
3250 |---+-------------+---+-----+--------------------------------------|
3251 | # | exp(x) | 1 | x | 1 + x |
3252 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3253 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3254 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3255 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3256 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3257 |---+-------------+---+-----+--------------------------------------|
3258 #+TBLFM: $5=taylor($2,$4,$3);n3
3264 @cindex graph, in tables
3265 @cindex plot tables using Gnuplot
3268 Org-Plot can produce graphs of information stored in org tables, either
3269 graphically or in ASCII-art.
3271 @subheading Graphical plots using @file{Gnuplot}
3273 Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
3274 @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3275 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3276 that you have both Gnuplot and Gnuplot mode installed on your system, then
3277 call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
3282 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3283 | Sede | Max cites | H-index |
3284 |-----------+-----------+---------|
3285 | Chile | 257.72 | 21.39 |
3286 | Leeds | 165.77 | 19.68 |
3287 | Sao Paolo | 71.00 | 11.50 |
3288 | Stockholm | 134.19 | 14.33 |
3289 | Morelia | 257.56 | 17.67 |
3293 Notice that Org Plot is smart enough to apply the table's headers as labels.
3294 Further control over the labels, type, content, and appearance of plots can
3295 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3296 for a complete list of Org-plot options. The @code{#+PLOT:} lines are
3297 optional. For more information and examples see the Org-plot tutorial at
3298 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3300 @subsubheading Plot Options
3304 Specify any @command{gnuplot} option to be set when graphing.
3307 Specify the title of the plot.
3310 Specify which column of the table to use as the @code{x} axis.
3313 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3314 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3315 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3319 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3322 Specify a @code{with} option to be inserted for every col being plotted
3323 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3324 Defaults to @code{lines}.
3327 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3330 List of labels to be used for the @code{deps} (defaults to the column headers
3334 Specify an entire line to be inserted in the Gnuplot script.
3337 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3338 flat mapping rather than a @code{3d} slope.
3341 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3342 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3345 If you want total control, you can specify a script file (place the file name
3346 between double-quotes) which will be used to plot. Before plotting, every
3347 instance of @code{$datafile} in the specified script will be replaced with
3348 the path to the generated data file. Note: even if you set this option, you
3349 may still want to specify the plot type, as that can impact the content of
3353 @subheading ASCII bar plots
3355 While the cursor is on a column, typing @kbd{C-c " a} or
3356 @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
3357 ASCII-art bars plot. The plot is implemented through a regular column
3358 formula. When the source column changes, the bar plot may be updated by
3359 refreshing the table, for example typing @kbd{C-u C-c *}.
3363 | Sede | Max cites | |
3364 |---------------+-----------+--------------|
3365 | Chile | 257.72 | WWWWWWWWWWWW |
3366 | Leeds | 165.77 | WWWWWWWh |
3367 | Sao Paolo | 71.00 | WWW; |
3368 | Stockholm | 134.19 | WWWWWW: |
3369 | Morelia | 257.56 | WWWWWWWWWWWH |
3370 | Rochefourchat | 0.00 | |
3371 #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3375 The formula is an elisp call:
3377 (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
3382 is a reference to the source column.
3385 are the minimal and maximal values displayed. Sources values
3386 outside this range are displayed as @samp{too small}
3387 or @samp{too large}.
3390 is the width in characters of the bar-plot. It defaults to @samp{12}.
3398 Like HTML, Org provides links inside a file, external links to
3399 other files, Usenet articles, emails, and much more.
3402 * Link format:: How links in Org are formatted
3403 * Internal links:: Links to other places in the current file
3404 * External links:: URL-like links to the world
3405 * Handling links:: Creating, inserting and following
3406 * Using links outside Org:: Linking from my C source code?
3407 * Link abbreviations:: Shortcuts for writing complex links
3408 * Search options:: Linking to a specific location
3409 * Custom searches:: When the default search is not enough
3413 @section Link format
3415 @cindex format, of links
3417 Org will recognize plain URL-like links and activate them as
3418 clickable links. The general link format, however, looks like this:
3421 [[link][description]] @r{or alternatively} [[link]]
3425 Once a link in the buffer is complete (all brackets present), Org
3426 will change the display so that @samp{description} is displayed instead
3427 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3428 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3429 which by default is an underlined face. You can directly edit the
3430 visible part of a link. Note that this can be either the @samp{link}
3431 part (if there is no description) or the @samp{description} part. To
3432 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3435 If you place the cursor at the beginning or just behind the end of the
3436 displayed text and press @key{BACKSPACE}, you will remove the
3437 (invisible) bracket at that location. This makes the link incomplete
3438 and the internals are again displayed as plain text. Inserting the
3439 missing bracket hides the link internals again. To show the
3440 internal structure of all links, use the menu entry
3441 @code{Org->Hyperlinks->Literal links}.
3443 @node Internal links
3444 @section Internal links
3445 @cindex internal links
3446 @cindex links, internal
3447 @cindex targets, for links
3449 @cindex property, CUSTOM_ID
3450 If the link does not look like a URL, it is considered to be internal in the
3451 current file. The most important case is a link like
3452 @samp{[[#my-custom-id]]} which will link to the entry with the
3453 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3454 to make sure these custom IDs are unique in a file.
3456 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3457 lead to a text search in the current file.
3459 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3460 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3461 point to the corresponding headline. The preferred match for a text link is
3462 a @i{dedicated target}: the same string in double angular brackets, like
3463 @samp{<<My Target>>}.
3466 If no dedicated target exists, the link will then try to match the exact name
3467 of an element within the buffer. Naming is done with the @code{#+NAME}
3468 keyword, which has to be put in the line before the element it refers to, as
3469 in the following example
3478 If none of the above succeeds, Org will search for a headline that is exactly
3479 the link text but may also include a TODO keyword and tags@footnote{To insert
3480 a link targeting a headline, in-buffer completion can be used. Just type
3481 a star followed by a few optional letters into the buffer and press
3482 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3485 During export, internal links will be used to mark objects and assign them
3486 a number. Marked objects will then be referenced by links pointing to them.
3487 In particular, links without a description will appear as the number assigned
3488 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3489 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3490 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3494 - <<target>>another item
3495 Here we refer to item [[target]].
3499 The last sentence will appear as @samp{Here we refer to item 2} when
3502 In non-Org files, the search will look for the words in the link text. In
3503 the above example the search would be for @samp{my target}.
3505 Following a link pushes a mark onto Org's own mark ring. You can
3506 return to the previous position with @kbd{C-c &}. Using this command
3507 several times in direct succession goes back to positions recorded
3511 * Radio targets:: Make targets trigger links in plain text
3515 @subsection Radio targets
3516 @cindex radio targets
3517 @cindex targets, radio
3518 @cindex links, radio targets
3520 Org can automatically turn any occurrences of certain target names
3521 in normal text into a link. So without explicitly creating a link, the
3522 text connects to the target radioing its position. Radio targets are
3523 enclosed by triple angular brackets. For example, a target @samp{<<<My
3524 Target>>>} causes each occurrence of @samp{my target} in normal text to
3525 become activated as a link. The Org file is scanned automatically
3526 for radio targets only when the file is first loaded into Emacs. To
3527 update the target list during editing, press @kbd{C-c C-c} with the
3528 cursor on or at a target.
3530 @node External links
3531 @section External links
3532 @cindex links, external
3533 @cindex external links
3541 @cindex USENET links
3546 Org supports links to files, websites, Usenet and email messages, BBDB
3547 database entries and links to both IRC conversations and their logs.
3548 External links are URL-like locators. They start with a short identifying
3549 string followed by a colon. There can be no space after the colon. The
3550 following list shows examples for each link type.
3553 http://www.astro.uva.nl/~dominik @r{on the web}
3554 doi:10.1000/182 @r{DOI for an electronic resource}
3555 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3556 /home/dominik/images/jupiter.jpg @r{same as above}
3557 file:papers/last.pdf @r{file, relative path}
3558 ./papers/last.pdf @r{same as above}
3559 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3560 /myself@@some.where:papers/last.pdf @r{same as above}
3561 file:sometextfile::NNN @r{file, jump to line number}
3562 file:projects.org @r{another Org file}
3563 file:projects.org::some words @r{text search in Org file}@footnote{
3564 The actual behavior of the search will depend on the value of
3565 the option @code{org-link-search-must-match-exact-headline}. If its value
3566 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3567 exact headline will be matched, ignoring spaces and cookies. If the value is
3568 @code{query-to-create}, then an exact headline will be searched; if it is not
3569 found, then the user will be queried to create it.}
3570 file:projects.org::*task title @r{heading search in Org
3571 file}@footnote{ Headline searches always match the exact headline, ignoring
3572 spaces and cookies. If the headline is not found and the value of the option
3573 @code{org-link-search-must-match-exact-headline} is @code{query-to-create},
3574 then the user will be queried to create it.}
3575 file+sys:/path/to/file @r{open via OS, like double-click}
3576 file+emacs:/path/to/file @r{force opening by Emacs}
3577 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3578 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3579 news:comp.emacs @r{Usenet link}
3580 mailto:adent@@galaxy.net @r{Mail link}
3581 mhe:folder @r{MH-E folder link}
3582 mhe:folder#id @r{MH-E message link}
3583 rmail:folder @r{RMAIL folder link}
3584 rmail:folder#id @r{RMAIL message link}
3585 gnus:group @r{Gnus group link}
3586 gnus:group#id @r{Gnus article link}
3587 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3588 irc:/irc.com/#emacs/bob @r{IRC link}
3589 info:org#External links @r{Info node or index link}
3590 shell:ls *.org @r{A shell command}
3591 elisp:org-agenda @r{Interactive Elisp command}
3592 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3596 @cindex WANDERLUST links
3597 On top of these built-in link types, some are available through the
3598 @code{contrib/} directory (@pxref{Installation}). For example, these links
3599 to VM or Wanderlust messages are available when you load the corresponding
3600 libraries from the @code{contrib/} directory:
3603 vm:folder @r{VM folder link}
3604 vm:folder#id @r{VM message link}
3605 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3606 vm-imap:account:folder @r{VM IMAP folder link}
3607 vm-imap:account:folder#id @r{VM IMAP message link}
3608 wl:folder @r{WANDERLUST folder link}
3609 wl:folder#id @r{WANDERLUST message link}
3612 For customizing Org to add new link types @ref{Adding hyperlink types}.
3614 A link should be enclosed in double brackets and may contain a descriptive
3615 text to be displayed instead of the URL (@pxref{Link format}), for example:
3618 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3622 If the description is a file name or URL that points to an image, HTML
3623 export (@pxref{HTML export}) will inline the image as a clickable
3624 button. If there is no description at all and the link points to an
3626 that image will be inlined into the exported HTML file.
3628 @cindex square brackets, around links
3629 @cindex plain text external links
3630 Org also finds external links in the normal text and activates them
3631 as links. If spaces must be part of the link (for example in
3632 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3633 about the end of the link, enclose them in square brackets.
3635 @node Handling links
3636 @section Handling links
3637 @cindex links, handling
3639 Org provides methods to create a link in the correct syntax, to
3640 insert it into an Org file, and to follow the link.
3643 @orgcmd{C-c l,org-store-link}
3644 @cindex storing links
3645 Store a link to the current location. This is a @emph{global} command (you
3646 must create the key binding yourself) which can be used in any buffer to
3647 create a link. The link will be stored for later insertion into an Org
3648 buffer (see below). What kind of link will be created depends on the current
3651 @b{Org mode buffers}@*
3652 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3653 to the target. Otherwise it points to the current headline, which will also
3654 be the description@footnote{If the headline contains a timestamp, it will be
3655 removed from the link and result in a wrong link---you should avoid putting
3656 timestamp in the headline.}.
3658 @vindex org-id-link-to-org-use-id
3659 @cindex property, CUSTOM_ID
3660 @cindex property, ID
3661 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3662 will be stored. In addition or alternatively (depending on the value of
3663 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3664 be created and/or used to construct a link@footnote{The library
3665 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3666 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3667 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3668 potentially create two links: a human-readable from the custom ID, and one
3669 that is globally unique and works even if the entry is moved from file to
3670 file. Later, when inserting the link, you need to decide which one to use.
3672 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3673 Pretty much all Emacs mail clients are supported. The link will point to the
3674 current article, or, in some GNUS buffers, to the group. The description is
3675 constructed from the author and the subject.
3677 @b{Web browsers: W3 and W3M}@*
3678 Here the link will be the current URL, with the page title as description.
3680 @b{Contacts: BBDB}@*
3681 Links created in a BBDB buffer will point to the current entry.
3684 @vindex org-irc-link-to-logs
3685 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3686 a @samp{file:/} style link to the relevant point in the logs for the current
3687 conversation is created. Otherwise an @samp{irc:/} style link to the
3688 user/channel/server under the point will be stored.
3691 For any other files, the link will point to the file, with a search string
3692 (@pxref{Search options}) pointing to the contents of the current line. If
3693 there is an active region, the selected words will form the basis of the
3694 search string. If the automatically created link is not working correctly or
3695 accurately enough, you can write custom functions to select the search string
3696 and to do the search for particular file types---see @ref{Custom searches}.
3697 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3700 When the cursor is in an agenda view, the created link points to the
3701 entry referenced by the current line.
3704 @orgcmd{C-c C-l,org-insert-link}
3705 @cindex link completion
3706 @cindex completion, of links
3707 @cindex inserting links
3708 @vindex org-keep-stored-link-after-insertion
3709 Insert a link@footnote{Note that you don't have to use this command to
3710 insert a link. Links in Org are plain text, and you can type or paste them
3711 straight into the buffer. By using this command, the links are automatically
3712 enclosed in double brackets, and you will be asked for the optional
3713 descriptive text.}. This prompts for a link to be inserted into the buffer.
3714 You can just type a link, using text for an internal link, or one of the link
3715 type prefixes mentioned in the examples above. The link will be inserted
3716 into the buffer@footnote{After insertion of a stored link, the link will be
3717 removed from the list of stored links. To keep it in the list later use, use
3718 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3719 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3720 If some text was selected when this command is called, the selected text
3721 becomes the default description.
3723 @b{Inserting stored links}@*
3724 All links stored during the
3725 current session are part of the history for this prompt, so you can access
3726 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3728 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3729 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3730 defined through link abbreviations (@pxref{Link abbreviations}). If you
3731 press @key{RET} after inserting only the @var{prefix}, Org will offer
3732 specific completion support for some link types@footnote{This works by
3733 calling a special function @code{org-PREFIX-complete-link}.} For
3734 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3735 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3736 @key{RET}} you can complete contact names.
3738 @cindex file name completion
3739 @cindex completion, of file names
3740 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3741 a file will be inserted and you may use file name completion to select
3742 the name of the file. The path to the file is inserted relative to the
3743 directory of the current Org file, if the linked file is in the current
3744 directory or in a sub-directory of it, or if the path is written relative
3745 to the current directory using @samp{../}. Otherwise an absolute path
3746 is used, if possible with @samp{~/} for your home directory. You can
3747 force an absolute path with two @kbd{C-u} prefixes.
3749 @item C-c C-l @ @r{(with cursor on existing link)}
3750 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3751 link and description parts of the link.
3753 @cindex following links
3754 @orgcmd{C-c C-o,org-open-at-point}
3755 @vindex org-file-apps
3756 @vindex org-link-frame-setup
3757 Open link at point. This will launch a web browser for URLs (using
3758 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3759 the corresponding links, and execute the command in a shell link. When the
3760 cursor is on an internal link, this command runs the corresponding search.
3761 When the cursor is on a TAG list in a headline, it creates the corresponding
3762 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3763 date. Furthermore, it will visit text and remote files in @samp{file:} links
3764 with Emacs and select a suitable application for local non-text files.
3765 Classification of files is based on file extension only. See option
3766 @code{org-file-apps}. If you want to override the default application and
3767 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3768 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3769 If the cursor is on a headline, but not on a link, offer all links in the
3770 headline and entry text. If you want to setup the frame configuration for
3771 following links, customize @code{org-link-frame-setup}.
3774 @vindex org-return-follows-link
3775 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3782 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3783 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3787 @vindex org-display-internal-link-with-indirect-buffer
3788 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3789 internal links to be displayed in another window@footnote{See the
3790 option @code{org-display-internal-link-with-indirect-buffer}}.
3792 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3793 @cindex inlining images
3794 @cindex images, inlining
3795 @vindex org-startup-with-inline-images
3796 @cindex @code{inlineimages}, STARTUP keyword
3797 @cindex @code{noinlineimages}, STARTUP keyword
3798 Toggle the inline display of linked images. Normally this will only inline
3799 images that have no description part in the link, i.e., images that will also
3800 be inlined during export. When called with a prefix argument, also display
3801 images that do have a link description. You can ask for inline images to be
3802 displayed at startup by configuring the variable
3803 @code{org-startup-with-inline-images}@footnote{with corresponding
3804 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3805 @orgcmd{C-c %,org-mark-ring-push}
3807 Push the current position onto the mark ring, to be able to return
3808 easily. Commands following an internal link do this automatically.
3810 @orgcmd{C-c &,org-mark-ring-goto}
3811 @cindex links, returning to
3812 Jump back to a recorded position. A position is recorded by the
3813 commands following internal links, and by @kbd{C-c %}. Using this
3814 command several times in direct succession moves through a ring of
3815 previously recorded positions.
3817 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3818 @cindex links, finding next/previous
3819 Move forward/backward to the next link in the buffer. At the limit of
3820 the buffer, the search fails once, and then wraps around. The key
3821 bindings for this are really too long; you might want to bind this also
3822 to @kbd{C-n} and @kbd{C-p}
3824 (add-hook 'org-load-hook
3826 (define-key org-mode-map "\C-n" 'org-next-link)
3827 (define-key org-mode-map "\C-p" 'org-previous-link)))
3831 @node Using links outside Org
3832 @section Using links outside Org
3834 You can insert and follow links that have Org syntax not only in
3835 Org, but in any Emacs buffer. For this, you should create two
3836 global commands, like this (please select suitable global keys
3840 (global-set-key "\C-c L" 'org-insert-link-global)
3841 (global-set-key "\C-c o" 'org-open-at-point-global)
3844 @node Link abbreviations
3845 @section Link abbreviations
3846 @cindex link abbreviations
3847 @cindex abbreviation, links
3849 Long URLs can be cumbersome to type, and often many similar links are
3850 needed in a document. For this you can use link abbreviations. An
3851 abbreviated link looks like this
3854 [[linkword:tag][description]]
3858 @vindex org-link-abbrev-alist
3859 where the tag is optional.
3860 The @i{linkword} must be a word, starting with a letter, followed by
3861 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3862 according to the information in the variable @code{org-link-abbrev-alist}
3863 that relates the linkwords to replacement text. Here is an example:
3867 (setq org-link-abbrev-alist
3868 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3869 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3870 ("google" . "http://www.google.com/search?q=")
3871 ("gmap" . "http://maps.google.com/maps?q=%s")
3872 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3873 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3877 If the replacement text contains the string @samp{%s}, it will be
3878 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3879 url-encode the tag (see the example above, where we need to encode
3880 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3881 to a custom function, and replace it by the resulting string.
3883 If the replacement text doesn't contain any specifier, it will simply
3884 be appended to the string in order to create the link.
3886 Instead of a string, you may also specify a function that will be
3887 called with the tag as the only argument to create the link.
3889 With the above setting, you could link to a specific bug with
3890 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3891 @code{[[google:OrgMode]]}, show the map location of the Free Software
3892 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3893 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3894 what the Org author is doing besides Emacs hacking with
3895 @code{[[ads:Dominik,C]]}.
3897 If you need special abbreviations just for a single Org buffer, you
3898 can define them in the file with
3902 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3903 #+LINK: google http://www.google.com/search?q=%s
3907 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3908 complete link abbreviations. You may also define a function
3909 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3910 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3911 not accept any arguments, and return the full link with prefix.
3913 @node Search options
3914 @section Search options in file links
3915 @cindex search option in file links
3916 @cindex file links, searching
3918 File links can contain additional information to make Emacs jump to a
3919 particular location in the file when following a link. This can be a
3920 line number or a search option after a double@footnote{For backward
3921 compatibility, line numbers can also follow a single colon.} colon. For
3922 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3923 links}) to a file, it encodes the words in the current line as a search
3924 string that can be used to find this line back later when following the
3925 link with @kbd{C-c C-o}.
3927 Here is the syntax of the different ways to attach a search to a file
3928 link, together with an explanation:
3931 [[file:~/code/main.c::255]]
3932 [[file:~/xx.org::My Target]]
3933 [[file:~/xx.org::*My Target]]
3934 [[file:~/xx.org::#my-custom-id]]
3935 [[file:~/xx.org::/regexp/]]
3942 Search for a link target @samp{<<My Target>>}, or do a text search for
3943 @samp{my target}, similar to the search in internal links, see
3944 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3945 link will become an HTML reference to the corresponding named anchor in
3948 In an Org file, restrict search to headlines.
3950 Link to a heading with a @code{CUSTOM_ID} property
3952 Do a regular expression search for @code{regexp}. This uses the Emacs
3953 command @code{occur} to list all matches in a separate window. If the
3954 target file is in Org mode, @code{org-occur} is used to create a
3955 sparse tree with the matches.
3956 @c If the target file is a directory,
3957 @c @code{grep} will be used to search all files in the directory.
3960 As a degenerate case, a file link with an empty file name can be used
3961 to search the current file. For example, @code{[[file:::find me]]} does
3962 a search for @samp{find me} in the current file, just as
3963 @samp{[[find me]]} would.
3965 @node Custom searches
3966 @section Custom Searches
3967 @cindex custom search strings
3968 @cindex search strings, custom
3970 The default mechanism for creating search strings and for doing the
3971 actual search related to a file link may not work correctly in all
3972 cases. For example, Bib@TeX{} database files have many entries like
3973 @samp{year="1993"} which would not result in good search strings,
3974 because the only unique identification for a Bib@TeX{} entry is the
3977 @vindex org-create-file-search-functions
3978 @vindex org-execute-file-search-functions
3979 If you come across such a problem, you can write custom functions to set
3980 the right search string for a particular file type, and to do the search
3981 for the string in the file. Using @code{add-hook}, these functions need
3982 to be added to the hook variables
3983 @code{org-create-file-search-functions} and
3984 @code{org-execute-file-search-functions}. See the docstring for these
3985 variables for more information. Org actually uses this mechanism
3986 for Bib@TeX{} database files, and you can use the corresponding code as
3987 an implementation example. See the file @file{org-bibtex.el}.
3993 Org mode does not maintain TODO lists as separate documents@footnote{Of
3994 course, you can make a document that contains only long lists of TODO items,
3995 but this is not required.}. Instead, TODO items are an integral part of the
3996 notes file, because TODO items usually come up while taking notes! With Org
3997 mode, simply mark any entry in a tree as being a TODO item. In this way,
3998 information is not duplicated, and the entire context from which the TODO
3999 item emerged is always present.
4001 Of course, this technique for managing TODO items scatters them
4002 throughout your notes file. Org mode compensates for this by providing
4003 methods to give you an overview of all the things that you have to do.
4006 * TODO basics:: Marking and displaying TODO entries
4007 * TODO extensions:: Workflow and assignments
4008 * Progress logging:: Dates and notes for progress
4009 * Priorities:: Some things are more important than others
4010 * Breaking down tasks:: Splitting a task into manageable pieces
4011 * Checkboxes:: Tick-off lists
4015 @section Basic TODO functionality
4017 Any headline becomes a TODO item when it starts with the word
4018 @samp{TODO}, for example:
4021 *** TODO Write letter to Sam Fortune
4025 The most important commands to work with TODO entries are:
4028 @orgcmd{C-c C-t,org-todo}
4029 @cindex cycling, of TODO states
4030 @vindex org-use-fast-todo-selection
4032 Rotate the TODO state of the current item among
4035 ,-> (unmarked) -> TODO -> DONE --.
4036 '--------------------------------'
4039 If TODO keywords have fast access keys (see @ref{Fast access to TODO
4040 states}), you will be prompted for a TODO keyword through the fast selection
4041 interface; this is the default behavior when
4042 @code{org-use-fast-todo-selection} is non-@code{nil}.
4044 The same rotation can also be done ``remotely'' from the timeline and agenda
4045 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
4047 @orgkey{C-u C-c C-t}
4048 When TODO keywords have no selection keys, select a specific keyword using
4049 completion; otherwise force cycling through TODO states with no prompt. When
4050 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
4051 selection interface.
4053 @kindex S-@key{right}
4054 @kindex S-@key{left}
4055 @item S-@key{right} @ @r{/} @ S-@key{left}
4056 @vindex org-treat-S-cursor-todo-selection-as-state-change
4057 Select the following/preceding TODO state, similar to cycling. Useful
4058 mostly if more than two TODO states are possible (@pxref{TODO
4059 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
4060 with @code{shift-selection-mode}. See also the variable
4061 @code{org-treat-S-cursor-todo-selection-as-state-change}.
4062 @orgcmd{C-c / t,org-show-todo-tree}
4063 @cindex sparse tree, for TODO
4064 @vindex org-todo-keywords
4065 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
4066 entire buffer, but shows all TODO items (with not-DONE state) and the
4067 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
4068 / T}), search for a specific TODO@. You will be prompted for the keyword,
4069 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4070 entries that match any one of these keywords. With a numeric prefix argument
4071 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4072 With two prefix arguments, find all TODO states, both un-done and done.
4073 @orgcmd{C-c a t,org-todo-list}
4074 Show the global TODO list. Collects the TODO items (with not-DONE states)
4075 from all agenda files (@pxref{Agenda views}) into a single buffer. The new
4076 buffer will be in @code{agenda-mode}, which provides commands to examine and
4077 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4078 @xref{Global TODO list}, for more information.
4079 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4080 Insert a new TODO entry below the current one.
4084 @vindex org-todo-state-tags-triggers
4085 Changing a TODO state can also trigger tag changes. See the docstring of the
4086 option @code{org-todo-state-tags-triggers} for details.
4088 @node TODO extensions
4089 @section Extended use of TODO keywords
4090 @cindex extended TODO keywords
4092 @vindex org-todo-keywords
4093 By default, marked TODO entries have one of only two states: TODO and
4094 DONE@. Org mode allows you to classify TODO items in more complex ways
4095 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
4096 special setup, the TODO keyword system can work differently in different
4099 Note that @i{tags} are another way to classify headlines in general and
4100 TODO items in particular (@pxref{Tags}).
4103 * Workflow states:: From TODO to DONE in steps
4104 * TODO types:: I do this, Fred does the rest
4105 * Multiple sets in one file:: Mixing it all, and still finding your way
4106 * Fast access to TODO states:: Single letter selection of a state
4107 * Per-file keywords:: Different files, different requirements
4108 * Faces for TODO keywords:: Highlighting states
4109 * TODO dependencies:: When one task needs to wait for others
4112 @node Workflow states
4113 @subsection TODO keywords as workflow states
4114 @cindex TODO workflow
4115 @cindex workflow states as TODO keywords
4117 You can use TODO keywords to indicate different @emph{sequential} states
4118 in the process of working on an item, for example@footnote{Changing
4119 this variable only becomes effective after restarting Org mode in a
4123 (setq org-todo-keywords
4124 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4127 The vertical bar separates the TODO keywords (states that @emph{need
4128 action}) from the DONE states (which need @emph{no further action}). If
4129 you don't provide the separator bar, the last state is used as the DONE
4131 @cindex completion, of TODO keywords
4132 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4133 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4134 also use a numeric prefix argument to quickly select a specific state. For
4135 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4136 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4137 define many keywords, you can use in-buffer completion
4138 (@pxref{Completion}) or even a special one-key selection scheme
4139 (@pxref{Fast access to TODO states}) to insert these words into the
4140 buffer. Changing a TODO state can be logged with a timestamp, see
4141 @ref{Tracking TODO state changes}, for more information.
4144 @subsection TODO keywords as types
4146 @cindex names as TODO keywords
4147 @cindex types as TODO keywords
4149 The second possibility is to use TODO keywords to indicate different
4150 @emph{types} of action items. For example, you might want to indicate
4151 that items are for ``work'' or ``home''. Or, when you work with several
4152 people on a single project, you might want to assign action items
4153 directly to persons, by using their names as TODO keywords. This would
4154 be set up like this:
4157 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4160 In this case, different keywords do not indicate a sequence, but rather
4161 different types. So the normal work flow would be to assign a task to a
4162 person, and later to mark it DONE@. Org mode supports this style by adapting
4163 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4164 @kbd{t} command in the timeline and agenda buffers.}. When used several
4165 times in succession, it will still cycle through all names, in order to first
4166 select the right type for a task. But when you return to the item after some
4167 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4168 to DONE@. Use prefix arguments or completion to quickly select a specific
4169 name. You can also review the items of a specific TODO type in a sparse tree
4170 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4171 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4172 from all agenda files into a single buffer, you would use the numeric prefix
4173 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4175 @node Multiple sets in one file
4176 @subsection Multiple keyword sets in one file
4177 @cindex TODO keyword sets
4179 Sometimes you may want to use different sets of TODO keywords in
4180 parallel. For example, you may want to have the basic
4181 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4182 separate state indicating that an item has been canceled (so it is not
4183 DONE, but also does not require action). Your setup would then look
4187 (setq org-todo-keywords
4188 '((sequence "TODO" "|" "DONE")
4189 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4190 (sequence "|" "CANCELED")))
4193 The keywords should all be different, this helps Org mode to keep track
4194 of which subsequence should be used for a given entry. In this setup,
4195 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4196 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4197 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4198 select the correct sequence. Besides the obvious ways like typing a
4199 keyword or using completion, you may also apply the following commands:
4202 @kindex C-S-@key{right}
4203 @kindex C-S-@key{left}
4204 @kindex C-u C-u C-c C-t
4205 @item C-u C-u C-c C-t
4206 @itemx C-S-@key{right}
4207 @itemx C-S-@key{left}
4208 These keys jump from one TODO subset to the next. In the above example,
4209 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4210 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4211 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4212 @code{shift-selection-mode} (@pxref{Conflicts}).
4213 @kindex S-@key{right}
4214 @kindex S-@key{left}
4217 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4218 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4219 from @code{DONE} to @code{REPORT} in the example above. See also
4220 @ref{Conflicts}, for a discussion of the interaction with
4221 @code{shift-selection-mode}.
4224 @node Fast access to TODO states
4225 @subsection Fast access to TODO states
4227 If you would like to quickly change an entry to an arbitrary TODO state
4228 instead of cycling through the states, you can set up keys for single-letter
4229 access to the states. This is done by adding the selection character after
4230 each keyword, in parentheses@footnote{All characters are allowed except
4231 @code{@@^!}, which have a special meaning here.}. For example:
4234 (setq org-todo-keywords
4235 '((sequence "TODO(t)" "|" "DONE(d)")
4236 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4237 (sequence "|" "CANCELED(c)")))
4240 @vindex org-fast-tag-selection-include-todo
4241 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4242 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4243 keyword from an entry.@footnote{Check also the option
4244 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4245 state through the tags interface (@pxref{Setting tags}), in case you like to
4246 mingle the two concepts. Note that this means you need to come up with
4247 unique keys across both sets of keywords.}
4249 @node Per-file keywords
4250 @subsection Setting up keywords for individual files
4251 @cindex keyword options
4252 @cindex per-file keywords
4257 It can be very useful to use different aspects of the TODO mechanism in
4258 different files. For file-local settings, you need to add special lines to
4259 the file which set the keywords and interpretation for that file only. For
4260 example, to set one of the two examples discussed above, you need one of the
4261 following lines anywhere in the file:
4264 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4266 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4267 interpretation, but it means the same as @code{#+TODO}), or
4269 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4272 A setup for using several sets in parallel would be:
4276 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4280 @cindex completion, of option keywords
4282 @noindent To make sure you are using the correct keyword, type
4283 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4285 @cindex DONE, final TODO keyword
4286 Remember that the keywords after the vertical bar (or the last keyword
4287 if no bar is there) must always mean that the item is DONE (although you
4288 may use a different word). After changing one of these lines, use
4289 @kbd{C-c C-c} with the cursor still in the line to make the changes
4290 known to Org mode@footnote{Org mode parses these lines only when
4291 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4292 cursor in a line starting with @samp{#+} is simply restarting Org mode
4293 for the current buffer.}.
4295 @node Faces for TODO keywords
4296 @subsection Faces for TODO keywords
4297 @cindex faces, for TODO keywords
4299 @vindex org-todo @r{(face)}
4300 @vindex org-done @r{(face)}
4301 @vindex org-todo-keyword-faces
4302 Org mode highlights TODO keywords with special faces: @code{org-todo}
4303 for keywords indicating that an item still has to be acted upon, and
4304 @code{org-done} for keywords indicating that an item is finished. If
4305 you are using more than 2 different states, you might want to use
4306 special faces for some of them. This can be done using the option
4307 @code{org-todo-keyword-faces}. For example:
4311 (setq org-todo-keyword-faces
4312 '(("TODO" . org-warning) ("STARTED" . "yellow")
4313 ("CANCELED" . (:foreground "blue" :weight bold))))
4317 While using a list with face properties as shown for CANCELED @emph{should}
4318 work, this does not always seem to be the case. If necessary, define a
4319 special face and use that. A string is interpreted as a color. The option
4320 @code{org-faces-easy-properties} determines if that color is interpreted as a
4321 foreground or a background color.
4323 @node TODO dependencies
4324 @subsection TODO dependencies
4325 @cindex TODO dependencies
4326 @cindex dependencies, of TODO states
4327 @cindex TODO dependencies, NOBLOCKING
4329 @vindex org-enforce-todo-dependencies
4330 @cindex property, ORDERED
4331 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4332 dependencies. Usually, a parent TODO task should not be marked DONE until
4333 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4334 there is a logical sequence to a number of (sub)tasks, so that one task
4335 cannot be acted upon before all siblings above it are done. If you customize
4336 the option @code{org-enforce-todo-dependencies}, Org will block entries
4337 from changing state to DONE while they have children that are not DONE@.
4338 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4339 will be blocked until all earlier siblings are marked DONE@. Here is an
4343 * TODO Blocked until (two) is done
4352 ** TODO b, needs to wait for (a)
4353 ** TODO c, needs to wait for (a) and (b)
4356 You can ensure an entry is never blocked by using the @code{NOBLOCKING}
4360 * This entry is never blocked
4367 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4368 @vindex org-track-ordered-property-with-tag
4369 @cindex property, ORDERED
4370 Toggle the @code{ORDERED} property of the current entry. A property is used
4371 for this behavior because this should be local to the current entry, not
4372 inherited like a tag. However, if you would like to @i{track} the value of
4373 this property with a tag for better visibility, customize the option
4374 @code{org-track-ordered-property-with-tag}.
4375 @orgkey{C-u C-u C-u C-c C-t}
4376 Change TODO state, circumventing any state blocking.
4379 @vindex org-agenda-dim-blocked-tasks
4380 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4381 that cannot be closed because of such dependencies will be shown in a dimmed
4382 font or even made invisible in agenda views (@pxref{Agenda views}).
4384 @cindex checkboxes and TODO dependencies
4385 @vindex org-enforce-todo-dependencies
4386 You can also block changes of TODO states by looking at checkboxes
4387 (@pxref{Checkboxes}). If you set the option
4388 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4389 checkboxes will be blocked from switching to DONE.
4391 If you need more complex dependency structures, for example dependencies
4392 between entries in different trees or files, check out the contributed
4393 module @file{org-depend.el}.
4396 @node Progress logging
4397 @section Progress logging
4398 @cindex progress logging
4399 @cindex logging, of progress
4401 Org mode can automatically record a timestamp and possibly a note when
4402 you mark a TODO item as DONE, or even each time you change the state of
4403 a TODO item. This system is highly configurable; settings can be on a
4404 per-keyword basis and can be localized to a file or even a subtree. For
4405 information on how to clock working time for a task, see @ref{Clocking
4409 * Closing items:: When was this entry marked DONE?
4410 * Tracking TODO state changes:: When did the status change?
4411 * Tracking your habits:: How consistent have you been?
4415 @subsection Closing items
4417 The most basic logging is to keep track of @emph{when} a certain TODO
4418 item was finished. This is achieved with@footnote{The corresponding
4419 in-buffer setting is: @code{#+STARTUP: logdone}}
4422 (setq org-log-done 'time)
4425 @vindex org-closed-keep-when-no-todo
4427 Then each time you turn an entry from a TODO (not-done) state into any of the
4428 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4429 the headline. If you turn the entry back into a TODO item through further
4430 state cycling, that line will be removed again. If you turn the entry back
4431 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4432 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4433 non-@code{nil}. If you want to record a note along with the timestamp,
4434 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4438 (setq org-log-done 'note)
4442 You will then be prompted for a note, and that note will be stored below
4443 the entry with a @samp{Closing Note} heading.
4445 In the timeline (@pxref{Timeline}) and in the agenda
4446 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4447 display the TODO items with a @samp{CLOSED} timestamp on each day,
4448 giving you an overview of what has been done.
4450 @node Tracking TODO state changes
4451 @subsection Tracking TODO state changes
4452 @cindex drawer, for state change recording
4454 @vindex org-log-states-order-reversed
4455 @vindex org-log-into-drawer
4456 @cindex property, LOG_INTO_DRAWER
4457 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4458 might want to keep track of when a state change occurred and maybe take a
4459 note about this change. You can either record just a timestamp, or a
4460 time-stamped note for a change. These records will be inserted after the
4461 headline as an itemized list, newest first@footnote{See the option
4462 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4463 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4464 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4465 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4466 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4467 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4468 overrule the setting of this variable for a subtree by setting a
4469 @code{LOG_INTO_DRAWER} property.
4471 Since it is normally too much to record a note for every state, Org mode
4472 expects configuration on a per-keyword basis for this. This is achieved by
4473 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4474 with timestamp) in parentheses after each keyword. For example, with the
4478 (setq org-todo-keywords
4479 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4482 To record a timestamp without a note for TODO keywords configured with
4483 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4486 @vindex org-log-done
4487 You not only define global TODO keywords and fast access keys, but also
4488 request that a time is recorded when the entry is set to
4489 DONE@footnote{It is possible that Org mode will record two timestamps
4490 when you are using both @code{org-log-done} and state change logging.
4491 However, it will never prompt for two notes---if you have configured
4492 both, the state change recording note will take precedence and cancel
4493 the @samp{Closing Note}.}, and that a note is recorded when switching to
4494 WAIT or CANCELED@. The setting for WAIT is even more special: the
4495 @samp{!} after the slash means that in addition to the note taken when
4496 entering the state, a timestamp should be recorded when @i{leaving} the
4497 WAIT state, if and only if the @i{target} state does not configure
4498 logging for entering it. So it has no effect when switching from WAIT
4499 to DONE, because DONE is configured to record a timestamp only. But
4500 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4501 setting now triggers a timestamp even though TODO has no logging
4504 You can use the exact same syntax for setting logging preferences local
4507 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4510 @cindex property, LOGGING
4511 In order to define logging settings that are local to a subtree or a
4512 single item, define a LOGGING property in this entry. Any non-empty
4513 LOGGING property resets all logging settings to @code{nil}. You may then turn
4514 on logging for this specific tree using STARTUP keywords like
4515 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4516 settings like @code{TODO(!)}. For example
4519 * TODO Log each state with only a time
4521 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4523 * TODO Only log when switching to WAIT, and when repeating
4525 :LOGGING: WAIT(@@) logrepeat
4527 * TODO No logging at all
4533 @node Tracking your habits
4534 @subsection Tracking your habits
4537 Org has the ability to track the consistency of a special category of TODOs,
4538 called ``habits''. A habit has the following properties:
4542 You have enabled the @code{habits} module by customizing @code{org-modules}.
4544 The habit is a TODO item, with a TODO keyword representing an open state.
4546 The property @code{STYLE} is set to the value @code{habit}.
4548 The TODO has a scheduled date, usually with a @code{.+} style repeat
4549 interval. A @code{++} style may be appropriate for habits with time
4550 constraints, e.g., must be done on weekends, or a @code{+} style for an
4551 unusual habit that can have a backlog, e.g., weekly reports.
4553 The TODO may also have minimum and maximum ranges specified by using the
4554 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4555 three days, but at most every two days.
4557 You must also have state logging for the @code{DONE} state enabled
4558 (@pxref{Tracking TODO state changes}), in order for historical data to be
4559 represented in the consistency graph. If it is not enabled it is not an
4560 error, but the consistency graphs will be largely meaningless.
4563 To give you an idea of what the above rules look like in action, here's an
4564 actual habit with some history:
4568 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4571 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4573 - State "DONE" from "TODO" [2009-10-15 Thu]
4574 - State "DONE" from "TODO" [2009-10-12 Mon]
4575 - State "DONE" from "TODO" [2009-10-10 Sat]
4576 - State "DONE" from "TODO" [2009-10-04 Sun]
4577 - State "DONE" from "TODO" [2009-10-02 Fri]
4578 - State "DONE" from "TODO" [2009-09-29 Tue]
4579 - State "DONE" from "TODO" [2009-09-25 Fri]
4580 - State "DONE" from "TODO" [2009-09-19 Sat]
4581 - State "DONE" from "TODO" [2009-09-16 Wed]
4582 - State "DONE" from "TODO" [2009-09-12 Sat]
4585 What this habit says is: I want to shave at most every 2 days (given by the
4586 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4587 today is the 15th, then the habit first appears in the agenda on Oct 17,
4588 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4589 after four days have elapsed.
4591 What's really useful about habits is that they are displayed along with a
4592 consistency graph, to show how consistent you've been at getting that task
4593 done in the past. This graph shows every day that the task was done over the
4594 past three weeks, with colors for each day. The colors used are:
4598 If the task wasn't to be done yet on that day.
4600 If the task could have been done on that day.
4602 If the task was going to be overdue the next day.
4604 If the task was overdue on that day.
4607 In addition to coloring each day, the day is also marked with an asterisk if
4608 the task was actually done that day, and an exclamation mark to show where
4609 the current day falls in the graph.
4611 There are several configuration variables that can be used to change the way
4612 habits are displayed in the agenda.
4615 @item org-habit-graph-column
4616 The buffer column at which the consistency graph should be drawn. This will
4617 overwrite any text in that column, so it is a good idea to keep your habits'
4618 titles brief and to the point.
4619 @item org-habit-preceding-days
4620 The amount of history, in days before today, to appear in consistency graphs.
4621 @item org-habit-following-days
4622 The number of days after today that will appear in consistency graphs.
4623 @item org-habit-show-habits-only-for-today
4624 If non-@code{nil}, only show habits in today's agenda view. This is set to true by
4628 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4629 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4630 bring them back. They are also subject to tag filtering, if you have habits
4631 which should only be done in certain contexts, for example.
4637 If you use Org mode extensively, you may end up with enough TODO items that
4638 it starts to make sense to prioritize them. Prioritizing can be done by
4639 placing a @emph{priority cookie} into the headline of a TODO item, like this
4642 *** TODO [#A] Write letter to Sam Fortune
4646 @vindex org-priority-faces
4647 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4648 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4649 treated just like priority @samp{B}. Priorities make a difference only for
4650 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4651 have no inherent meaning to Org mode. The cookies can be highlighted with
4652 special faces by customizing @code{org-priority-faces}.
4654 Priorities can be attached to any outline node; they do not need to be TODO
4660 @findex org-priority
4661 Set the priority of the current headline (@command{org-priority}). The
4662 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4663 When you press @key{SPC} instead, the priority cookie is removed from the
4664 headline. The priorities can also be changed ``remotely'' from the timeline
4665 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4667 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4668 @vindex org-priority-start-cycle-with-default
4669 Increase/decrease priority of current headline@footnote{See also the option
4670 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4671 also used to modify timestamps (@pxref{Creating timestamps}). See also
4672 @ref{Conflicts}, for a discussion of the interaction with
4673 @code{shift-selection-mode}.
4676 @vindex org-highest-priority
4677 @vindex org-lowest-priority
4678 @vindex org-default-priority
4679 You can change the range of allowed priorities by setting the options
4680 @code{org-highest-priority}, @code{org-lowest-priority}, and
4681 @code{org-default-priority}. For an individual buffer, you may set
4682 these values (highest, lowest, default) like this (please make sure that
4683 the highest priority is earlier in the alphabet than the lowest
4686 @cindex #+PRIORITIES
4691 @node Breaking down tasks
4692 @section Breaking tasks down into subtasks
4693 @cindex tasks, breaking down
4694 @cindex statistics, for TODO items
4696 @vindex org-agenda-todo-list-sublevels
4697 It is often advisable to break down large tasks into smaller, manageable
4698 subtasks. You can do this by creating an outline tree below a TODO item,
4699 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4700 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4701 the overview over the fraction of subtasks that are already completed, insert
4702 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4703 be updated each time the TODO status of a child changes, or when pressing
4704 @kbd{C-c C-c} on the cookie. For example:
4707 * Organize Party [33%]
4708 ** TODO Call people [1/2]
4712 ** DONE Talk to neighbor
4715 @cindex property, COOKIE_DATA
4716 If a heading has both checkboxes and TODO children below it, the meaning of
4717 the statistics cookie become ambiguous. Set the property
4718 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4721 @vindex org-hierarchical-todo-statistics
4722 If you would like to have the statistics cookie count any TODO entries in the
4723 subtree (not just direct children), configure
4724 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4725 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4729 * Parent capturing statistics [2/20]
4731 :COOKIE_DATA: todo recursive
4735 If you would like a TODO entry to automatically change to DONE
4736 when all children are done, you can use the following setup:
4739 (defun org-summary-todo (n-done n-not-done)
4740 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4741 (let (org-log-done org-log-states) ; turn off logging
4742 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4744 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4748 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4749 large number of subtasks (@pxref{Checkboxes}).
4756 @vindex org-list-automatic-rules
4757 Every item in a plain list@footnote{With the exception of description
4758 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4759 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4760 it with the string @samp{[ ]}. This feature is similar to TODO items
4761 (@pxref{TODO items}), but is more lightweight. Checkboxes are not included
4762 in the global TODO list, so they are often great to split a task into a
4763 number of simple steps. Or you can use them in a shopping list. To toggle a
4764 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4765 @file{org-mouse.el}).
4767 Here is an example of a checkbox list.
4770 * TODO Organize party [2/4]
4771 - [-] call people [1/3]
4776 - [ ] think about what music to play
4777 - [X] talk to the neighbors
4780 Checkboxes work hierarchically, so if a checkbox item has children that
4781 are checkboxes, toggling one of the children checkboxes will make the
4782 parent checkbox reflect if none, some, or all of the children are
4785 @cindex statistics, for checkboxes
4786 @cindex checkbox statistics
4787 @cindex property, COOKIE_DATA
4788 @vindex org-checkbox-hierarchical-statistics
4789 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4790 indicating how many checkboxes present in this entry have been checked off,
4791 and the total number of checkboxes present. This can give you an idea on how
4792 many checkboxes remain, even without opening a folded entry. The cookies can
4793 be placed into a headline or into (the first line of) a plain list item.
4794 Each cookie covers checkboxes of direct children structurally below the
4795 headline/item on which the cookie appears@footnote{Set the option
4796 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4797 count all checkboxes below the cookie, not just those belonging to direct
4798 children.}. You have to insert the cookie yourself by typing either
4799 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4800 result, as in the examples above. With @samp{[%]} you get information about
4801 the percentage of checkboxes checked (in the above example, this would be
4802 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4803 count either checkboxes below the heading or TODO states of children, and it
4804 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4805 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4807 @cindex blocking, of checkboxes
4808 @cindex checkbox blocking
4809 @cindex property, ORDERED
4810 If the current outline node has an @code{ORDERED} property, checkboxes must
4811 be checked off in sequence, and an error will be thrown if you try to check
4812 off a box while there are unchecked boxes above it.
4814 @noindent The following commands work with checkboxes:
4817 @orgcmd{C-c C-c,org-toggle-checkbox}
4818 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4819 With a single prefix argument, add an empty checkbox or remove the current
4820 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4821 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4822 considered to be an intermediate state.
4823 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4824 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4825 double prefix argument, set it to @samp{[-]}, which is considered to be an
4829 If there is an active region, toggle the first checkbox in the region
4830 and set all remaining boxes to the same status as the first. With a prefix
4831 arg, add or remove the checkbox for all items in the region.
4833 If the cursor is in a headline, toggle checkboxes in the region between
4834 this headline and the next (so @emph{not} the entire subtree).
4836 If there is no active region, just toggle the checkbox at point.
4838 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4839 Insert a new item with a checkbox. This works only if the cursor is already
4840 in a plain list item (@pxref{Plain lists}).
4841 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4842 @vindex org-track-ordered-property-with-tag
4843 @cindex property, ORDERED
4844 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4845 be checked off in sequence. A property is used for this behavior because
4846 this should be local to the current entry, not inherited like a tag.
4847 However, if you would like to @i{track} the value of this property with a tag
4848 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4849 @orgcmd{C-c #,org-update-statistics-cookies}
4850 Update the statistics cookie in the current outline entry. When called with
4851 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4852 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4853 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4854 changing TODO states. If you delete boxes/entries or add/change them by
4855 hand, use this command to get things back into sync.
4861 @cindex headline tagging
4862 @cindex matching, tags
4863 @cindex sparse tree, tag based
4865 An excellent way to implement labels and contexts for cross-correlating
4866 information is to assign @i{tags} to headlines. Org mode has extensive
4869 @vindex org-tag-faces
4870 Every headline can contain a list of tags; they occur at the end of the
4871 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4872 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4873 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4874 Tags will by default be in bold face with the same color as the headline.
4875 You may specify special faces for specific tags using the option
4876 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4877 (@pxref{Faces for TODO keywords}).
4880 * Tag inheritance:: Tags use the tree structure of the outline
4881 * Setting tags:: How to assign tags to a headline
4882 * Tag hierarchy:: Create a hierarchy of tags
4883 * Tag searches:: Searching for combinations of tags
4886 @node Tag inheritance
4887 @section Tag inheritance
4888 @cindex tag inheritance
4889 @cindex inheritance, of tags
4890 @cindex sublevels, inclusion into tags match
4892 @i{Tags} make use of the hierarchical structure of outline trees. If a
4893 heading has a certain tag, all subheadings will inherit the tag as
4894 well. For example, in the list
4897 * Meeting with the French group :work:
4898 ** Summary by Frank :boss:notes:
4899 *** TODO Prepare slides for him :action:
4903 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4904 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4905 explicitly marked with those tags. You can also set tags that all entries in
4906 a file should inherit just as if these tags were defined in a hypothetical
4907 level zero that surrounds the entire file. Use a line like this@footnote{As
4908 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4909 changes in the line.}:
4913 #+FILETAGS: :Peter:Boss:Secret:
4917 @vindex org-use-tag-inheritance
4918 @vindex org-tags-exclude-from-inheritance
4919 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4920 To turn it off entirely, use @code{org-use-tag-inheritance}.
4922 @vindex org-tags-match-list-sublevels
4923 When a headline matches during a tags search while tag inheritance is turned
4924 on, all the sublevels in the same tree will (for a simple match form) match
4925 as well@footnote{This is only true if the search does not involve more
4926 complex tests including properties (@pxref{Property searches}).}. The list
4927 of matches may then become very long. If you only want to see the first tags
4928 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4931 @vindex org-agenda-use-tag-inheritance
4932 Tag inheritance is relevant when the agenda search tries to match a tag,
4933 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4934 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4935 have your tags correctly set in the agenda, so that tag filtering works fine,
4936 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4937 this: the default value includes all agenda types, but setting this to @code{nil}
4938 can really speed up agenda generation.
4941 @section Setting tags
4942 @cindex setting tags
4943 @cindex tags, setting
4946 Tags can simply be typed into the buffer at the end of a headline.
4947 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4948 also a special command for inserting tags:
4951 @orgcmd{C-c C-q,org-set-tags-command}
4952 @cindex completion, of tags
4953 @vindex org-tags-column
4954 Enter new tags for the current headline. Org mode will either offer
4955 completion or a special single-key interface for setting tags, see
4956 below. After pressing @key{RET}, the tags will be inserted and aligned
4957 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4958 tags in the current buffer will be aligned to that column, just to make
4959 things look nice. TAGS are automatically realigned after promotion,
4960 demotion, and TODO state changes (@pxref{TODO basics}).
4962 @orgcmd{C-c C-c,org-set-tags-command}
4963 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4966 @vindex org-tag-alist
4967 Org supports tag insertion based on a @emph{list of tags}. By
4968 default this list is constructed dynamically, containing all tags
4969 currently used in the buffer. You may also globally specify a hard list
4970 of tags with the variable @code{org-tag-alist}. Finally you can set
4971 the default tags for a given file with lines like
4975 #+TAGS: @@work @@home @@tennisclub
4976 #+TAGS: laptop car pc sailboat
4979 If you have globally defined your preferred set of tags using the
4980 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4981 in a specific file, add an empty TAGS option line to that file:
4987 @vindex org-tag-persistent-alist
4988 If you have a preferred set of tags that you would like to use in every file,
4989 in addition to those defined on a per-file basis by TAGS option lines, then
4990 you may specify a list of tags with the variable
4991 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4992 by adding a STARTUP option line to that file:
4998 By default Org mode uses the standard minibuffer completion facilities for
4999 entering tags. However, it also implements another, quicker, tag selection
5000 method called @emph{fast tag selection}. This allows you to select and
5001 deselect tags with just a single key press. For this to work well you should
5002 assign unique letters to most of your commonly used tags. You can do this
5003 globally by configuring the variable @code{org-tag-alist} in your
5004 @file{.emacs} file. For example, you may find the need to tag many items in
5005 different files with @samp{:@@home:}. In this case you can set something
5009 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
5012 @noindent If the tag is only relevant to the file you are working on, then you
5013 can instead set the TAGS option line as:
5016 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
5019 @noindent The tags interface will show the available tags in a splash
5020 window. If you want to start a new line after a specific tag, insert
5021 @samp{\n} into the tag list
5024 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
5027 @noindent or write them in two lines:
5030 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
5031 #+TAGS: laptop(l) pc(p)
5035 You can also group together tags that are mutually exclusive by using
5039 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
5042 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
5043 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
5045 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
5046 these lines to activate any changes.
5049 To set these mutually exclusive groups in the variable @code{org-tag-alist},
5050 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
5051 of the braces. Similarly, you can use @code{:newline} to indicate a line
5052 break. The previous example would be set globally by the following
5056 (setq org-tag-alist '((:startgroup . nil)
5057 ("@@work" . ?w) ("@@home" . ?h)
5058 ("@@tennisclub" . ?t)
5060 ("laptop" . ?l) ("pc" . ?p)))
5063 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
5064 automatically present you with a special interface, listing inherited tags,
5065 the tags of the current headline, and a list of all valid tags with
5066 corresponding keys@footnote{Keys will automatically be assigned to tags which
5067 have no configured keys.}. In this interface, you can use the following
5072 Pressing keys assigned to tags will add or remove them from the list of
5073 tags in the current line. Selecting a tag in a group of mutually
5074 exclusive tags will turn off any other tags from that group.
5077 Enter a tag in the minibuffer, even if the tag is not in the predefined
5078 list. You will be able to complete on all tags present in the buffer.
5079 You can also add several tags: just separate them with a comma.
5083 Clear all tags for this line.
5086 Accept the modified set.
5088 Abort without installing changes.
5090 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5092 Turn off groups of mutually exclusive tags. Use this to (as an
5093 exception) assign several tags from such a group.
5095 Toggle auto-exit after the next change (see below).
5096 If you are using expert mode, the first @kbd{C-c} will display the
5101 This method lets you assign tags to a headline with very few keys. With
5102 the above setup, you could clear the current tags and set @samp{@@home},
5103 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5104 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
5105 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5106 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
5107 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5108 @key{RET} @key{RET}}.
5110 @vindex org-fast-tag-selection-single-key
5111 If you find that most of the time you need only a single key press to
5112 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5113 Then you no longer have to press @key{RET} to exit fast tag selection---it
5114 will immediately exit after the first change. If you then occasionally
5115 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5116 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5117 instead of @kbd{C-c C-c}). If you set the variable to the value
5118 @code{expert}, the special window is not even shown for single-key tag
5119 selection, it comes up only when you press an extra @kbd{C-c}.
5122 @section Tag hierarchy
5125 @cindex tags, groups
5126 @cindex tag hierarchy
5127 Tags can be defined in hierarchies. A tag can be defined as a @emph{group
5128 tag} for a set of other tags. The group tag can be seen as the ``broader
5129 term'' for its set of tags. Defining multiple @emph{group tags} and nesting
5130 them creates a tag hierarchy.
5132 One use-case is to create a taxonomy of terms (tags) that can be used to
5133 classify nodes in a document or set of documents.
5135 When you search for a group tag, it will return matches for all members in
5136 the group and its subgroup. In an agenda view, filtering by a group tag will
5137 display or hide headlines tagged with at least one of the members of the
5138 group or any of its subgroups. This makes tag searches and filters even more
5141 You can set group tags by using brackets and inserting a colon between the
5142 group tag and its related tags---beware that all whitespaces are mandatory so
5143 that Org can parse this line correctly:
5146 #+TAGS: [ GTD : Control Persp ]
5149 In this example, @samp{GTD} is the @emph{group tag} and it is related to two
5150 other tags: @samp{Control}, @samp{Persp}. Defining @samp{Control} and
5151 @samp{Persp} as group tags creates an hierarchy of tags:
5154 #+TAGS: [ Control : Context Task ]
5155 #+TAGS: [ Persp : Vision Goal AOF Project ]
5158 That can conceptually be seen as a hierarchy of tags:
5172 You can use the @code{:startgrouptag}, @code{:grouptags} and
5173 @code{:endgrouptag} keyword directly when setting @code{org-tag-alist}
5177 (setq org-tag-alist '((:startgrouptag)
5191 The tags in a group can be mutually exclusive if using the same group syntax
5192 as is used for grouping mutually exclusive tags together; using curly
5196 #+TAGS: @{ Context : @@Home @@Work @@Call @}
5199 When setting @code{org-tag-alist} you can use @code{:startgroup} &
5200 @code{:endgroup} instead of @code{:startgrouptag} & @code{:endgrouptag} to
5201 make the tags mutually exclusive.
5203 Furthermore, the members of a @emph{group tag} can also be regular
5204 expressions, creating the possibility of a more dynamic and rule-based
5205 tag structure. The regular expressions in the group must be specified
5206 within @{ @}. Here is an expanded example:
5209 #+TAGS: [ Vision : @{V@@@.+@} ]
5210 #+TAGS: [ Goal : @{G@@@.+@} ]
5211 #+TAGS: [ AOF : @{AOF@@@.+@} ]
5212 #+TAGS: [ Project : @{P@@@.+@} ]
5215 Searching for the tag @samp{Project} will now list all tags also including
5216 regular expression matches for @samp{P@@@.+}, and similarly for tag searches on
5217 @samp{Vision}, @samp{Goal} and @samp{AOF}. For example, this would work well
5218 for a project tagged with a common project-identifier, e.g. @samp{P@@2014_OrgTags}.
5221 @vindex org-group-tags
5222 If you want to ignore group tags temporarily, toggle group tags support
5223 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5224 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5227 @section Tag searches
5228 @cindex tag searches
5229 @cindex searching for tags
5231 Once a system of tags has been set up, it can be used to collect related
5232 information into special lists.
5235 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5236 Create a sparse tree with all headlines matching a tags/property/TODO search.
5237 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5238 @xref{Matching tags and properties}.
5239 @orgcmd{C-c a m,org-tags-view}
5240 Create a global list of tag matches from all agenda files. @xref{Matching
5241 tags and properties}.
5242 @orgcmd{C-c a M,org-tags-view}
5243 @vindex org-tags-match-list-sublevels
5244 Create a global list of tag matches from all agenda files, but check
5245 only TODO items and force checking subitems (see the option
5246 @code{org-tags-match-list-sublevels}).
5249 These commands all prompt for a match string which allows basic Boolean logic
5250 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5251 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5252 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5253 string is rich and allows also matching against TODO keywords, entry levels
5254 and properties. For a complete description with many examples, see
5255 @ref{Matching tags and properties}.
5258 @node Properties and columns
5259 @chapter Properties and columns
5262 A property is a key-value pair associated with an entry. Properties can be
5263 set so they are associated with a single entry, with every entry in a tree,
5264 or with every entry in an Org mode file.
5266 There are two main applications for properties in Org mode. First,
5267 properties are like tags, but with a value. Imagine maintaining a file where
5268 you document bugs and plan releases for a piece of software. Instead of
5269 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5270 property, say @code{:Release:}, that in different subtrees has different
5271 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5272 implement (very basic) database capabilities in an Org buffer. Imagine
5273 keeping track of your music CDs, where properties could be things such as the
5274 album, artist, date of release, number of tracks, and so on.
5276 Properties can be conveniently edited and viewed in column view
5277 (@pxref{Column view}).
5280 * Property syntax:: How properties are spelled out
5281 * Special properties:: Access to other Org mode features
5282 * Property searches:: Matching property values
5283 * Property inheritance:: Passing values down the tree
5284 * Column view:: Tabular viewing and editing
5285 * Property API:: Properties for Lisp programmers
5288 @node Property syntax
5289 @section Property syntax
5290 @cindex property syntax
5291 @cindex drawer, for properties
5293 Properties are key-value pairs. When they are associated with a single entry
5294 or with a tree they need to be inserted into a special drawer
5295 (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
5296 right below a headline, and its planning line (@pxref{Deadlines and
5297 scheduling}) when applicable. Each property is specified on a single line,
5298 with the key (surrounded by colons) first, and the value after it. Keys are
5299 case-insensitives. Here is an example:
5304 *** Goldberg Variations
5306 :Title: Goldberg Variations
5307 :Composer: J.S. Bach
5309 :Publisher: Deutsche Grammophon
5314 Depending on the value of @code{org-use-property-inheritance}, a property set
5315 this way will either be associated with a single entry, or the subtree
5316 defined by the entry, see @ref{Property inheritance}.
5318 You may define the allowed values for a particular property @samp{:Xyz:}
5319 by setting a property @samp{:Xyz_ALL:}. This special property is
5320 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5321 the entire tree. When allowed values are defined, setting the
5322 corresponding property becomes easier and is less prone to typing
5323 errors. For the example with the CD collection, we can predefine
5324 publishers and the number of disks in a box like this:
5329 :NDisks_ALL: 1 2 3 4
5330 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5334 If you want to set properties that can be inherited by any entry in a
5335 file, use a line like
5336 @cindex property, _ALL
5339 #+PROPERTY: NDisks_ALL 1 2 3 4
5342 Contrary to properties set from a special drawer, you have to refresh the
5343 buffer with @kbd{C-c C-c} to activate this change.
5345 If you want to add to the value of an existing property, append a @code{+} to
5346 the property name. The following results in the property @code{var} having
5347 the value ``foo=1 bar=2''.
5350 #+PROPERTY: var foo=1
5351 #+PROPERTY: var+ bar=2
5354 It is also possible to add to the values of inherited properties. The
5355 following results in the @code{genres} property having the value ``Classic
5356 Baroque'' under the @code{Goldberg Variations} subtree.
5364 *** Goldberg Variations
5366 :Title: Goldberg Variations
5367 :Composer: J.S. Bach
5369 :Publisher: Deutsche Grammophon
5374 Note that a property can only have one entry per Drawer.
5376 @vindex org-global-properties
5377 Property values set with the global variable
5378 @code{org-global-properties} can be inherited by all entries in all
5382 The following commands help to work with properties:
5385 @orgcmd{M-@key{TAB},pcomplete}
5386 After an initial colon in a line, complete property keys. All keys used
5387 in the current file will be offered as possible completions.
5388 @orgcmd{C-c C-x p,org-set-property}
5389 Set a property. This prompts for a property name and a value. If
5390 necessary, the property drawer is created as well.
5391 @item C-u M-x org-insert-drawer RET
5392 @cindex org-insert-drawer
5393 Insert a property drawer into the current entry. The drawer will be
5394 inserted early in the entry, but after the lines with planning
5395 information like deadlines.
5396 @orgcmd{C-c C-c,org-property-action}
5397 With the cursor in a property drawer, this executes property commands.
5398 @orgcmd{C-c C-c s,org-set-property}
5399 Set a property in the current entry. Both the property and the value
5400 can be inserted using completion.
5401 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5402 Switch property at point to the next/previous allowed value.
5403 @orgcmd{C-c C-c d,org-delete-property}
5404 Remove a property from the current entry.
5405 @orgcmd{C-c C-c D,org-delete-property-globally}
5406 Globally remove a property, from all entries in the current file.
5407 @orgcmd{C-c C-c c,org-compute-property-at-point}
5408 Compute the property at point, using the operator and scope from the
5409 nearest column format definition.
5412 @node Special properties
5413 @section Special properties
5414 @cindex properties, special
5416 Special properties provide an alternative access method to Org mode features,
5417 like the TODO state or the priority of an entry, discussed in the previous
5418 chapters. This interface exists so that you can include these states in
5419 a column view (@pxref{Column view}), or to use them in queries. The
5420 following property names are special and should not be used as keys in the
5423 @cindex property, special, ALLTAGS
5424 @cindex property, special, BLOCKED
5425 @cindex property, special, CLOCKSUM
5426 @cindex property, special, CLOCKSUM_T
5427 @cindex property, special, CLOSED
5428 @cindex property, special, DEADLINE
5429 @cindex property, special, FILE
5430 @cindex property, special, ITEM
5431 @cindex property, special, PRIORITY
5432 @cindex property, special, SCHEDULED
5433 @cindex property, special, TAGS
5434 @cindex property, special, TIMESTAMP
5435 @cindex property, special, TIMESTAMP_IA
5436 @cindex property, special, TODO
5438 ALLTAGS @r{All tags, including inherited ones.}
5439 BLOCKED @r{"t" if task is currently blocked by children or siblings.}
5440 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5441 @r{must be run first to compute the values in the current buffer.}
5442 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5443 @r{@code{org-clock-sum-today} must be run first to compute the}
5444 @r{values in the current buffer.}
5445 CLOSED @r{When was this entry closed?}
5446 DEADLINE @r{The deadline time string, without the angular brackets.}
5447 FILE @r{The filename the entry is located in.}
5448 ITEM @r{The headline of the entry.}
5449 PRIORITY @r{The priority of the entry, a string with a single letter.}
5450 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5451 TAGS @r{The tags defined directly in the headline.}
5452 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5453 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5454 TODO @r{The TODO keyword of the entry.}
5457 @node Property searches
5458 @section Property searches
5459 @cindex properties, searching
5460 @cindex searching, of properties
5462 To create sparse trees and special lists with selection based on properties,
5463 the same commands are used as for tag searches (@pxref{Tag searches}).
5466 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5467 Create a sparse tree with all matching entries. With a
5468 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5469 @orgcmd{C-c a m,org-tags-view}
5470 Create a global list of tag/property matches from all agenda files.
5471 @xref{Matching tags and properties}.
5472 @orgcmd{C-c a M,org-tags-view}
5473 @vindex org-tags-match-list-sublevels
5474 Create a global list of tag matches from all agenda files, but check
5475 only TODO items and force checking of subitems (see the option
5476 @code{org-tags-match-list-sublevels}).
5479 The syntax for the search string is described in @ref{Matching tags and
5482 There is also a special command for creating sparse trees based on a
5487 Create a sparse tree based on the value of a property. This first
5488 prompts for the name of a property, and then for a value. A sparse tree
5489 is created with all entries that define this property with the given
5490 value. If you enclose the value in curly braces, it is interpreted as
5491 a regular expression and matched against the property values.
5494 @node Property inheritance
5495 @section Property Inheritance
5496 @cindex properties, inheritance
5497 @cindex inheritance, of properties
5499 @vindex org-use-property-inheritance
5500 The outline structure of Org mode documents lends itself to an
5501 inheritance model of properties: if the parent in a tree has a certain
5502 property, the children can inherit this property. Org mode does not
5503 turn this on by default, because it can slow down property searches
5504 significantly and is often not needed. However, if you find inheritance
5505 useful, you can turn it on by setting the variable
5506 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5507 all properties inherited from the parent, to a list of properties
5508 that should be inherited, or to a regular expression that matches
5509 inherited properties. If a property has the value @code{nil}, this is
5510 interpreted as an explicit undefine of the property, so that inheritance
5511 search will stop at this value and return @code{nil}.
5513 Org mode has a few properties for which inheritance is hard-coded, at
5514 least for the special applications for which they are used:
5516 @cindex property, COLUMNS
5519 The @code{:COLUMNS:} property defines the format of column view
5520 (@pxref{Column view}). It is inherited in the sense that the level
5521 where a @code{:COLUMNS:} property is defined is used as the starting
5522 point for a column view table, independently of the location in the
5523 subtree from where columns view is turned on.
5525 @cindex property, CATEGORY
5526 For agenda view, a category set through a @code{:CATEGORY:} property
5527 applies to the entire subtree.
5529 @cindex property, ARCHIVE
5530 For archiving, the @code{:ARCHIVE:} property may define the archive
5531 location for the entire subtree (@pxref{Moving subtrees}).
5533 @cindex property, LOGGING
5534 The LOGGING property may define logging settings for an entry or a
5535 subtree (@pxref{Tracking TODO state changes}).
5539 @section Column view
5541 A great way to view and edit properties in an outline tree is
5542 @emph{column view}. In column view, each outline node is turned into a
5543 table row. Columns in this table provide access to properties of the
5544 entries. Org mode implements columns by overlaying a tabular structure
5545 over the headline of each item. While the headlines have been turned
5546 into a table row, you can still change the visibility of the outline
5547 tree. For example, you get a compact table by switching to CONTENTS
5548 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5549 is active), but you can still open, read, and edit the entry below each
5550 headline. Or, you can switch to column view after executing a sparse
5551 tree command and in this way get a table only for the selected items.
5552 Column view also works in agenda buffers (@pxref{Agenda views}) where
5553 queries have collected selected items, possibly from a number of files.
5556 * Defining columns:: The COLUMNS format property
5557 * Using column view:: How to create and use column view
5558 * Capturing column view:: A dynamic block for column view
5561 @node Defining columns
5562 @subsection Defining columns
5563 @cindex column view, for properties
5564 @cindex properties, column view
5566 Setting up a column view first requires defining the columns. This is
5567 done by defining a column format line.
5570 * Scope of column definitions:: Where defined, where valid?
5571 * Column attributes:: Appearance and content of a column
5574 @node Scope of column definitions
5575 @subsubsection Scope of column definitions
5577 To define a column format for an entire file, use a line like
5581 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5584 To specify a format that only applies to a specific tree, add a
5585 @code{:COLUMNS:} property to the top node of that tree, for example:
5588 ** Top node for columns view
5590 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5594 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5595 for the entry itself, and for the entire subtree below it. Since the
5596 column definition is part of the hierarchical structure of the document,
5597 you can define columns on level 1 that are general enough for all
5598 sublevels, and more specific columns further down, when you edit a
5599 deeper part of the tree.
5601 @node Column attributes
5602 @subsubsection Column attributes
5603 A column definition sets the attributes of a column. The general
5604 definition looks like this:
5607 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5611 Except for the percent sign and the property name, all items are
5612 optional. The individual parts have the following meaning:
5615 @var{width} @r{An integer specifying the width of the column in characters.}
5616 @r{If omitted, the width will be determined automatically.}
5617 @var{property} @r{The property that should be edited in this column.}
5618 @r{Special properties representing meta data are allowed here}
5619 @r{as well (@pxref{Special properties})}
5620 @var{title} @r{The header text for the column. If omitted, the property}
5622 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5623 @r{parent nodes are computed from the children@footnote{If
5624 more than one summary type apply to the property, the parent
5625 values are computed according to the first of them.}.}
5626 @r{Supported summary types are:}
5627 @{+@} @r{Sum numbers in this column.}
5628 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5629 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5630 @{min@} @r{Smallest number in column.}
5631 @{max@} @r{Largest number.}
5632 @{mean@} @r{Arithmetic mean of numbers.}
5633 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5634 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5635 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5636 @{:@} @r{Sum times, HH:MM, plain numbers are
5637 hours@footnote{A time can also be a duration, using effort
5638 modifiers defined in @code{org-effort-durations}, e.g.,
5639 @samp{3d 1h}. If any value in the column is as such, the
5640 summary will also be an effort duration.}.}
5641 @{:min@} @r{Smallest time value in column.}
5642 @{:max@} @r{Largest time value.}
5643 @{:mean@} @r{Arithmetic mean of time values.}
5644 @{@@min@} @r{Minimum age@footnote{An age is defined as
5645 a duration since a given time-stamp (@pxref{Timestamps}). It
5646 can also be expressed as days, hours, minutes and seconds,
5647 identified by @samp{d}, @samp{h}, @samp{m} and @samp{s}
5648 suffixes, all mandatory, e.g., @samp{0d 13h 0m 10s}.} (in
5649 days/hours/mins/seconds).}
5650 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5651 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5652 @{est+@} @r{Add @samp{low-high} estimates.}
5655 The @code{est+} summary type requires further explanation. It is used for
5656 combining estimates, expressed as @samp{low-high} ranges or plain numbers.
5657 For example, instead of estimating a particular task will take 5 days, you
5658 might estimate it as 5--6 days if you're fairly confident you know how much
5659 work is required, or 1--10 days if you don't really know what needs to be
5660 done. Both ranges average at 5.5 days, but the first represents a more
5661 predictable delivery.
5663 When combining a set of such estimates, simply adding the lows and highs
5664 produces an unrealistically wide result. Instead, @code{est+} adds the
5665 statistical mean and variance of the sub-tasks, generating a final estimate
5666 from the sum. For example, suppose you had ten tasks, each of which was
5667 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5668 of 5 to 20 days, representing what to expect if everything goes either
5669 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5670 full job more realistically, at 10--15 days.
5672 Numbers are right-aligned when a format specifier with an explicit width like
5673 @code{%5d} or @code{%5.1f} is used.
5675 @vindex org-columns-summary-types
5676 You can also define custom summary types by setting
5677 @code{org-columns-summary-types}, which see.
5679 Here is an example for a complete columns definition, along with allowed
5683 :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.}
5684 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5685 :Owner_ALL: Tammy Mark Karl Lisa Don
5686 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5687 :Approved_ALL: "[ ]" "[X]"
5691 The first column, @samp{%25ITEM}, means the first 25 characters of the
5692 item itself, i.e., of the headline. You probably always should start the
5693 column definition with the @samp{ITEM} specifier. The other specifiers
5694 create columns @samp{Owner} with a list of names as allowed values, for
5695 @samp{Status} with four different possible values, and for a checkbox
5696 field @samp{Approved}. When no width is given after the @samp{%}
5697 character, the column will be exactly as wide as it needs to be in order
5698 to fully display all values. The @samp{Approved} column does have a
5699 modified title (@samp{Approved?}, with a question mark). Summaries will
5700 be created for the @samp{Time_Estimate} column by adding time duration
5701 expressions like HH:MM, and for the @samp{Approved} column, by providing
5702 an @samp{[X]} status if all children have been checked. The
5703 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5704 sums of CLOCK intervals in the subtree, either for all clocks or just for
5707 @node Using column view
5708 @subsection Using column view
5711 @tsubheading{Turning column view on and off}
5712 @orgcmd{C-c C-x C-c,org-columns}
5713 @vindex org-columns-default-format
5714 Turn on column view. If the cursor is before the first headline in the file,
5715 or the function called with the universal prefix argument, column view is
5716 turned on for the entire file, using the @code{#+COLUMNS} definition. If the
5717 cursor is somewhere inside the outline, this command searches the hierarchy,
5718 up from point, for a @code{:COLUMNS:} property that defines a format. When
5719 one is found, the column view table is established for the tree starting at
5720 the entry that contains the @code{:COLUMNS:} property. If no such property
5721 is found, the format is taken from the @code{#+COLUMNS} line or from the
5722 variable @code{org-columns-default-format}, and column view is established
5723 for the current entry and its subtree.
5724 @orgcmd{r,org-columns-redo}
5725 Recreate the column view, to include recent changes made in the buffer.
5726 @orgcmd{g,org-columns-redo}
5728 @orgcmd{q,org-columns-quit}
5730 @tsubheading{Editing values}
5731 @item @key{left} @key{right} @key{up} @key{down}
5732 Move through the column view from field to field.
5733 @kindex S-@key{left}
5734 @kindex S-@key{right}
5735 @item S-@key{left}/@key{right}
5736 Switch to the next/previous allowed value of the field. For this, you
5737 have to have specified allowed values for a property.
5739 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5740 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5741 Same as @kbd{S-@key{left}/@key{right}}
5742 @orgcmd{e,org-columns-edit-value}
5743 Edit the property at point. For the special properties, this will
5744 invoke the same interface that you normally use to change that
5745 property. For example, when editing a TAGS property, the tag completion
5746 or fast selection interface will pop up.
5747 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5748 When there is a checkbox at point, toggle it.
5749 @orgcmd{v,org-columns-show-value}
5750 View the full value of this property. This is useful if the width of
5751 the column is smaller than that of the value.
5752 @orgcmd{a,org-columns-edit-allowed}
5753 Edit the list of allowed values for this property. If the list is found
5754 in the hierarchy, the modified value is stored there. If no list is
5755 found, the new value is stored in the first entry that is part of the
5756 current column view.
5757 @tsubheading{Modifying the table structure}
5758 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5759 Make the column narrower/wider by one character.
5760 @orgcmd{S-M-@key{right},org-columns-new}
5761 Insert a new column, to the left of the current column.
5762 @orgcmd{S-M-@key{left},org-columns-delete}
5763 Delete the current column.
5766 @node Capturing column view
5767 @subsection Capturing column view
5769 Since column view is just an overlay over a buffer, it cannot be
5770 exported or printed directly. If you want to capture a column view, use
5771 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5772 of this block looks like this:
5774 @cindex #+BEGIN, columnview
5777 #+BEGIN: columnview :hlines 1 :id "label"
5782 @noindent This dynamic block has the following parameters:
5786 This is the most important parameter. Column view is a feature that is
5787 often localized to a certain (sub)tree, and the capture block might be
5788 at a different location in the file. To identify the tree whose view to
5789 capture, you can use 4 values:
5790 @cindex property, ID
5792 local @r{use the tree in which the capture block is located}
5793 global @r{make a global view, including all headings in the file}
5794 "file:@var{path-to-file}"
5795 @r{run column view at the top of this file}
5796 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5797 @r{property with the value @i{label}. You can use}
5798 @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5799 @r{the current entry and copy it to the kill-ring.}
5802 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5803 an hline before each headline with level @code{<= @var{N}}.
5805 When set to @code{t}, force column groups to get vertical lines.
5807 When set to a number, don't capture entries below this level.
5808 @item :skip-empty-rows
5809 When set to @code{t}, skip rows where the only non-empty specifier of the
5810 column view is @code{ITEM}.
5812 When non-@code{nil}, indent each @code{ITEM} field according to its level.
5817 The following commands insert or update the dynamic block:
5820 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5821 Insert a dynamic block capturing a column view. You will be prompted
5822 for the scope or ID of the view.
5823 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5824 Update dynamic block at point. The cursor needs to be in the
5825 @code{#+BEGIN} line of the dynamic block.
5826 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5827 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5828 you have several clock table blocks, column-capturing blocks or other dynamic
5832 You can add formulas to the column view table and you may add plotting
5833 instructions in front of the table---these will survive an update of the
5834 block. If there is a @code{#+TBLFM:} after the table, the table will
5835 actually be recalculated automatically after an update.
5837 An alternative way to capture and process property values into a table is
5838 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5839 package@footnote{Contributed packages are not part of Emacs, but are
5840 distributed with the main distribution of Org (visit
5841 @uref{http://orgmode.org}).}. It provides a general API to collect
5842 properties from entries in a certain scope, and arbitrary Lisp expressions to
5843 process these values before inserting them into a table or a dynamic block.
5846 @section The Property API
5847 @cindex properties, API
5848 @cindex API, for properties
5850 There is a full API for accessing and changing properties. This API can
5851 be used by Emacs Lisp programs to work with properties and to implement
5852 features based on them. For more information see @ref{Using the
5855 @node Dates and times
5856 @chapter Dates and times
5862 To assist project planning, TODO items can be labeled with a date and/or
5863 a time. The specially formatted string carrying the date and time
5864 information is called a @emph{timestamp} in Org mode. This may be a
5865 little confusing because timestamp is often used to indicate when
5866 something was created or last changed. However, in Org mode this term
5867 is used in a much wider sense.
5870 * Timestamps:: Assigning a time to a tree entry
5871 * Creating timestamps:: Commands which insert timestamps
5872 * Deadlines and scheduling:: Planning your work
5873 * Clocking work time:: Tracking how long you spend on a task
5874 * Effort estimates:: Planning work effort in advance
5875 * Timers:: Notes with a running timer
5880 @section Timestamps, deadlines, and scheduling
5882 @cindex ranges, time
5887 A timestamp is a specification of a date (possibly with a time or a range of
5888 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5889 simplest form, the day name is optional when you type the date yourself.
5890 However, any dates inserted or modified by Org will add that day name, for
5891 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5892 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5893 date/time format. To use an alternative format, see @ref{Custom time
5894 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5895 tree entry. Its presence causes entries to be shown on specific dates in the
5896 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5899 @item Plain timestamp; Event; Appointment
5902 A simple timestamp just assigns a date/time to an item. This is just
5903 like writing down an appointment or event in a paper agenda. In the
5904 timeline and agenda displays, the headline of an entry associated with a
5905 plain timestamp will be shown exactly on that date.
5908 * Meet Peter at the movies
5909 <2006-11-01 Wed 19:15>
5910 * Discussion on climate change
5911 <2006-11-02 Thu 20:00-22:00>
5914 @item Timestamp with repeater interval
5915 @cindex timestamp, with repeater interval
5916 A timestamp may contain a @emph{repeater interval}, indicating that it
5917 applies not only on the given date, but again and again after a certain
5918 interval of N days (d), weeks (w), months (m), or years (y). The
5919 following will show up in the agenda every Wednesday:
5922 * Pick up Sam at school
5923 <2007-05-16 Wed 12:30 +1w>
5926 @item Diary-style sexp entries
5927 For more complex date specifications, Org mode supports using the special
5928 sexp diary entries implemented in the Emacs calendar/diary
5929 package@footnote{When working with the standard diary sexp functions, you
5930 need to be very careful with the order of the arguments. That order depends
5931 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5932 versions, @code{european-calendar-style}). For example, to specify a date
5933 December 1, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5934 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5935 the settings. This has been the source of much confusion. Org mode users
5936 can resort to special versions of these functions like @code{org-date} or
5937 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5938 functions, but with stable ISO order of arguments (year, month, day) wherever
5939 applicable, independent of the value of @code{calendar-date-style}.}. For
5940 example with optional time
5943 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5944 <%%(diary-float t 4 2)>
5947 @item Time/Date range
5950 Two timestamps connected by @samp{--} denote a range. The headline
5951 will be shown on the first and last day of the range, and on any dates
5952 that are displayed and fall in the range. Here is an example:
5955 ** Meeting in Amsterdam
5956 <2004-08-23 Mon>--<2004-08-26 Thu>
5959 @item Inactive timestamp
5960 @cindex timestamp, inactive
5961 @cindex inactive timestamp
5962 Just like a plain timestamp, but with square brackets instead of
5963 angular ones. These timestamps are inactive in the sense that they do
5964 @emph{not} trigger an entry to show up in the agenda.
5967 * Gillian comes late for the fifth time
5973 @node Creating timestamps
5974 @section Creating timestamps
5975 @cindex creating timestamps
5976 @cindex timestamps, creating
5978 For Org mode to recognize timestamps, they need to be in the specific
5979 format. All commands listed below produce timestamps in the correct
5983 @orgcmd{C-c .,org-time-stamp}
5984 Prompt for a date and insert a corresponding timestamp. When the cursor is
5985 at an existing timestamp in the buffer, the command is used to modify this
5986 timestamp instead of inserting a new one. When this command is used twice in
5987 succession, a time range is inserted.
5989 @orgcmd{C-c !,org-time-stamp-inactive}
5990 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5997 @vindex org-time-stamp-rounding-minutes
5998 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5999 contains date and time. The default time can be rounded to multiples of 5
6000 minutes, see the option @code{org-time-stamp-rounding-minutes}.
6003 Normalize timestamp, insert/fix day name if missing or wrong.
6005 @orgcmd{C-c <,org-date-from-calendar}
6006 Insert a timestamp corresponding to the cursor date in the Calendar.
6008 @orgcmd{C-c >,org-goto-calendar}
6009 Access the Emacs calendar for the current date. If there is a
6010 timestamp in the current line, go to the corresponding date
6013 @orgcmd{C-c C-o,org-open-at-point}
6014 Access the agenda for the date given by the timestamp or -range at
6015 point (@pxref{Weekly/daily agenda}).
6017 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
6018 Change date at cursor by one day. These key bindings conflict with
6019 shift-selection and related modes (@pxref{Conflicts}).
6021 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
6022 Change the item under the cursor in a timestamp. The cursor can be on a
6023 year, month, day, hour or minute. When the timestamp contains a time range
6024 like @samp{15:30-16:30}, modifying the first time will also shift the second,
6025 shifting the time block with constant length. To change the length, modify
6026 the second time. Note that if the cursor is in a headline and not at a
6027 timestamp, these same keys modify the priority of an item.
6028 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
6029 related modes (@pxref{Conflicts}).
6031 @orgcmd{C-c C-y,org-evaluate-time-range}
6032 @cindex evaluate time range
6033 Evaluate a time range by computing the difference between start and end.
6034 With a prefix argument, insert result after the time range (in a table: into
6035 the following column).
6040 * The date/time prompt:: How Org mode helps you entering date and time
6041 * Custom time format:: Making dates look different
6044 @node The date/time prompt
6045 @subsection The date/time prompt
6046 @cindex date, reading in minibuffer
6047 @cindex time, reading in minibuffer
6049 @vindex org-read-date-prefer-future
6050 When Org mode prompts for a date/time, the default is shown in default
6051 date/time format, and the prompt therefore seems to ask for a specific
6052 format. But it will in fact accept date/time information in a variety of
6053 formats. Generally, the information should start at the beginning of the
6054 string. Org mode will find whatever information is in
6055 there and derive anything you have not specified from the @emph{default date
6056 and time}. The default is usually the current date and time, but when
6057 modifying an existing timestamp, or when entering the second stamp of a
6058 range, it is taken from the stamp in the buffer. When filling in
6059 information, Org mode assumes that most of the time you will want to enter a
6060 date in the future: if you omit the month/year and the given day/month is
6061 @i{before} today, it will assume that you mean a future date@footnote{See the
6062 variable @code{org-read-date-prefer-future}. You may set that variable to
6063 the symbol @code{time} to even make a time before now shift the date to
6064 tomorrow.}. If the date has been automatically shifted into the future, the
6065 time prompt will show this with @samp{(=>F).}
6067 For example, let's assume that today is @b{June 13, 2006}. Here is how
6068 various inputs will be interpreted, the items filled in by Org mode are
6072 3-2-5 @result{} 2003-02-05
6073 2/5/3 @result{} 2003-02-05
6074 14 @result{} @b{2006}-@b{06}-14
6075 12 @result{} @b{2006}-@b{07}-12
6076 2/5 @result{} @b{2007}-02-05
6077 Fri @result{} nearest Friday after the default date
6078 sep 15 @result{} @b{2006}-09-15
6079 feb 15 @result{} @b{2007}-02-15
6080 sep 12 9 @result{} 2009-09-12
6081 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
6082 22 sept 0:34 @result{} @b{2006}-09-22 00:34
6083 w4 @result{} ISO week for of the current year @b{2006}
6084 2012 w4 fri @result{} Friday of ISO week 4 in 2012
6085 2012-w04-5 @result{} Same as above
6088 Furthermore you can specify a relative date by giving, as the @emph{first}
6089 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
6090 indicate change in hours, days, weeks, months, or years. With a single plus
6091 or minus, the date is always relative to today. With a double plus or minus,
6092 it is relative to the default date. If instead of a single letter, you use
6093 the abbreviation of day name, the date will be the Nth such day, e.g.:
6098 +4d @result{} four days from today
6099 +4 @result{} same as above
6100 +2w @result{} two weeks from today
6101 ++5 @result{} five days from default date
6102 +2tue @result{} second Tuesday from now
6103 -wed @result{} last Wednesday
6106 @vindex parse-time-months
6107 @vindex parse-time-weekdays
6108 The function understands English month and weekday abbreviations. If
6109 you want to use unabbreviated names and/or other languages, configure
6110 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
6112 @vindex org-read-date-force-compatible-dates
6113 Not all dates can be represented in a given Emacs implementation. By default
6114 Org mode forces dates into the compatibility range 1970--2037 which works on
6115 all Emacs implementations. If you want to use dates outside of this range,
6116 read the docstring of the variable
6117 @code{org-read-date-force-compatible-dates}.
6119 You can specify a time range by giving start and end times or by giving a
6120 start time and a duration (in HH:MM format). Use one or two dash(es) as the
6121 separator in the former case and use '+' as the separator in the latter
6125 11am-1:15pm @result{} 11:00-13:15
6126 11am--1:15pm @result{} same as above
6127 11am+2:15 @result{} same as above
6130 @cindex calendar, for selecting date
6131 @vindex org-popup-calendar-for-date-prompt
6132 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6133 you don't need/want the calendar, configure the variable
6134 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
6135 prompt, either by clicking on a date in the calendar, or by pressing
6136 @key{RET}, the date selected in the calendar will be combined with the
6137 information entered at the prompt. You can control the calendar fully
6138 from the minibuffer:
6145 @kindex S-@key{right}
6146 @kindex S-@key{left}
6147 @kindex S-@key{down}
6149 @kindex M-S-@key{right}
6150 @kindex M-S-@key{left}
6152 @kindex M-S-@key{down}
6153 @kindex M-S-@key{up}
6156 @key{RET} @r{Choose date at cursor in calendar.}
6157 mouse-1 @r{Select date by clicking on it.}
6158 S-@key{right}/@key{left} @r{One day forward/backward.}
6159 S-@key{down}/@key{up} @r{One week forward/backward.}
6160 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6161 > / < @r{Scroll calendar forward/backward by one month.}
6162 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
6163 M-S-@key{down}/@key{up} @r{Scroll calendar forward/backward by one year.}
6166 @vindex org-read-date-display-live
6167 The actions of the date/time prompt may seem complex, but I assure you they
6168 will grow on you, and you will start getting annoyed by pretty much any other
6169 way of entering a date/time out there. To help you understand what is going
6170 on, the current interpretation of your input will be displayed live in the
6171 minibuffer@footnote{If you find this distracting, turn the display off with
6172 @code{org-read-date-display-live}.}.
6174 @node Custom time format
6175 @subsection Custom time format
6176 @cindex custom date/time format
6177 @cindex time format, custom
6178 @cindex date format, custom
6180 @vindex org-display-custom-times
6181 @vindex org-time-stamp-custom-formats
6182 Org mode uses the standard ISO notation for dates and times as it is
6183 defined in ISO 8601. If you cannot get used to this and require another
6184 representation of date and time to keep you happy, you can get it by
6185 customizing the options @code{org-display-custom-times} and
6186 @code{org-time-stamp-custom-formats}.
6189 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6190 Toggle the display of custom formats for dates and times.
6194 Org mode needs the default format for scanning, so the custom date/time
6195 format does not @emph{replace} the default format---instead it is put
6196 @emph{over} the default format using text properties. This has the
6197 following consequences:
6200 You cannot place the cursor onto a timestamp anymore, only before or
6203 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6204 each component of a timestamp. If the cursor is at the beginning of
6205 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6206 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6207 time will be changed by one minute.
6209 If the timestamp contains a range of clock times or a repeater, these
6210 will not be overlaid, but remain in the buffer as they were.
6212 When you delete a timestamp character-by-character, it will only
6213 disappear from the buffer after @emph{all} (invisible) characters
6214 belonging to the ISO timestamp have been removed.
6216 If the custom timestamp format is longer than the default and you are
6217 using dates in tables, table alignment will be messed up. If the custom
6218 format is shorter, things do work as expected.
6222 @node Deadlines and scheduling
6223 @section Deadlines and scheduling
6225 A timestamp may be preceded by special keywords to facilitate planning:
6229 @cindex DEADLINE keyword
6231 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6232 to be finished on that date.
6234 @vindex org-deadline-warning-days
6235 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6236 On the deadline date, the task will be listed in the agenda. In
6237 addition, the agenda for @emph{today} will carry a warning about the
6238 approaching or missed deadline, starting
6239 @code{org-deadline-warning-days} before the due date, and continuing
6240 until the entry is marked DONE@. An example:
6243 *** TODO write article about the Earth for the Guide
6244 DEADLINE: <2004-02-29 Sun>
6245 The editor in charge is [[bbdb:Ford Prefect]]
6248 You can specify a different lead time for warnings for a specific
6249 deadline using the following syntax. Here is an example with a warning
6250 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6251 deactivated if the task gets scheduled and you set
6252 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6255 @cindex SCHEDULED keyword
6257 Meaning: you are planning to start working on that task on the given
6260 @vindex org-agenda-skip-scheduled-if-done
6261 The headline will be listed under the given date@footnote{It will still
6262 be listed on that date after it has been marked DONE@. If you don't like
6263 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6264 addition, a reminder that the scheduled date has passed will be present
6265 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6266 the task will automatically be forwarded until completed.
6269 *** TODO Call Trillian for a date on New Years Eve.
6270 SCHEDULED: <2004-12-25 Sat>
6273 @vindex org-scheduled-delay-days
6274 @vindex org-agenda-skip-scheduled-delay-if-deadline
6275 If you want to @emph{delay} the display of this task in the agenda, use
6276 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6277 25th but will appear two days later. In case the task contains a repeater,
6278 the delay is considered to affect all occurrences; if you want the delay to
6279 only affect the first scheduled occurrence of the task, use @code{--2d}
6280 instead. See @code{org-scheduled-delay-days} and
6281 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6282 control this globally or per agenda.
6285 @b{Important:} Scheduling an item in Org mode should @i{not} be
6286 understood in the same way that we understand @i{scheduling a meeting}.
6287 Setting a date for a meeting is just a simple appointment, you should
6288 mark this entry with a simple plain timestamp, to get this item shown
6289 on the date where it applies. This is a frequent misunderstanding by
6290 Org users. In Org mode, @i{scheduling} means setting a date when you
6291 want to start working on an action item.
6294 You may use timestamps with repeaters in scheduling and deadline
6295 entries. Org mode will issue early and late warnings based on the
6296 assumption that the timestamp represents the @i{nearest instance} of
6297 the repeater. However, the use of diary sexp entries like
6299 @code{<%%(diary-float t 42)>}
6301 in scheduling and deadline timestamps is limited. Org mode does not
6302 know enough about the internals of each sexp function to issue early and
6303 late warnings. However, it will show the item on each day where the
6307 * Inserting deadline/schedule:: Planning items
6308 * Repeated tasks:: Items that show up again and again
6311 @node Inserting deadline/schedule
6312 @subsection Inserting deadlines or schedules
6314 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6315 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6316 any text between this line and the headline.} a deadline or to schedule
6321 @orgcmd{C-c C-d,org-deadline}
6322 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6323 in the line directly following the headline. Any CLOSED timestamp will be
6324 removed. When called with a prefix arg, an existing deadline will be removed
6325 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6326 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6327 and @code{nologredeadline}}, a note will be taken when changing an existing
6330 @orgcmd{C-c C-s,org-schedule}
6331 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6332 happen in the line directly following the headline. Any CLOSED timestamp
6333 will be removed. When called with a prefix argument, remove the scheduling
6334 date from the entry. Depending on the variable
6335 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6336 keywords @code{logreschedule}, @code{lognotereschedule}, and
6337 @code{nologreschedule}}, a note will be taken when changing an existing
6340 @orgcmd{C-c / d,org-check-deadlines}
6341 @cindex sparse tree, for deadlines
6342 @vindex org-deadline-warning-days
6343 Create a sparse tree with all deadlines that are either past-due, or
6344 which will become due within @code{org-deadline-warning-days}.
6345 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6346 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6347 all deadlines due tomorrow.
6349 @orgcmd{C-c / b,org-check-before-date}
6350 Sparse tree for deadlines and scheduled items before a given date.
6352 @orgcmd{C-c / a,org-check-after-date}
6353 Sparse tree for deadlines and scheduled items after a given date.
6356 Note that @code{org-schedule} and @code{org-deadline} supports
6357 setting the date by indicating a relative time: e.g., +1d will set
6358 the date to the next day after today, and --1w will set the date
6359 to the previous week before any current timestamp.
6361 @node Repeated tasks
6362 @subsection Repeated tasks
6363 @cindex tasks, repeated
6364 @cindex repeated tasks
6366 Some tasks need to be repeated again and again. Org mode helps to
6367 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6368 or plain timestamp. In the following example
6370 ** TODO Pay the rent
6371 DEADLINE: <2005-10-01 Sat +1m>
6374 the @code{+1m} is a repeater; the intended interpretation is that the task
6375 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6376 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6377 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6378 and a special warning period in a deadline entry, the repeater should come
6379 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6381 @vindex org-todo-repeat-to-state
6382 Deadlines and scheduled items produce entries in the agenda when they are
6383 over-due, so it is important to be able to mark such an entry as completed
6384 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6385 keyword DONE, it will no longer produce entries in the agenda. The problem
6386 with this is, however, that then also the @emph{next} instance of the
6387 repeated entry will not be active. Org mode deals with this in the following
6388 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6389 shift the base date of the repeating timestamp by the repeater interval, and
6390 immediately set the entry state back to TODO@footnote{In fact, the target
6391 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6392 the variable @code{org-todo-repeat-to-state}. If neither of these is
6393 specified, the target state defaults to the first state of the TODO state
6394 sequence.}. In the example above, setting the state to DONE would actually
6395 switch the date like this:
6398 ** TODO Pay the rent
6399 DEADLINE: <2005-11-01 Tue +1m>
6402 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6403 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6405 @vindex org-log-repeat
6406 A timestamp@footnote{You can change this using the option
6407 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6408 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6409 will also be prompted for a note.} will be added under the deadline, to keep
6410 a record that you actually acted on the previous instance of this deadline.
6412 As a consequence of shifting the base date, this entry will no longer be
6413 visible in the agenda when checking past dates, but all future instances
6416 With the @samp{+1m} cookie, the date shift will always be exactly one
6417 month. So if you have not paid the rent for three months, marking this
6418 entry DONE will still keep it as an overdue deadline. Depending on the
6419 task, this may not be the best way to handle it. For example, if you
6420 forgot to call your father for 3 weeks, it does not make sense to call
6421 him 3 times in a single day to make up for it. Finally, there are tasks
6422 like changing batteries which should always repeat a certain time
6423 @i{after} the last time you did it. For these tasks, Org mode has
6424 special repeaters @samp{++} and @samp{.+}. For example:
6428 DEADLINE: <2008-02-10 Sun ++1w>
6429 Marking this DONE will shift the date by at least one week,
6430 but also by as many weeks as it takes to get this date into
6431 the future. However, it stays on a Sunday, even if you called
6432 and marked it done on Saturday.
6433 ** TODO Check the batteries in the smoke detectors
6434 DEADLINE: <2005-11-01 Tue .+1m>
6435 Marking this DONE will shift the date to one month after
6439 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6440 You may have both scheduling and deadline information for a specific task.
6441 If the repeater is set for the scheduling information only, you probably want
6442 the repeater to be ignored after the deadline. If so, set the variable
6443 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6444 @code{repeated-after-deadline}. However, any scheduling information without
6445 a repeater is no longer relevant once the task is done, and thus, removed
6446 upon repeating the task. If you want both scheduling and deadline
6447 information to repeat after the same interval, set the same repeater for both
6450 An alternative to using a repeater is to create a number of copies of a task
6451 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6452 created for this purpose, it is described in @ref{Structure editing}.
6455 @node Clocking work time
6456 @section Clocking work time
6457 @cindex clocking time
6458 @cindex time clocking
6460 Org mode allows you to clock the time you spend on specific tasks in a
6461 project. When you start working on an item, you can start the clock. When
6462 you stop working on that task, or when you mark the task done, the clock is
6463 stopped and the corresponding time interval is recorded. It also computes
6464 the total time spent on each subtree@footnote{Clocking only works if all
6465 headings are indented with less than 30 stars. This is a hardcoded
6466 limitation of @code{lmax} in @code{org-clock-sum}.} of a project.
6467 And it remembers a history or tasks recently clocked, so that you can jump
6468 quickly between a number of tasks absorbing your time.
6470 To save the clock history across Emacs sessions, use
6472 (setq org-clock-persist 'history)
6473 (org-clock-persistence-insinuate)
6475 When you clock into a new task after resuming Emacs, the incomplete
6476 clock@footnote{To resume the clock under the assumption that you have worked
6477 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6478 will be found (@pxref{Resolving idle time}) and you will be prompted about
6482 * Clocking commands:: Starting and stopping a clock
6483 * The clock table:: Detailed reports
6484 * Resolving idle time:: Resolving time when you've been idle
6487 @node Clocking commands
6488 @subsection Clocking commands
6491 @orgcmd{C-c C-x C-i,org-clock-in}
6492 @vindex org-clock-into-drawer
6493 @vindex org-clock-continuously
6494 @cindex property, LOG_INTO_DRAWER
6495 Start the clock on the current item (clock-in). This inserts the CLOCK
6496 keyword together with a timestamp. If this is not the first clocking of
6497 this item, the multiple CLOCK lines will be wrapped into a
6498 @code{:LOGBOOK:} drawer (see also the variable
6499 @code{org-clock-into-drawer}). You can also overrule
6500 the setting of this variable for a subtree by setting a
6501 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6502 When called with a @kbd{C-u} prefix argument,
6503 select the task from a list of recently clocked tasks. With two @kbd{C-u
6504 C-u} prefixes, clock into the task at point and mark it as the default task;
6505 the default task will then always be available with letter @kbd{d} when
6506 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6507 continuous clocking by starting the clock when the last clock stopped.@*
6508 @cindex property: CLOCK_MODELINE_TOTAL
6509 @cindex property: LAST_REPEAT
6510 @vindex org-clock-modeline-total
6511 While the clock is running, the current clocking time is shown in the mode
6512 line, along with the title of the task. The clock time shown will be all
6513 time ever clocked for this task and its children. If the task has an effort
6514 estimate (@pxref{Effort estimates}), the mode line displays the current
6515 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6516 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6517 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6518 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6519 will be shown. More control over what time is shown can be exercised with
6520 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6521 @code{current} to show only the current clocking instance, @code{today} to
6522 show all time clocked on this task today (see also the variable
6523 @code{org-extend-today-until}), @code{all} to include all time, or
6524 @code{auto} which is the default@footnote{See also the variable
6525 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6526 mode line entry will pop up a menu with clocking options.
6528 @orgcmd{C-c C-x C-o,org-clock-out}
6529 @vindex org-log-note-clock-out
6530 Stop the clock (clock-out). This inserts another timestamp at the same
6531 location where the clock was last started. It also directly computes
6532 the resulting time and inserts it after the time range as @samp{=>
6533 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6534 possibility to record an additional note together with the clock-out
6535 timestamp@footnote{The corresponding in-buffer setting is:
6536 @code{#+STARTUP: lognoteclock-out}}.
6537 @orgcmd{C-c C-x C-x,org-clock-in-last}
6538 @vindex org-clock-continuously
6539 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6540 select the task from the clock history. With two @kbd{C-u} prefixes,
6541 force continuous clocking by starting the clock when the last clock
6543 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6544 Update the effort estimate for the current clock task.
6547 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6548 Recompute the time interval after changing one of the timestamps. This
6549 is only necessary if you edit the timestamps directly. If you change
6550 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6551 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6552 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6553 clock duration keeps the same.
6554 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6555 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6556 the one of the previous (or the next clock) timestamp by the same duration.
6557 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6558 by five minutes, then the clocked-in timestamp of the next clock will be
6559 increased by five minutes.
6560 @orgcmd{C-c C-t,org-todo}
6561 Changing the TODO state of an item to DONE automatically stops the clock
6562 if it is running in this same item.
6563 @orgcmd{C-c C-x C-q,org-clock-cancel}
6564 Cancel the current clock. This is useful if a clock was started by
6565 mistake, or if you ended up working on something else.
6566 @orgcmd{C-c C-x C-j,org-clock-goto}
6567 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6568 prefix arg, select the target task from a list of recently clocked tasks.
6569 @orgcmd{C-c C-x C-d,org-clock-display}
6570 @vindex org-remove-highlights-with-change
6571 Display time summaries for each subtree in the current buffer. This puts
6572 overlays at the end of each headline, showing the total time recorded under
6573 that heading, including the time of any subheadings. You can use visibility
6574 cycling to study the tree, but the overlays disappear when you change the
6575 buffer (see variable @code{org-remove-highlights-with-change}) or press
6579 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6580 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6581 worked on or closed during a day.
6583 @strong{Important:} note that both @code{org-clock-out} and
6584 @code{org-clock-in-last} can have a global key binding and will not
6585 modify the window disposition.
6587 @node The clock table
6588 @subsection The clock table
6589 @cindex clocktable, dynamic block
6590 @cindex report, of clocked time
6592 Org mode can produce quite complex reports based on the time clocking
6593 information. Such a report is called a @emph{clock table}, because it is
6594 formatted as one or several Org tables.
6597 @orgcmd{C-c C-x C-r,org-clock-report}
6598 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6599 report as an Org mode table into the current file. When the cursor is
6600 at an existing clock table, just update it. When called with a prefix
6601 argument, jump to the first clock report in the current document and
6602 update it. The clock table always includes also trees with
6603 @code{:ARCHIVE:} tag.
6604 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6605 Update dynamic block at point. The cursor needs to be in the
6606 @code{#+BEGIN} line of the dynamic block.
6607 @orgkey{C-u C-c C-x C-u}
6608 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6609 you have several clock table blocks in a buffer.
6610 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6611 Shift the current @code{:block} interval and update the table. The cursor
6612 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6613 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6617 Here is an example of the frame for a clock table as it is inserted into the
6618 buffer with the @kbd{C-c C-x C-r} command:
6620 @cindex #+BEGIN, clocktable
6622 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6626 @vindex org-clocktable-defaults
6627 The @samp{BEGIN} line specifies a number of options to define the scope,
6628 structure, and formatting of the report. Defaults for all these options can
6629 be configured in the variable @code{org-clocktable-defaults}.
6631 @noindent First there are options that determine which clock entries are to
6634 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6635 @r{Clocks at deeper levels will be summed into the upper level.}
6636 :scope @r{The scope to consider. This can be any of the following:}
6637 nil @r{the current buffer or narrowed region}
6638 file @r{the full current buffer}
6639 subtree @r{the subtree where the clocktable is located}
6640 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6641 tree @r{the surrounding level 1 tree}
6642 agenda @r{all agenda files}
6643 ("file"..) @r{scan these files}
6644 file-with-archives @r{current file and its archives}
6645 agenda-with-archives @r{all agenda files, including archives}
6646 :block @r{The time block to consider. This block is specified either}
6647 @r{absolutely, or relative to the current time and may be any of}
6649 2007-12-31 @r{New year eve 2007}
6650 2007-12 @r{December 2007}
6651 2007-W50 @r{ISO-week 50 in 2007}
6652 2007-Q2 @r{2nd quarter in 2007}
6653 2007 @r{the year 2007}
6654 today, yesterday, today-@var{N} @r{a relative day}
6655 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6656 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6657 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6659 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6660 :tstart @r{A time string specifying when to start considering times.}
6661 @r{Relative times like @code{"<-2w>"} can also be used. See}
6662 @r{@ref{Matching tags and properties} for relative time syntax.}
6663 :tend @r{A time string specifying when to stop considering times.}
6664 @r{Relative times like @code{"<now>"} can also be used. See}
6665 @r{@ref{Matching tags and properties} for relative time syntax.}
6666 :wstart @r{The starting day of the week. The default is 1 for monday.}
6667 :mstart @r{The starting day of the month. The default 1 is for the first}
6668 @r{day of the month.}
6669 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6670 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6671 :stepskip0 @r{Do not show steps that have zero time.}
6672 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6673 :tags @r{A tags match to select entries that should contribute. See}
6674 @r{@ref{Matching tags and properties} for the match syntax.}
6677 Then there are options which determine the formatting of the table. These
6678 options are interpreted by the function @code{org-clocktable-write-default},
6679 but you can specify your own function using the @code{:formatter} parameter.
6681 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6682 :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".}
6683 :link @r{Link the item headlines in the table to their origins.}
6684 :narrow @r{An integer to limit the width of the headline column in}
6685 @r{the org table. If you write it like @samp{50!}, then the}
6686 @r{headline will also be shortened in export.}
6687 :indent @r{Indent each headline field according to its level.}
6688 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6689 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6690 :level @r{Should a level number column be included?}
6691 :sort @r{A cons cell like containing the column to sort and a sorting type.}
6692 @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6693 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6694 @r{All are overwritten except if there is an explicit @code{:narrow}}
6695 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6696 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6697 :properties @r{List of properties that should be shown in the table. Each}
6698 @r{property will get its own column.}
6699 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6700 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6701 @r{As a special case, @samp{:formula %} adds a column with % time.}
6702 @r{If you do not specify a formula here, any existing formula}
6703 @r{below the clock table will survive updates and be evaluated.}
6704 :formatter @r{A function to format clock data and insert it into the buffer.}
6706 To get a clock summary of the current level 1 tree, for the current
6707 day, you could write
6709 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6713 and to use a specific time range you could write@footnote{Note that all
6714 parameters must be specified in a single line---the line is broken here
6715 only to fit it into the manual.}
6717 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6718 :tend "<2006-08-10 Thu 12:00>"
6721 A range starting a week ago and ending right now could be written as
6723 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6726 A summary of the current subtree with % times would be
6728 #+BEGIN: clocktable :scope subtree :link t :formula %
6731 A horizontally compact representation of everything clocked during last week
6734 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6738 @node Resolving idle time
6739 @subsection Resolving idle time and continuous clocking
6741 @subsubheading Resolving idle time
6742 @cindex resolve idle time
6743 @vindex org-clock-x11idle-program-name
6745 @cindex idle, resolve, dangling
6746 If you clock in on a work item, and then walk away from your
6747 computer---perhaps to take a phone call---you often need to ``resolve'' the
6748 time you were away by either subtracting it from the current clock, or
6749 applying it to another one.
6751 @vindex org-clock-idle-time
6752 By customizing the variable @code{org-clock-idle-time} to some integer, such
6753 as 10 or 15, Emacs can alert you when you get back to your computer after
6754 being idle for that many minutes@footnote{On computers using Mac OS X,
6755 idleness is based on actual user idleness, not just Emacs' idle time. For
6756 X11, you can install a utility program @file{x11idle.c}, available in the
6757 @code{contrib/scripts} directory of the Org git distribution, or install the
6758 @file{xprintidle} package and set it to the variable
6759 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6760 same general treatment of idleness. On other systems, idle time refers to
6761 Emacs idle time only.}, and ask what you want to do with the idle time.
6762 There will be a question waiting for you when you get back, indicating how
6763 much idle time has passed (constantly updated with the current amount), as
6764 well as a set of choices to correct the discrepancy:
6768 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6769 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6770 effectively changing nothing, or enter a number to keep that many minutes.
6772 If you use the shift key and press @kbd{K}, it will keep however many minutes
6773 you request and then immediately clock out of that task. If you keep all of
6774 the minutes, this is the same as just clocking out of the current task.
6776 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6777 the clock, and then check back in from the moment you returned.
6779 To keep none of the minutes and just clock out at the start of the away time,
6780 use the shift key and press @kbd{S}. Remember that using shift will always
6781 leave you clocked out, no matter which option you choose.
6783 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6784 canceling you subtract the away time, and the resulting clock amount is less
6785 than a minute, the clock will still be canceled rather than clutter up the
6786 log with an empty entry.
6789 What if you subtracted those away minutes from the current clock, and now
6790 want to apply them to a new clock? Simply clock in to any task immediately
6791 after the subtraction. Org will notice that you have subtracted time ``on
6792 the books'', so to speak, and will ask if you want to apply those minutes to
6793 the next task you clock in on.
6795 There is one other instance when this clock resolution magic occurs. Say you
6796 were clocked in and hacking away, and suddenly your cat chased a mouse who
6797 scared a hamster that crashed into your UPS's power button! You suddenly
6798 lose all your buffers, but thanks to auto-save you still have your recent Org
6799 mode changes, including your last clock in.
6801 If you restart Emacs and clock into any task, Org will notice that you have a
6802 dangling clock which was never clocked out from your last session. Using
6803 that clock's starting time as the beginning of the unaccounted-for period,
6804 Org will ask how you want to resolve that time. The logic and behavior is
6805 identical to dealing with away time due to idleness; it is just happening due
6806 to a recovery event rather than a set amount of idle time.
6808 You can also check all the files visited by your Org agenda for dangling
6809 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6811 @subsubheading Continuous clocking
6812 @cindex continuous clocking
6813 @vindex org-clock-continuously
6815 You may want to start clocking from the time when you clocked out the
6816 previous task. To enable this systematically, set @code{org-clock-continuously}
6817 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6818 last clocked entry for this session, and start the new clock from there.
6820 If you only want this from time to time, use three universal prefix arguments
6821 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6823 @node Effort estimates
6824 @section Effort estimates
6825 @cindex effort estimates
6827 @cindex property, Effort
6828 If you want to plan your work in a very detailed way, or if you need to
6829 produce offers with quotations of the estimated work effort, you may want to
6830 assign effort estimates to entries. If you are also clocking your work, you
6831 may later want to compare the planned effort with the actual working time,
6832 a great way to improve planning estimates. Effort estimates are stored in
6833 a special property @code{EFFORT}. You can set the effort for an entry with
6834 the following commands:
6837 @orgcmd{C-c C-x e,org-set-effort}
6838 Set the effort estimate for the current entry. With a numeric prefix
6839 argument, set it to the Nth allowed value (see below). This command is also
6840 accessible from the agenda with the @kbd{e} key.
6841 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6842 Modify the effort estimate of the item currently being clocked.
6845 Clearly the best way to work with effort estimates is through column view
6846 (@pxref{Column view}). You should start by setting up discrete values for
6847 effort estimates, and a @code{COLUMNS} format that displays these values
6848 together with clock sums (if you want to clock your time). For a specific
6852 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6853 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6857 @vindex org-global-properties
6858 @vindex org-columns-default-format
6859 or, even better, you can set up these values globally by customizing the
6860 variables @code{org-global-properties} and @code{org-columns-default-format}.
6861 In particular if you want to use this setup also in the agenda, a global
6862 setup may be advised.
6864 The way to assign estimates to individual items is then to switch to column
6865 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6866 value. The values you enter will immediately be summed up in the hierarchy.
6867 In the column next to it, any clocked time will be displayed.
6869 @vindex org-agenda-columns-add-appointments-to-effort-sum
6870 If you switch to column view in the daily/weekly agenda, the effort column
6871 will summarize the estimated work effort for each day@footnote{Please note
6872 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6873 column view}).}, and you can use this to find space in your schedule. To get
6874 an overview of the entire part of the day that is committed, you can set the
6875 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6876 appointments on a day that take place over a specified time interval will
6877 then also be added to the load estimate of the day.
6879 Effort estimates can be used in secondary agenda filtering that is triggered
6880 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6881 these estimates defined consistently, two or three key presses will narrow
6882 down the list to stuff that fits into an available time slot.
6885 @section Taking notes with a timer
6886 @cindex relative timer
6887 @cindex countdown timer
6890 Org provides two types of timers. There is a relative timer that counts up,
6891 which can be useful when taking notes during, for example, a meeting or
6892 a video viewing. There is also a countdown timer.
6894 The relative and countdown are started with separate commands.
6897 @orgcmd{C-c C-x 0,org-timer-start}
6898 Start or reset the relative timer. By default, the timer is set to 0. When
6899 called with a @kbd{C-u} prefix, prompt the user for a starting offset. If
6900 there is a timer string at point, this is taken as the default, providing a
6901 convenient way to restart taking notes after a break in the process. When
6902 called with a double prefix argument @kbd{C-u C-u}, change all timer strings
6903 in the active region by a certain amount. This can be used to fix timer
6904 strings if the timer was not started at exactly the right moment.
6905 @orgcmd{C-c C-x ;,org-timer-set-timer}
6906 Start a countdown timer. The user is prompted for a duration.
6907 @code{org-timer-default-timer} sets the default countdown value. Giving a
6908 prefix numeric argument overrides this default value. This command is
6909 available as @kbd{;} in agenda buffers.
6912 Once started, relative and countdown timers are controlled with the same
6916 @orgcmd{C-c C-x .,org-timer}
6917 Insert the value of the current relative or countdown timer into the buffer.
6918 If no timer is running, the relative timer will be started. When called with
6919 a prefix argument, the relative timer is restarted.
6920 @orgcmd{C-c C-x -,org-timer-item}
6921 Insert a description list item with the value of the current relative or
6922 countdown timer. With a prefix argument, first reset the relative timer to
6924 @orgcmd{M-@key{RET},org-insert-heading}
6925 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6927 @orgcmd{C-c C-x @comma{},org-timer-pause-or-continue}
6928 Pause the timer, or continue it if it is already paused.
6929 @orgcmd{C-c C-x _,org-timer-stop}
6930 Stop the timer. After this, you can only start a new timer, not continue the
6931 old one. This command also removes the timer from the mode line.
6934 @node Capture - Refile - Archive
6935 @chapter Capture - Refile - Archive
6938 An important part of any organization system is the ability to quickly
6939 capture new ideas and tasks, and to associate reference material with them.
6940 Org does this using a process called @i{capture}. It also can store files
6941 related to a task (@i{attachments}) in a special directory. Once in the
6942 system, tasks and projects need to be moved around. Moving completed project
6943 trees to an archive file keeps the system compact and fast.
6946 * Capture:: Capturing new stuff
6947 * Attachments:: Add files to tasks
6948 * RSS feeds:: Getting input from RSS feeds
6949 * Protocols:: External (e.g., Browser) access to Emacs and Org
6950 * Refile and copy:: Moving/copying a tree from one place to another
6951 * Archiving:: What to do with finished projects
6958 Capture lets you quickly store notes with little interruption of your work
6959 flow. Org's method for capturing new items is heavily inspired by John
6960 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6961 used a special setup for @file{remember.el}, then replaced it with
6962 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6963 been completely replaced by @file{org-capture.el}.
6965 If your configuration depends on @file{org-remember.el}, you need to update
6966 it and use the setup described below. To convert your
6967 @code{org-remember-templates}, run the command
6969 @kbd{M-x org-capture-import-remember-templates RET}
6971 @noindent and then customize the new variable with @kbd{M-x
6972 customize-variable org-capture-templates}, check the result, and save the
6976 * Setting up capture:: Where notes will be stored
6977 * Using capture:: Commands to invoke and terminate capture
6978 * Capture templates:: Define the outline of different note types
6981 @node Setting up capture
6982 @subsection Setting up capture
6984 The following customization sets a default target file for notes, and defines
6985 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6986 suggestion.} for capturing new material.
6988 @vindex org-default-notes-file
6991 (setq org-default-notes-file (concat org-directory "/notes.org"))
6992 (define-key global-map "\C-cc" 'org-capture)
6997 @subsection Using capture
7000 @orgcmd{C-c c,org-capture}
7001 Call the command @code{org-capture}. Note that this key binding is global and
7002 not active by default: you need to install it. If you have templates
7004 defined @pxref{Capture templates}, it will offer these templates for
7005 selection or use a new Org outline node as the default template. It will
7006 insert the template into the target file and switch to an indirect buffer
7007 narrowed to this new node. You may then insert the information you want.
7009 @orgcmd{C-c C-c,org-capture-finalize}
7010 Once you have finished entering information into the capture buffer, @kbd{C-c
7011 C-c} will return you to the window configuration before the capture process,
7012 so that you can resume your work without further distraction. When called
7013 with a prefix arg, finalize and then jump to the captured item.
7015 @orgcmd{C-c C-w,org-capture-refile}
7016 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
7017 a different place. Please realize that this is a normal refiling command
7018 that will be executed---so the cursor position at the moment you run this
7019 command is important. If you have inserted a tree with a parent and
7020 children, first move the cursor back to the parent. Any prefix argument
7021 given to this command will be passed on to the @code{org-refile} command.
7023 @orgcmd{C-c C-k,org-capture-kill}
7024 Abort the capture process and return to the previous state.
7028 You can also call @code{org-capture} in a special way from the agenda, using
7029 the @kbd{k c} key combination. With this access, any timestamps inserted by
7030 the selected capture template will default to the cursor date in the agenda,
7031 rather than to the current date.
7033 To find the locations of the last stored capture, use @code{org-capture} with
7038 Visit the target location of a capture template. You get to select the
7039 template in the usual way.
7040 @orgkey{C-u C-u C-c c}
7041 Visit the last stored capture item in its buffer.
7044 @vindex org-capture-bookmark
7045 @cindex org-capture-last-stored
7046 You can also jump to the bookmark @code{org-capture-last-stored}, which will
7047 automatically be created unless you set @code{org-capture-bookmark} to
7050 To insert the capture at point in an Org buffer, call @code{org-capture} with
7051 a @code{C-0} prefix argument.
7053 @node Capture templates
7054 @subsection Capture templates
7055 @cindex templates, for Capture
7057 You can use templates for different types of capture items, and
7058 for different target locations. The easiest way to create such templates is
7059 through the customize interface.
7063 Customize the variable @code{org-capture-templates}.
7066 Before we give the formal description of template definitions, let's look at
7067 an example. Say you would like to use one template to create general TODO
7068 entries, and you want to put these entries under the heading @samp{Tasks} in
7069 your file @file{~/org/gtd.org}. Also, a date tree in the file
7070 @file{journal.org} should capture journal entries. A possible configuration
7075 (setq org-capture-templates
7076 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
7077 "* TODO %?\n %i\n %a")
7078 ("j" "Journal" entry (file+datetree "~/org/journal.org")
7079 "* %?\nEntered on %U\n %i\n %a")))
7083 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
7087 [[file:@var{link to where you initiated capture}]]
7091 During expansion of the template, @code{%a} has been replaced by a link to
7092 the location from where you called the capture command. This can be
7093 extremely useful for deriving tasks from emails, for example. You fill in
7094 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7095 place where you started the capture process.
7097 To define special keys to capture to a particular template without going
7098 through the interactive template selection, you can create your key binding
7102 (define-key global-map "\C-cx"
7103 (lambda () (interactive) (org-capture nil "x")))
7107 * Template elements:: What is needed for a complete template entry
7108 * Template expansion:: Filling in information about time and context
7109 * Templates in contexts:: Only show a template in a specific context
7112 @node Template elements
7113 @subsubsection Template elements
7115 Now lets look at the elements of a template definition. Each entry in
7116 @code{org-capture-templates} is a list with the following items:
7120 The keys that will select the template, as a string, characters
7121 only, for example @code{"a"} for a template to be selected with a
7122 single key, or @code{"bt"} for selection with two keys. When using
7123 several keys, keys using the same prefix key must be sequential
7124 in the list and preceded by a 2-element entry explaining the
7125 prefix key, for example
7127 ("b" "Templates for marking stuff to buy")
7129 @noindent If you do not define a template for the @kbd{C} key, this key will
7130 be used to open the customize buffer for this complex variable.
7133 A short string describing the template, which will be shown during
7137 The type of entry, a symbol. Valid values are:
7141 An Org mode node, with a headline. Will be filed as the child of the target
7142 entry or as a top-level entry. The target file should be an Org mode file.
7144 A plain list item, placed in the first plain list at the target
7145 location. Again the target file should be an Org file.
7147 A checkbox item. This only differs from the plain list item by the
7150 a new line in the first table at the target location. Where exactly the
7151 line will be inserted depends on the properties @code{:prepend} and
7152 @code{:table-line-pos} (see below).
7154 Text to be inserted as it is.
7158 @vindex org-default-notes-file
7159 Specification of where the captured item should be placed. In Org mode
7160 files, targets usually define a node. Entries will become children of this
7161 node. Other types will be added to the table or list in the body of this
7162 node. Most target specifications contain a file name. If that file name is
7163 the empty string, it defaults to @code{org-default-notes-file}. A file can
7164 also be given as a variable, function, or Emacs Lisp form. When an absolute
7165 path is not specified for a target, it is taken as relative to
7166 @code{org-directory}.
7171 @item (file "path/to/file")
7172 Text will be placed at the beginning or end of that file.
7174 @item (id "id of existing org entry")
7175 Filing as child of this entry, or in the body of the entry.
7177 @item (file+headline "path/to/file" "node headline")
7178 Fast configuration if the target heading is unique in the file.
7180 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7181 For non-unique headings, the full path is safer.
7183 @item (file+regexp "path/to/file" "regexp to find location")
7184 Use a regular expression to position the cursor.
7186 @item (file+datetree "path/to/file")
7187 Will create a heading in a date tree for today's date@footnote{Datetree
7188 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7189 and @code{* 2013} in your file, the capture will refile the note to the first
7192 @item (file+datetree+prompt "path/to/file")
7193 Will create a heading in a date tree, but will prompt for the date.
7195 @item (file+weektree "path/to/file")
7196 Will create a heading in a week tree for today's date. Week trees are sorted
7197 by week and not by month unlike datetrees.
7199 @item (file+weektree+prompt "path/to/file")
7200 Will create a heading in a week tree, but will prompt for the date.
7202 @item (file+function "path/to/file" function-finding-location)
7203 A function to find the right location in the file.
7206 File to the entry that is currently being clocked.
7208 @item (function function-finding-location)
7209 Most general way: write your own function which both visits
7210 the file and moves point to the right location.
7214 The template for creating the capture item. If you leave this empty, an
7215 appropriate default template will be used. Otherwise this is a string with
7216 escape codes, which will be replaced depending on time and context of the
7217 capture call. The string with escapes may be loaded from a template file,
7218 using the special syntax @code{(file "path/to/template")}. See below for
7222 The rest of the entry is a property list of additional options.
7223 Recognized properties are:
7227 Normally new captured information will be appended at
7228 the target location (last child, last table line, last list item...).
7229 Setting this property will change that.
7231 @item :immediate-finish
7232 When set, do not offer to edit the information, just
7233 file it away immediately. This makes sense if the template only needs
7234 information that can be added automatically.
7237 Set this to the number of lines to insert
7238 before and after the new item. Default 0, only common other value is 1.
7241 Start the clock in this item.
7244 Keep the clock running when filing the captured entry.
7247 If starting the capture interrupted a clock, restart that clock when finished
7248 with the capture. Note that @code{:clock-keep} has precedence over
7249 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7250 run and the previous one will not be resumed.
7253 Do not narrow the target buffer, simply show the full buffer. Default is to
7254 narrow it so that you only see the new material.
7256 @item :table-line-pos
7257 Specification of the location in the table where the new line should be
7258 inserted. It can be a string, a variable holding a string or a function
7259 returning a string. The string should look like @code{"II-3"} meaning that
7260 the new line should become the third line before the second horizontal
7264 If the target file was not yet visited when capture was invoked, kill the
7265 buffer again after capture is completed.
7269 @node Template expansion
7270 @subsubsection Template expansion
7272 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7273 these sequences literally, escape the @kbd{%} with a backslash.} allow
7274 dynamic insertion of content. The templates are expanded in the order given here:
7277 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7278 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7279 @r{For convenience, %:keyword (see below) placeholders}
7280 @r{within the expression will be expanded prior to this.}
7281 @r{The sexp must return a string.}
7282 %<...> @r{The result of format-time-string on the ... format specification.}
7283 %t @r{Timestamp, date only.}
7284 %T @r{Timestamp, with date and time.}
7285 %u, %U @r{Like the above, but inactive timestamps.}
7286 %i @r{Initial content, the region when capture is called while the}
7287 @r{region is active.}
7288 @r{The entire text will be indented like @code{%i} itself.}
7289 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7290 %A @r{Like @code{%a}, but prompt for the description part.}
7291 %l @r{Like %a, but only insert the literal link.}
7292 %c @r{Current kill ring head.}
7293 %x @r{Content of the X clipboard.}
7294 %k @r{Title of the currently clocked task.}
7295 %K @r{Link to the currently clocked task.}
7296 %n @r{User name (taken from @code{user-full-name}).}
7297 %f @r{File visited by current buffer when org-capture was called.}
7298 %F @r{Full path of the file or directory visited by current buffer.}
7299 %:keyword @r{Specific information for certain link types, see below.}
7300 %^g @r{Prompt for tags, with completion on tags in target file.}
7301 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7302 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7303 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7304 %^C @r{Interactive selection of which kill or clip to use.}
7305 %^L @r{Like @code{%^C}, but insert as link.}
7306 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7307 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7308 @r{You may specify a default value and a completion table with}
7309 @r{%^@{prompt|default|completion2|completion3...@}.}
7310 @r{The arrow keys access a prompt-specific history.}
7311 %\\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7312 @r{a number, starting from 1.}
7313 %? @r{After completing the template, position cursor here.}
7317 For specific link types, the following keywords will be
7318 defined@footnote{If you define your own link types (@pxref{Adding
7319 hyperlink types}), any property you store with
7320 @code{org-store-link-props} can be accessed in capture templates in a
7323 @vindex org-from-is-user-regexp
7325 Link type | Available keywords
7326 ---------------------------------+----------------------------------------------
7327 bbdb | %:name %:company
7328 irc | %:server %:port %:nick
7329 vm, vm-imap, wl, mh, mew, rmail, | %:type %:subject %:message-id
7330 gnus, notmuch | %:from %:fromname %:fromaddress
7331 | %:to %:toname %:toaddress
7332 | %:date @r{(message date header field)}
7333 | %:date-timestamp @r{(date as active timestamp)}
7334 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7335 | %: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}.}}
7336 gnus | %:group, @r{for messages also all email fields}
7338 info | %:file %:node
7343 To place the cursor after template expansion use:
7346 %? @r{After completing the template, position cursor here.}
7349 @node Templates in contexts
7350 @subsubsection Templates in contexts
7352 @vindex org-capture-templates-contexts
7353 To control whether a capture template should be accessible from a specific
7354 context, you can customize @code{org-capture-templates-contexts}. Let's say
7355 for example that you have a capture template @code{"p"} for storing Gnus
7356 emails containing patches. Then you would configure this option like this:
7359 (setq org-capture-templates-contexts
7360 '(("p" (in-mode . "message-mode"))))
7363 You can also tell that the command key @code{"p"} should refer to another
7364 template. In that case, add this command key like this:
7367 (setq org-capture-templates-contexts
7368 '(("p" "q" (in-mode . "message-mode"))))
7371 See the docstring of the variable for more information.
7374 @section Attachments
7377 @vindex org-attach-directory
7378 It is often useful to associate reference material with an outline node/task.
7379 Small chunks of plain text can simply be stored in the subtree of a project.
7380 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7381 files that live elsewhere on your computer or in the cloud, like emails or
7382 source code files belonging to a project. Another method is @i{attachments},
7383 which are files located in a directory belonging to an outline node. Org
7384 uses directories named by the unique ID of each entry. These directories are
7385 located in the @file{data} directory which lives in the same directory where
7386 your Org file lives@footnote{If you move entries or Org files from one
7387 directory to another, you may want to configure @code{org-attach-directory}
7388 to contain an absolute path.}. If you initialize this directory with
7389 @code{git init}, Org will automatically commit changes when it sees them.
7390 The attachment system has been contributed to Org by John Wiegley.
7392 In cases where it seems better to do so, you can also attach a directory of your
7393 choice to an entry. You can also make children inherit the attachment
7394 directory from a parent, so that an entire subtree uses the same attached
7397 @noindent The following commands deal with attachments:
7400 @orgcmd{C-c C-a,org-attach}
7401 The dispatcher for commands related to the attachment system. After these
7402 keys, a list of commands is displayed and you must press an additional key
7403 to select a command:
7406 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7407 @vindex org-attach-method
7408 Select a file and move it into the task's attachment directory. The file
7409 will be copied, moved, or linked, depending on @code{org-attach-method}.
7410 Note that hard links are not supported on all systems.
7416 Attach a file using the copy/move/link method.
7417 Note that hard links are not supported on all systems.
7419 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7420 Create a new attachment as an Emacs buffer.
7422 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7423 Synchronize the current task with its attachment directory, in case you added
7424 attachments yourself.
7426 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7427 @vindex org-file-apps
7428 Open current task's attachment. If there is more than one, prompt for a
7429 file name first. Opening will follow the rules set by @code{org-file-apps}.
7430 For more details, see the information on following hyperlinks
7431 (@pxref{Handling links}).
7433 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7434 Also open the attachment, but force opening the file in Emacs.
7436 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7437 Open the current task's attachment directory.
7439 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7440 Also open the directory, but force using @command{dired} in Emacs.
7442 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7443 Select and delete a single attachment.
7445 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7446 Delete all of a task's attachments. A safer way is to open the directory in
7447 @command{dired} and delete from there.
7449 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7450 @cindex property, ATTACH_DIR
7451 Set a specific directory as the entry's attachment directory. This works by
7452 putting the directory path into the @code{ATTACH_DIR} property.
7454 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7455 @cindex property, ATTACH_DIR_INHERIT
7456 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7457 same directory for attachments as the parent does.
7466 Org can add and change entries based on information found in RSS feeds and
7467 Atom feeds. You could use this to make a task out of each new podcast in a
7468 podcast feed. Or you could use a phone-based note-creating service on the
7469 web to import tasks into Org. To access feeds, configure the variable
7470 @code{org-feed-alist}. The docstring of this variable has detailed
7471 information. Here is just an example:
7475 (setq org-feed-alist
7477 "http://rss.slashdot.org/Slashdot/slashdot"
7478 "~/txt/org/feeds.org" "Slashdot Entries")))
7483 will configure that new items from the feed provided by
7484 @code{rss.slashdot.org} will result in new entries in the file
7485 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7486 the following command is used:
7489 @orgcmd{C-c C-x g,org-feed-update-all}
7491 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7493 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7494 Prompt for a feed name and go to the inbox configured for this feed.
7497 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7498 it will store information about the status of items in the feed, to avoid
7499 adding the same item several times.
7501 For more information, including how to read atom feeds, see
7502 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7505 @section Protocols for external access
7506 @cindex protocols, for external access
7509 You can set up Org for handling protocol calls from outside applications that
7510 are passed to Emacs through the @file{emacsserver}. For example, you can
7511 configure bookmarks in your web browser to send a link to the current page to
7512 Org and create a note from it using capture (@pxref{Capture}). Or you
7513 could create a bookmark that will tell Emacs to open the local source file of
7514 a remote website you are looking at with the browser. See
7515 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7516 documentation and setup instructions.
7518 @node Refile and copy
7519 @section Refile and copy
7520 @cindex refiling notes
7521 @cindex copying notes
7523 When reviewing the captured data, you may want to refile or to copy some of
7524 the entries into a different list, for example into a project. Cutting,
7525 finding the right location, and then pasting the note is cumbersome. To
7526 simplify this process, you can use the following special command:
7529 @orgcmd{C-c M-w,org-copy}
7531 Copying works like refiling, except that the original note is not deleted.
7532 @orgcmd{C-c C-w,org-refile}
7534 @vindex org-reverse-note-order
7535 @vindex org-refile-targets
7536 @vindex org-refile-use-outline-path
7537 @vindex org-outline-path-complete-in-steps
7538 @vindex org-refile-allow-creating-parent-nodes
7539 @vindex org-log-refile
7540 @vindex org-refile-use-cache
7541 @vindex org-refile-keep
7542 Refile the entry or region at point. This command offers possible locations
7543 for refiling the entry and lets you select one with completion. The item (or
7544 all items in the region) is filed below the target heading as a subitem.
7545 Depending on @code{org-reverse-note-order}, it will be either the first or
7547 By default, all level 1 headlines in the current buffer are considered to be
7548 targets, but you can have more complex definitions across a number of files.
7549 See the variable @code{org-refile-targets} for details. If you would like to
7550 select a location via a file-path-like completion along the outline path, see
7551 the variables @code{org-refile-use-outline-path} and
7552 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7553 create new nodes as new parents for refiling on the fly, check the
7554 variable @code{org-refile-allow-creating-parent-nodes}.
7555 When the variable @code{org-log-refile}@footnote{with corresponding
7556 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7557 and @code{nologrefile}} is set, a timestamp or a note will be
7558 recorded when an entry has been refiled.
7559 @orgkey{C-u C-c C-w}
7560 Use the refile interface to jump to a heading.
7561 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7562 Jump to the location where @code{org-refile} last moved a tree to.
7564 Refile as the child of the item currently being clocked.
7566 Refile and keep the entry in place. Also see @code{org-refile-keep} to make
7567 this the default behavior, and beware that this may result in duplicated
7568 @code{ID} properties.
7569 @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}
7570 Clear the target cache. Caching of refile targets can be turned on by
7571 setting @code{org-refile-use-cache}. To make the command see new possible
7572 targets, you have to clear the cache with this command.
7579 When a project represented by a (sub)tree is finished, you may want
7580 to move the tree out of the way and to stop it from contributing to the
7581 agenda. Archiving is important to keep your working files compact and global
7582 searches like the construction of agenda views fast.
7585 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7586 @vindex org-archive-default-command
7587 Archive the current entry using the command specified in the variable
7588 @code{org-archive-default-command}.
7592 * Moving subtrees:: Moving a tree to an archive file
7593 * Internal archiving:: Switch off a tree but keep it in the file
7596 @node Moving subtrees
7597 @subsection Moving a tree to the archive file
7598 @cindex external archiving
7600 The most common archiving action is to move a project tree to another file,
7604 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7605 @vindex org-archive-location
7606 Archive the subtree starting at the cursor position to the location
7607 given by @code{org-archive-location}.
7608 @orgkey{C-u C-c C-x C-s}
7609 Check if any direct children of the current headline could be moved to
7610 the archive. To do this, each subtree is checked for open TODO entries.
7611 If none are found, the command offers to move it to the archive
7612 location. If the cursor is @emph{not} on a headline when this command
7613 is invoked, the level 1 trees will be checked.
7614 @orgkey{C-u C-u C-c C-x C-s}
7615 As above, but check subtree for timestamps instead of TODO entries. The
7616 command will offer to archive the subtree if it @emph{does} contain a
7617 timestamp, and that timestamp is in the past.
7620 @cindex archive locations
7621 The default archive location is a file in the same directory as the
7622 current file, with the name derived by appending @file{_archive} to the
7623 current file name. You can also choose what heading to file archived
7624 items under, with the possibility to add them to a datetree in a file.
7625 For information and examples on how to specify the file and the heading,
7626 see the documentation string of the variable
7627 @code{org-archive-location}.
7629 There is also an in-buffer option for setting this variable, for example:
7633 #+ARCHIVE: %s_done::
7636 @cindex property, ARCHIVE
7638 If you would like to have a special ARCHIVE location for a single entry
7639 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7640 location as the value (@pxref{Properties and columns}).
7642 @vindex org-archive-save-context-info
7643 When a subtree is moved, it receives a number of special properties that
7644 record context information like the file from where the entry came, its
7645 outline path the archiving time etc. Configure the variable
7646 @code{org-archive-save-context-info} to adjust the amount of information
7650 @node Internal archiving
7651 @subsection Internal archiving
7653 If you want to just switch off (for agenda views) certain subtrees without
7654 moving them to a different file, you can use the @code{ARCHIVE tag}.
7656 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7657 its location in the outline tree, but behaves in the following way:
7660 @vindex org-cycle-open-archived-trees
7661 It does not open when you attempt to do so with a visibility cycling
7662 command (@pxref{Visibility cycling}). You can force cycling archived
7663 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7664 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7665 @code{show-all} will open archived subtrees.
7667 @vindex org-sparse-tree-open-archived-trees
7668 During sparse tree construction (@pxref{Sparse trees}), matches in
7669 archived subtrees are not exposed, unless you configure the option
7670 @code{org-sparse-tree-open-archived-trees}.
7672 @vindex org-agenda-skip-archived-trees
7673 During agenda view construction (@pxref{Agenda views}), the content of
7674 archived trees is ignored unless you configure the option
7675 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7676 be included. In the agenda you can press @kbd{v a} to get archives
7677 temporarily included.
7679 @vindex org-export-with-archived-trees
7680 Archived trees are not exported (@pxref{Exporting}), only the headline
7681 is. Configure the details using the variable
7682 @code{org-export-with-archived-trees}.
7684 @vindex org-columns-skip-archived-trees
7685 Archived trees are excluded from column view unless the variable
7686 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7689 The following commands help manage the ARCHIVE tag:
7692 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7693 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7694 the headline changes to a shadowed face, and the subtree below it is
7696 @orgkey{C-u C-c C-x a}
7697 Check if any direct children of the current headline should be archived.
7698 To do this, each subtree is checked for open TODO entries. If none are
7699 found, the command offers to set the ARCHIVE tag for the child. If the
7700 cursor is @emph{not} on a headline when this command is invoked, the
7701 level 1 trees will be checked.
7702 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7703 Cycle a tree even if it is tagged with ARCHIVE.
7704 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7705 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7706 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7707 entry becomes a child of that sibling and in this way retains a lot of its
7708 original context, including inherited tags and approximate position in the
7714 @chapter Agenda views
7715 @cindex agenda views
7717 Due to the way Org works, TODO items, time-stamped items, and
7718 tagged headlines can be scattered throughout a file or even a number of
7719 files. To get an overview of open action items, or of events that are
7720 important for a particular date, this information must be collected,
7721 sorted and displayed in an organized way.
7723 Org can select items based on various criteria and display them
7724 in a separate buffer. Seven different view types are provided:
7728 an @emph{agenda} that is like a calendar and shows information
7731 a @emph{TODO list} that covers all unfinished
7734 a @emph{match view}, showings headlines based on the tags, properties, and
7735 TODO state associated with them,
7737 a @emph{timeline view} that shows all events in a single Org file,
7738 in time-sorted view,
7740 a @emph{text search view} that shows all entries from multiple files
7741 that contain specified keywords,
7743 a @emph{stuck projects view} showing projects that currently don't move
7746 @emph{custom views} that are special searches and combinations of different
7751 The extracted information is displayed in a special @emph{agenda
7752 buffer}. This buffer is read-only, but provides commands to visit the
7753 corresponding locations in the original Org files, and even to
7754 edit these files remotely.
7756 @vindex org-agenda-window-setup
7757 @vindex org-agenda-restore-windows-after-quit
7758 Two variables control how the agenda buffer is displayed and whether the
7759 window configuration is restored when the agenda exits:
7760 @code{org-agenda-window-setup} and
7761 @code{org-agenda-restore-windows-after-quit}.
7764 * Agenda files:: Files being searched for agenda information
7765 * Agenda dispatcher:: Keyboard access to agenda views
7766 * Built-in agenda views:: What is available out of the box?
7767 * Presentation and sorting:: How agenda items are prepared for display
7768 * Agenda commands:: Remote editing of Org trees
7769 * Custom agenda views:: Defining special searches and views
7770 * Exporting agenda views:: Writing a view to a file
7771 * Agenda column view:: Using column view for collected entries
7775 @section Agenda files
7776 @cindex agenda files
7777 @cindex files for agenda
7779 @vindex org-agenda-files
7780 The information to be shown is normally collected from all @emph{agenda
7781 files}, the files listed in the variable
7782 @code{org-agenda-files}@footnote{If the value of that variable is not a
7783 list, but a single file name, then the list of agenda files will be
7784 maintained in that external file.}. If a directory is part of this list,
7785 all files with the extension @file{.org} in this directory will be part
7788 Thus, even if you only work with a single Org file, that file should
7789 be put into the list@footnote{When using the dispatcher, pressing
7790 @kbd{<} before selecting a command will actually limit the command to
7791 the current file, and ignore @code{org-agenda-files} until the next
7792 dispatcher command.}. You can customize @code{org-agenda-files}, but
7793 the easiest way to maintain it is through the following commands
7795 @cindex files, adding to agenda list
7797 @orgcmd{C-c [,org-agenda-file-to-front}
7798 Add current file to the list of agenda files. The file is added to
7799 the front of the list. If it was already in the list, it is moved to
7800 the front. With a prefix argument, file is added/moved to the end.
7801 @orgcmd{C-c ],org-remove-file}
7802 Remove current file from the list of agenda files.
7804 @cindex cycling, of agenda files
7805 @orgcmd{C-',org-cycle-agenda-files}
7807 Cycle through agenda file list, visiting one file after the other.
7808 @kindex M-x org-iswitchb
7809 @item M-x org-iswitchb RET
7810 Command to use an @code{iswitchb}-like interface to switch to and between Org
7815 The Org menu contains the current list of files and can be used
7816 to visit any of them.
7818 If you would like to focus the agenda temporarily on a file not in
7819 this list, or on just one file in the list, or even on only a subtree in a
7820 file, then this can be done in different ways. For a single agenda command,
7821 you may press @kbd{<} once or several times in the dispatcher
7822 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7823 extended period, use the following commands:
7826 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7827 Permanently restrict the agenda to the current subtree. When with a
7828 prefix argument, or with the cursor before the first headline in a file,
7829 the agenda scope is set to the entire file. This restriction remains in
7830 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7831 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7832 agenda view, the new restriction takes effect immediately.
7833 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7834 Remove the permanent restriction created by @kbd{C-c C-x <}.
7838 When working with @file{speedbar.el}, you can use the following commands in
7842 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7843 Permanently restrict the agenda to the item---either an Org file or a subtree
7844 in such a file---at the cursor in the Speedbar frame.
7845 If there is a window displaying an agenda view, the new restriction takes
7847 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7848 Lift the restriction.
7851 @node Agenda dispatcher
7852 @section The agenda dispatcher
7853 @cindex agenda dispatcher
7854 @cindex dispatching agenda commands
7855 The views are created through a dispatcher, which should be bound to a
7856 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7857 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7858 is accessed and list keyboard access to commands accordingly. After
7859 pressing @kbd{C-c a}, an additional letter is required to execute a
7860 command. The dispatcher offers the following default commands:
7864 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7866 Create a list of all TODO items (@pxref{Global TODO list}).
7868 Create a list of headlines matching a TAGS expression (@pxref{Matching
7869 tags and properties}).
7871 Create the timeline view for the current buffer (@pxref{Timeline}).
7873 Create a list of entries selected by a boolean expression of keywords
7874 and/or regular expressions that must or must not occur in the entry.
7876 @vindex org-agenda-text-search-extra-files
7877 Search for a regular expression in all agenda files and additionally in
7878 the files listed in @code{org-agenda-text-search-extra-files}. This
7879 uses the Emacs command @code{multi-occur}. A prefix argument can be
7880 used to specify the number of context lines for each match, default is
7883 Create a list of stuck projects (@pxref{Stuck projects}).
7885 Restrict an agenda command to the current buffer@footnote{For backward
7886 compatibility, you can also press @kbd{1} to restrict to the current
7887 buffer.}. After pressing @kbd{<}, you still need to press the character
7888 selecting the command.
7890 If there is an active region, restrict the following agenda command to
7891 the region. Otherwise, restrict it to the current subtree@footnote{For
7892 backward compatibility, you can also press @kbd{0} to restrict to the
7893 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7894 character selecting the command.
7897 @cindex agenda, sticky
7898 @vindex org-agenda-sticky
7899 Toggle sticky agenda views. By default, Org maintains only a single agenda
7900 buffer and rebuilds it each time you change the view, to make sure everything
7901 is always up to date. If you often switch between agenda views and the build
7902 time bothers you, you can turn on sticky agenda buffers or make this the
7903 default by customizing the variable @code{org-agenda-sticky}. With sticky
7904 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7905 it will only switch to the selected one, and you need to update the agenda by
7906 hand with @kbd{r} or @kbd{g} when needed. You can toggle sticky agenda view
7907 any time with @code{org-toggle-sticky-agenda}.
7910 You can also define custom commands that will be accessible through the
7911 dispatcher, just like the default commands. This includes the
7912 possibility to create extended agenda buffers that contain several
7913 blocks together, for example the weekly agenda, the global TODO list and
7914 a number of special tags matches. @xref{Custom agenda views}.
7916 @node Built-in agenda views
7917 @section The built-in agenda views
7919 In this section we describe the built-in views.
7922 * Weekly/daily agenda:: The calendar page with current tasks
7923 * Global TODO list:: All unfinished action items
7924 * Matching tags and properties:: Structured information with fine-tuned search
7925 * Timeline:: Time-sorted view for single file
7926 * Search view:: Find entries by searching for text
7927 * Stuck projects:: Find projects you need to review
7930 @node Weekly/daily agenda
7931 @subsection The weekly/daily agenda
7933 @cindex weekly agenda
7934 @cindex daily agenda
7936 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7937 paper agenda, showing all the tasks for the current week or day.
7940 @cindex org-agenda, command
7941 @orgcmd{C-c a a,org-agenda-list}
7942 Compile an agenda for the current week from a list of Org files. The agenda
7943 shows the entries for each day. With a numeric prefix@footnote{For backward
7944 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7945 listed before the agenda. This feature is deprecated, use the dedicated TODO
7946 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7947 C-c a a}) you may set the number of days to be displayed.
7950 @vindex org-agenda-span
7951 @vindex org-agenda-ndays
7952 @vindex org-agenda-start-day
7953 @vindex org-agenda-start-on-weekday
7954 The default number of days displayed in the agenda is set by the variable
7955 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7956 variable can be set to any number of days you want to see by default in the
7957 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7958 @code{year}. For weekly agendas, the default is to start on the previous
7959 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7960 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7961 start the agenda ten days from today in the future.
7963 Remote editing from the agenda buffer means, for example, that you can
7964 change the dates of deadlines and appointments from the agenda buffer.
7965 The commands available in the Agenda buffer are listed in @ref{Agenda
7968 @subsubheading Calendar/Diary integration
7969 @cindex calendar integration
7970 @cindex diary integration
7972 Emacs contains the calendar and diary by Edward M. Reingold. The
7973 calendar displays a three-month calendar with holidays from different
7974 countries and cultures. The diary allows you to keep track of
7975 anniversaries, lunar phases, sunrise/set, recurrent appointments
7976 (weekly, monthly) and more. In this way, it is quite complementary to
7977 Org. It can be very useful to combine output from Org with
7980 In order to include entries from the Emacs diary into Org mode's
7981 agenda, you only need to customize the variable
7984 (setq org-agenda-include-diary t)
7987 @noindent After that, everything will happen automatically. All diary
7988 entries including holidays, anniversaries, etc., will be included in the
7989 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7990 @key{RET} can be used from the agenda buffer to jump to the diary
7991 file in order to edit existing diary entries. The @kbd{i} command to
7992 insert new entries for the current date works in the agenda buffer, as
7993 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7994 Sunrise/Sunset times, show lunar phases and to convert to other
7995 calendars, respectively. @kbd{c} can be used to switch back and forth
7996 between calendar and agenda.
7998 If you are using the diary only for sexp entries and holidays, it is
7999 faster to not use the above setting, but instead to copy or even move
8000 the entries into an Org file. Org mode evaluates diary-style sexp
8001 entries, and does it faster because there is no overhead for first
8002 creating the diary display. Note that the sexp entries must start at
8003 the left margin, no whitespace is allowed before them. For example,
8004 the following segment of an Org file will be processed and entries
8005 will be made in the agenda:
8012 %%(org-calendar-holiday) ; special function for holiday names
8018 %%(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
8019 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
8022 @subsubheading Anniversaries from BBDB
8023 @cindex BBDB, anniversaries
8024 @cindex anniversaries, from BBDB
8026 If you are using the Big Brothers Database to store your contacts, you will
8027 very likely prefer to store anniversaries in BBDB rather than in a
8028 separate Org or diary file. Org supports this and will show BBDB
8029 anniversaries as part of the agenda. All you need to do is to add the
8030 following to one of your agenda files:
8037 %%(org-bbdb-anniversaries)
8040 You can then go ahead and define anniversaries for a BBDB record. Basically,
8041 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
8042 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
8043 followed by a space and the class of the anniversary (@samp{birthday} or
8044 @samp{wedding}, or a format string). If you omit the class, it will default to
8045 @samp{birthday}. Here are a few examples, the header for the file
8046 @file{org-bbdb.el} contains more detailed information.
8052 2008-04-14 %s released version 6.01 of org mode, %d years ago
8055 After a change to BBDB, or for the first agenda display during an Emacs
8056 session, the agenda display will suffer a short delay as Org updates its
8057 hash with anniversaries. However, from then on things will be very fast---much
8058 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
8059 in an Org or Diary file.
8061 If you would like to see upcoming anniversaries with a bit of forewarning,
8062 you can use the following instead:
8069 %%(org-bbdb-anniversaries-future 3)
8072 That will give you three days' warning: on the anniversary date itself and the
8073 two days prior. The argument is optional: if omitted, it defaults to 7.
8075 @subsubheading Appointment reminders
8076 @cindex @file{appt.el}
8077 @cindex appointment reminders
8081 Org can interact with Emacs appointments notification facility. To add the
8082 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
8083 This command lets you filter through the list of your appointments and add
8084 only those belonging to a specific category or matching a regular expression.
8085 It also reads a @code{APPT_WARNTIME} property which will then override the
8086 value of @code{appt-message-warning-time} for this appointment. See the
8087 docstring for details.
8089 @node Global TODO list
8090 @subsection The global TODO list
8091 @cindex global TODO list
8092 @cindex TODO list, global
8094 The global TODO list contains all unfinished TODO items formatted and
8095 collected into a single place.
8098 @orgcmd{C-c a t,org-todo-list}
8099 Show the global TODO list. This collects the TODO items from all agenda
8100 files (@pxref{Agenda views}) into a single buffer. By default, this lists
8101 items with a state the is not a DONE state. The buffer is in
8102 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
8103 entries directly from that buffer (@pxref{Agenda commands}).
8104 @orgcmd{C-c a T,org-todo-list}
8105 @cindex TODO keyword matching
8106 @vindex org-todo-keywords
8107 Like the above, but allows selection of a specific TODO keyword. You can
8108 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
8109 prompted for a keyword, and you may also specify several keywords by
8110 separating them with @samp{|} as the boolean OR operator. With a numeric
8111 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
8113 The @kbd{r} key in the agenda buffer regenerates it, and you can give
8114 a prefix argument to this command to change the selected TODO keyword,
8115 for example @kbd{3 r}. If you often need a search for a specific
8116 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
8117 Matching specific TODO keywords can also be done as part of a tags
8118 search (@pxref{Tag searches}).
8121 Remote editing of TODO items means that you can change the state of a
8122 TODO entry with a single key press. The commands available in the
8123 TODO list are described in @ref{Agenda commands}.
8125 @cindex sublevels, inclusion into TODO list
8126 Normally the global TODO list simply shows all headlines with TODO
8127 keywords. This list can become very long. There are two ways to keep
8131 @vindex org-agenda-todo-ignore-scheduled
8132 @vindex org-agenda-todo-ignore-deadlines
8133 @vindex org-agenda-todo-ignore-timestamp
8134 @vindex org-agenda-todo-ignore-with-date
8135 Some people view a TODO item that has been @emph{scheduled} for execution or
8136 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8137 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8138 @code{org-agenda-todo-ignore-deadlines},
8139 @code{org-agenda-todo-ignore-timestamp} and/or
8140 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8143 @vindex org-agenda-todo-list-sublevels
8144 TODO items may have sublevels to break up the task into subtasks. In
8145 such cases it may be enough to list only the highest level TODO headline
8146 and omit the sublevels from the global list. Configure the variable
8147 @code{org-agenda-todo-list-sublevels} to get this behavior.
8150 @node Matching tags and properties
8151 @subsection Matching tags and properties
8152 @cindex matching, of tags
8153 @cindex matching, of properties
8157 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8158 or have properties (@pxref{Properties and columns}), you can select headlines
8159 based on this metadata and collect them into an agenda buffer. The match
8160 syntax described here also applies when creating sparse trees with @kbd{C-c /
8164 @orgcmd{C-c a m,org-tags-view}
8165 Produce a list of all headlines that match a given set of tags. The
8166 command prompts for a selection criterion, which is a boolean logic
8167 expression with tags, like @samp{+work+urgent-withboss} or
8168 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
8169 define a custom command for it (@pxref{Agenda dispatcher}).
8170 @orgcmd{C-c a M,org-tags-view}
8171 @vindex org-tags-match-list-sublevels
8172 @vindex org-agenda-tags-todo-honor-ignore-options
8173 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8174 not-DONE state and force checking subitems (see variable
8175 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
8176 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
8177 specific TODO keywords together with a tags match is also possible, see
8181 The commands available in the tags list are described in @ref{Agenda
8184 @subsubheading Match syntax
8186 @cindex Boolean logic, for tag/property searches
8187 A search string can use Boolean operators @samp{&} for @code{AND} and
8188 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8189 Parentheses are not implemented. Each element in the search is either a
8190 tag, a regular expression matching tags, or an expression like
8191 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8192 property value. Each element may be preceded by @samp{-}, to select
8193 against it, and @samp{+} is syntactic sugar for positive selection. The
8194 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8195 present. Here are some examples, using only tags.
8199 Select headlines tagged @samp{:work:}.
8201 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8203 Select headlines tagged @samp{:work:}, but discard those also tagged
8206 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8207 @item work|laptop+night
8208 Like before, but require the @samp{:laptop:} lines to be tagged also
8212 @cindex regular expressions, with tags search
8213 Instead of a tag, you may also specify a regular expression enclosed in curly
8214 braces. For example,
8215 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8216 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8218 @cindex group tags, as regular expressions
8219 Group tags (@pxref{Tag hierarchy}) are expanded as regular expressions. E.g.,
8220 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8221 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8222 and searching for @samp{-work} will search for all headlines but those with
8223 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8225 @cindex TODO keyword matching, with tags search
8226 @cindex level, require for tags/property match
8227 @cindex category, require for tags/property match
8228 @vindex org-odd-levels-only
8229 You may also test for properties (@pxref{Properties and columns}) at the same
8230 time as matching tags. The properties may be real properties, or special
8231 properties that represent other metadata (@pxref{Special properties}). For
8232 example, the ``property'' @code{TODO} represents the TODO keyword of the
8233 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8236 In addition to the @ref{Special properties}, one other ``property'' can also
8237 be used. @code{LEVEL} represents the level of an entry. So a search
8238 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8239 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8240 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8241 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8243 Here are more examples:
8246 @item work+TODO="WAITING"
8247 Select @samp{:work:}-tagged TODO lines with the specific TODO
8248 keyword @samp{WAITING}.
8249 @item work+TODO="WAITING"|home+TODO="WAITING"
8250 Waiting tasks both at work and at home.
8253 When matching properties, a number of different operators can be used to test
8254 the value of a property. Here is a complex example:
8257 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8258 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8262 The type of comparison will depend on how the comparison value is written:
8265 If the comparison value is a plain number, a numerical comparison is done,
8266 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8267 @samp{>=}, and @samp{<>}.
8269 If the comparison value is enclosed in double-quotes,
8270 a string comparison is done, and the same operators are allowed.
8272 If the comparison value is enclosed in double-quotes @emph{and} angular
8273 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8274 assumed to be date/time specifications in the standard Org way, and the
8275 comparison will be done accordingly. Special values that will be recognized
8276 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8277 @code{"<tomorrow>"} for these days at 00:00 hours, i.e., without a time
8278 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8279 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8280 respectively, can be used.
8282 If the comparison value is enclosed
8283 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8284 regexp matches the property value, and @samp{<>} meaning that it does not
8288 So the search string in the example finds entries tagged @samp{:work:} but
8289 not @samp{:boss:}, which also have a priority value @samp{A}, a
8290 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8291 property that is numerically smaller than 2, a @samp{:With:} property that is
8292 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8293 on or after October 11, 2008.
8295 You can configure Org mode to use property inheritance during a search, but
8296 beware that this can slow down searches considerably. See @ref{Property
8297 inheritance}, for details.
8299 For backward compatibility, and also for typing speed, there is also a
8300 different way to test TODO states in a search. For this, terminate the
8301 tags/property part of the search string (which may include several terms
8302 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8303 expression just for TODO keywords. The syntax is then similar to that for
8304 tags, but should be applied with care: for example, a positive selection on
8305 several TODO keywords cannot meaningfully be combined with boolean AND@.
8306 However, @emph{negative selection} combined with AND can be meaningful. To
8307 make sure that only lines are checked that actually have any TODO keyword
8308 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8309 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8310 not match TODO keywords in a DONE state. Examples:
8314 Same as @samp{work+TODO="WAITING"}
8315 @item work/!-WAITING-NEXT
8316 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8318 @item work/!+WAITING|+NEXT
8319 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8324 @subsection Timeline for a single file
8325 @cindex timeline, single file
8326 @cindex time-sorted view
8328 The timeline summarizes all time-stamped items from a single Org mode
8329 file in a @emph{time-sorted view}. The main purpose of this command is
8330 to give an overview over events in a project.
8333 @orgcmd{C-c a L,org-timeline}
8334 Show a time-sorted view of the Org file, with all time-stamped items.
8335 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8336 (scheduled or not) are also listed under the current date.
8340 The commands available in the timeline buffer are listed in
8341 @ref{Agenda commands}.
8344 @subsection Search view
8347 @cindex searching, for text
8349 This agenda view is a general text search facility for Org mode entries.
8350 It is particularly useful to find notes.
8353 @orgcmd{C-c a s,org-search-view}
8354 This is a special search that lets you select entries by matching a substring
8355 or specific words using a boolean logic.
8357 For example, the search string @samp{computer equipment} will find entries
8358 that contain @samp{computer equipment} as a substring. If the two words are
8359 separated by more space or a line break, the search will still match.
8360 Search view can also search for specific keywords in the entry, using Boolean
8361 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8362 will search for note entries that contain the keywords @code{computer}
8363 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8364 not matched by the regular expression @code{8\.11[bg]}, meaning to
8365 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8366 word search, other @samp{+} characters are optional. For more details, see
8367 the docstring of the command @code{org-search-view}.
8369 @vindex org-agenda-text-search-extra-files
8370 Note that in addition to the agenda files, this command will also search
8371 the files listed in @code{org-agenda-text-search-extra-files}.
8373 @node Stuck projects
8374 @subsection Stuck projects
8375 @pindex GTD, Getting Things Done
8377 If you are following a system like David Allen's GTD to organize your
8378 work, one of the ``duties'' you have is a regular review to make sure
8379 that all projects move along. A @emph{stuck} project is a project that
8380 has no defined next actions, so it will never show up in the TODO lists
8381 Org mode produces. During the review, you need to identify such
8382 projects and define next actions for them.
8385 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8386 List projects that are stuck.
8389 @vindex org-stuck-projects
8390 Customize the variable @code{org-stuck-projects} to define what a stuck
8391 project is and how to find it.
8394 You almost certainly will have to configure this view before it will
8395 work for you. The built-in default assumes that all your projects are
8396 level-2 headlines, and that a project is not stuck if it has at least
8397 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8399 Let's assume that you, in your own way of using Org mode, identify
8400 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8401 indicate a project that should not be considered yet. Let's further
8402 assume that the TODO keyword DONE marks finished projects, and that NEXT
8403 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8404 is a next action even without the NEXT tag. Finally, if the project
8405 contains the special word IGNORE anywhere, it should not be listed
8406 either. In this case you would start by identifying eligible projects
8407 with a tags/todo match@footnote{@xref{Tag searches}.}
8408 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8409 IGNORE in the subtree to identify projects that are not stuck. The
8410 correct customization for this is
8413 (setq org-stuck-projects
8414 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8418 Note that if a project is identified as non-stuck, the subtree of this entry
8419 will still be searched for stuck projects.
8421 @node Presentation and sorting
8422 @section Presentation and sorting
8423 @cindex presentation, of agenda items
8425 @vindex org-agenda-prefix-format
8426 @vindex org-agenda-tags-column
8427 Before displaying items in an agenda view, Org mode visually prepares the
8428 items and sorts them. Each item occupies a single line. The line starts
8429 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8430 of the item and other important information. You can customize in which
8431 column tags will be displayed through @code{org-agenda-tags-column}. You can
8432 also customize the prefix using the option @code{org-agenda-prefix-format}.
8433 This prefix is followed by a cleaned-up version of the outline headline
8434 associated with the item.
8437 * Categories:: Not all tasks are equal
8438 * Time-of-day specifications:: How the agenda knows the time
8439 * Sorting agenda items:: The order of things
8440 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8444 @subsection Categories
8448 The category is a broad label assigned to each agenda item. By default, the
8449 category is simply derived from the file name, but you can also specify it
8450 with a special line in the buffer, like this:
8457 @cindex property, CATEGORY
8458 If you would like to have a special CATEGORY for a single entry or a
8459 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8460 special category you want to apply as the value.
8463 The display in the agenda buffer looks best if the category is not
8464 longer than 10 characters.
8467 You can set up icons for category by customizing the
8468 @code{org-agenda-category-icon-alist} variable.
8470 @node Time-of-day specifications
8471 @subsection Time-of-day specifications
8472 @cindex time-of-day specification
8474 Org mode checks each agenda item for a time-of-day specification. The
8475 time can be part of the timestamp that triggered inclusion into the
8476 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8477 ranges can be specified with two timestamps, like
8479 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8481 In the headline of the entry itself, a time(range) may also appear as
8482 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8483 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8484 specifications in diary entries are recognized as well.
8486 For agenda display, Org mode extracts the time and displays it in a
8487 standard 24 hour format as part of the prefix. The example times in
8488 the previous paragraphs would end up in the agenda like this:
8491 8:30-13:00 Arthur Dent lies in front of the bulldozer
8492 12:45...... Ford Prefect arrives and takes Arthur to the pub
8493 19:00...... The Vogon reads his poem
8494 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8498 If the agenda is in single-day mode, or for the display of today, the
8499 timed entries are embedded in a time grid, like
8502 8:00...... ------------------
8503 8:30-13:00 Arthur Dent lies in front of the bulldozer
8504 10:00...... ------------------
8505 12:00...... ------------------
8506 12:45...... Ford Prefect arrives and takes Arthur to the pub
8507 14:00...... ------------------
8508 16:00...... ------------------
8509 18:00...... ------------------
8510 19:00...... The Vogon reads his poem
8511 20:00...... ------------------
8512 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8515 @vindex org-agenda-use-time-grid
8516 @vindex org-agenda-time-grid
8517 The time grid can be turned on and off with the variable
8518 @code{org-agenda-use-time-grid}, and can be configured with
8519 @code{org-agenda-time-grid}.
8521 @node Sorting agenda items
8522 @subsection Sorting agenda items
8523 @cindex sorting, of agenda items
8524 @cindex priorities, of agenda items
8525 Before being inserted into a view, the items are sorted. How this is
8526 done depends on the type of view.
8529 @vindex org-agenda-files
8530 For the daily/weekly agenda, the items for each day are sorted. The
8531 default order is to first collect all items containing an explicit
8532 time-of-day specification. These entries will be shown at the beginning
8533 of the list, as a @emph{schedule} for the day. After that, items remain
8534 grouped in categories, in the sequence given by @code{org-agenda-files}.
8535 Within each category, items are sorted by priority (@pxref{Priorities}),
8536 which is composed of the base priority (2000 for priority @samp{A}, 1000
8537 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8538 overdue scheduled or deadline items.
8540 For the TODO list, items remain in the order of categories, but within
8541 each category, sorting takes place according to priority
8542 (@pxref{Priorities}). The priority used for sorting derives from the
8543 priority cookie, with additions depending on how close an item is to its due
8546 For tags matches, items are not sorted at all, but just appear in the
8547 sequence in which they are found in the agenda files.
8550 @vindex org-agenda-sorting-strategy
8551 Sorting can be customized using the variable
8552 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8553 the estimated effort of an entry (@pxref{Effort estimates}).
8555 @node Filtering/limiting agenda items
8556 @subsection Filtering/limiting agenda items
8558 Agenda built-in or customized commands are statically defined. Agenda
8559 filters and limits provide two ways of dynamically narrowing down the list of
8560 agenda entries: @emph{filters} and @emph{limits}. Filters only act on the
8561 display of the items, while limits take effect before the list of agenda
8562 entries is built. Filters are more often used interactively, while limits are
8563 mostly useful when defined as local variables within custom agenda commands.
8565 @subsubheading Filtering in the agenda
8566 @cindex filtering, by tag, category, top headline and effort, in agenda
8567 @cindex tag filtering, in agenda
8568 @cindex category filtering, in agenda
8569 @cindex top headline filtering, in agenda
8570 @cindex effort filtering, in agenda
8571 @cindex query editing, in agenda
8574 @orgcmd{/,org-agenda-filter-by-tag}
8575 @vindex org-agenda-tag-filter-preset
8576 Filter the agenda view with respect to a tag and/or effort estimates. The
8577 difference between this and a custom agenda command is that filtering is very
8578 fast, so that you can switch quickly between different filters without having
8579 to recreate the agenda.@footnote{Custom commands can preset a filter by
8580 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8581 filter will then be applied to the view and persist as a basic filter through
8582 refreshes and more secondary filtering. The filter is a global property of
8583 the entire agenda view---in a block agenda, you should only set this in the
8584 global options section, not in the section of an individual block.}
8586 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8587 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8588 tag (including any tags that do not have a selection character). The command
8589 then hides all entries that do not contain or inherit this tag. When called
8590 with prefix arg, remove the entries that @emph{do} have the tag. A second
8591 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8592 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8593 will be narrowed by requiring or forbidding the selected additional tag.
8594 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8595 immediately use the @kbd{\} command.
8597 Org also supports automatic, context-aware tag filtering. If the variable
8598 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8599 that function can decide which tags should be excluded from the agenda
8600 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8601 as a sub-option key and runs the auto exclusion logic. For example, let's
8602 say you use a @code{Net} tag to identify tasks which need network access, an
8603 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8604 calls. You could auto-exclude these tags based on the availability of the
8605 Internet, and outside of business hours, with something like this:
8609 (defun org-my-auto-exclude-function (tag)
8611 ((string= tag "Net")
8612 (/= 0 (call-process "/sbin/ping" nil nil nil
8613 "-c1" "-q" "-t1" "mail.gnu.org")))
8614 ((or (string= tag "Errand") (string= tag "Call"))
8615 (let ((hour (nth 2 (decode-time))))
8616 (or (< hour 8) (> hour 21)))))
8619 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8630 @item @r{in} search view
8631 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8632 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8633 add a positive search term prefixed by @samp{+}, indicating that this search
8634 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8635 negative search term which @i{must not} occur/match in the entry for it to be
8639 @orgcmd{<,org-agenda-filter-by-category}
8640 @vindex org-agenda-category-filter-preset
8642 Filter the current agenda view with respect to the category of the item at
8643 point. Pressing @code{<} another time will remove this filter. When called
8644 with a prefix argument exclude the category of the item at point from the
8645 agenda. You can add a filter preset through the option
8646 @code{org-agenda-category-filter-preset} (see below.)
8648 @orgcmd{^,org-agenda-filter-by-top-headline}
8649 Filter the current agenda view and only display the siblings and the parent
8650 headline of the one at point.
8652 @orgcmd{=,org-agenda-filter-by-regexp}
8653 @vindex org-agenda-regexp-filter-preset
8655 Filter the agenda view by a regular expression: only show agenda entries
8656 matching the regular expression the user entered. When called with a prefix
8657 argument, it will filter @emph{out} entries matching the regexp. With two
8658 universal prefix arguments, it will remove all the regexp filters, which can
8659 be accumulated. You can add a filter preset through the option
8660 @code{org-agenda-category-filter-preset} (see below.)
8662 @orgcmd{_,org-agenda-filter-by-effort}
8663 @vindex org-agenda-effort-filter-preset
8664 @vindex org-sort-agenda-noeffort-is-high
8665 Filter the agenda view with respect to effort estimates.
8666 You first need to set up allowed efforts globally, for example
8668 (setq org-global-properties
8669 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8671 You can then filter for an effort by first typing an operator, one of
8672 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8673 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8674 The filter will then restrict to entries with effort smaller-or-equal, equal,
8675 or larger-or-equal than the selected value. For application of the operator,
8676 entries without a defined effort will be treated according to the value of
8677 @code{org-sort-agenda-noeffort-is-high}.
8679 @orgcmd{|,org-agenda-filter-remove-all}
8680 Remove all filters in the current agenda view.
8683 @subsubheading Setting limits for the agenda
8684 @cindex limits, in agenda
8685 @vindex org-agenda-max-entries
8686 @vindex org-agenda-max-effort
8687 @vindex org-agenda-max-todos
8688 @vindex org-agenda-max-tags
8690 Here is a list of options that you can set, either globally, or locally in
8691 your custom agenda views (@pxref{Custom agenda views}).
8694 @item org-agenda-max-entries
8695 Limit the number of entries.
8696 @item org-agenda-max-effort
8697 Limit the duration of accumulated efforts (as minutes).
8698 @item org-agenda-max-todos
8699 Limit the number of entries with TODO keywords.
8700 @item org-agenda-max-tags
8701 Limit the number of tagged entries.
8704 When set to a positive integer, each option will exclude entries from other
8705 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8706 the agenda to 100 minutes of effort and exclude any entry that has no effort
8707 property. If you want to include entries with no effort property, use a
8708 negative value for @code{org-agenda-max-effort}.
8710 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8711 command. For example, this custom command will display the next five entries
8712 with a @code{NEXT} TODO keyword.
8715 (setq org-agenda-custom-commands
8717 ((org-agenda-max-entries 5)))))
8720 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8721 will again the next five entries again, including the first entry that was
8724 You can also dynamically set temporary limits, which will be lost when
8725 rebuilding the agenda:
8728 @orgcmd{~,org-agenda-limit-interactively}
8729 This prompts for the type of limit to apply and its value.
8732 @node Agenda commands
8733 @section Commands in the agenda buffer
8734 @cindex commands, in agenda buffer
8736 Entries in the agenda buffer are linked back to the Org file or diary
8737 file where they originate. You are not allowed to edit the agenda
8738 buffer itself, but commands are provided to show and jump to the
8739 original entry location, and to edit the Org files ``remotely'' from
8740 the agenda buffer. In this way, all information is stored only once,
8741 removing the risk that your agenda and note files may diverge.
8743 Some commands can be executed with mouse clicks on agenda lines. For
8744 the other commands, the cursor needs to be in the desired line.
8747 @tsubheading{Motion}
8748 @cindex motion commands in agenda
8749 @orgcmd{n,org-agenda-next-line}
8750 Next line (same as @key{down} and @kbd{C-n}).
8751 @orgcmd{p,org-agenda-previous-line}
8752 Previous line (same as @key{up} and @kbd{C-p}).
8753 @orgcmd{N,org-agenda-next-item}
8754 Next item: same as next line, but only consider items.
8755 @orgcmd{P,org-agenda-previous-item}
8756 Previous item: same as previous line, but only consider items.
8757 @tsubheading{View/Go to Org file}
8758 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8759 Display the original location of the item in another window.
8760 With prefix arg, make sure that the entire entry is made visible in the
8761 outline, not only the heading.
8763 @orgcmd{L,org-agenda-recenter}
8764 Display original location and recenter that window.
8766 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8767 Go to the original location of the item in another window.
8769 @orgcmd{@key{RET},org-agenda-switch-to}
8770 Go to the original location of the item and delete other windows.
8772 @orgcmd{F,org-agenda-follow-mode}
8773 @vindex org-agenda-start-with-follow-mode
8774 Toggle Follow mode. In Follow mode, as you move the cursor through
8775 the agenda buffer, the other window always shows the corresponding
8776 location in the Org file. The initial setting for this mode in new
8777 agenda buffers can be set with the variable
8778 @code{org-agenda-start-with-follow-mode}.
8780 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8781 Display the entire subtree of the current item in an indirect buffer. With a
8782 numeric prefix argument N, go up to level N and then take that tree. If N is
8783 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8784 previously used indirect buffer.
8786 @orgcmd{C-c C-o,org-agenda-open-link}
8787 Follow a link in the entry. This will offer a selection of any links in the
8788 text belonging to the referenced Org node. If there is only one link, it
8789 will be followed without a selection prompt.
8791 @tsubheading{Change display}
8792 @cindex display changing, in agenda
8795 Interactively select another agenda view and append it to the current view.
8799 Delete other windows.
8801 @orgcmdkskc{v d,d,org-agenda-day-view}
8802 @xorgcmdkskc{v w,w,org-agenda-week-view}
8803 @xorgcmd{v t,org-agenda-fortnight-view}
8804 @xorgcmd{v m,org-agenda-month-view}
8805 @xorgcmd{v y,org-agenda-year-view}
8806 @xorgcmd{v SPC,org-agenda-reset-view}
8807 @vindex org-agenda-span
8808 Switch to day/week/month/year view. When switching to day or week view, this
8809 setting becomes the default for subsequent agenda refreshes. Since month and
8810 year views are slow to create, they do not become the default. A numeric
8811 prefix argument may be used to jump directly to a specific day of the year,
8812 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8813 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8814 month view, a year may be encoded in the prefix argument as well. For
8815 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8816 specification has only one or two digits, it will be mapped to the interval
8817 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8818 @code{org-agenda-span}.
8820 @orgcmd{f,org-agenda-later}
8821 Go forward in time to display the following @code{org-agenda-current-span} days.
8822 For example, if the display covers a week, switch to the following week.
8823 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8825 @orgcmd{b,org-agenda-earlier}
8826 Go backward in time to display earlier dates.
8828 @orgcmd{.,org-agenda-goto-today}
8831 @orgcmd{j,org-agenda-goto-date}
8832 Prompt for a date and go there.
8834 @orgcmd{J,org-agenda-clock-goto}
8835 Go to the currently clocked-in task @i{in the agenda buffer}.
8837 @orgcmd{D,org-agenda-toggle-diary}
8838 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8840 @orgcmdkskc{v l,l,org-agenda-log-mode}
8842 @vindex org-log-done
8843 @vindex org-agenda-log-mode-items
8844 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8845 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8846 entries that have been clocked on that day. You can configure the entry
8847 types that should be included in log mode using the variable
8848 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8849 all possible logbook entries, including state changes. When called with two
8850 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8851 @kbd{v L} is equivalent to @kbd{C-u v l}.
8853 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8854 Include inactive timestamps into the current view. Only for weekly/daily
8855 agenda and timeline views.
8857 @orgcmd{v a,org-agenda-archives-mode}
8858 @xorgcmd{v A,org-agenda-archives-mode 'files}
8859 @cindex Archives mode
8860 Toggle Archives mode. In Archives mode, trees that are marked
8861 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8862 capital @kbd{A}, even all archive files are included. To exit archives mode,
8863 press @kbd{v a} again.
8865 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8866 @vindex org-agenda-start-with-clockreport-mode
8867 @vindex org-clock-report-include-clocking-task
8868 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8869 always show a table with the clocked times for the time span and file scope
8870 covered by the current agenda view. The initial setting for this mode in new
8871 agenda buffers can be set with the variable
8872 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8873 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8874 contributions from entries that are hidden by agenda filtering@footnote{Only
8875 tags filtering will be respected here, effort filtering is ignored.}. See
8876 also the variable @code{org-clock-report-include-clocking-task}.
8879 @vindex org-agenda-clock-consistency-checks
8880 Show overlapping clock entries, clocking gaps, and other clocking problems in
8881 the current agenda range. You can then visit clocking lines and fix them
8882 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8883 information on how to customize the definition of what constituted a clocking
8884 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8887 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8888 @vindex org-agenda-start-with-entry-text-mode
8889 @vindex org-agenda-entry-text-maxlines
8890 Toggle entry text mode. In entry text mode, a number of lines from the Org
8891 outline node referenced by an agenda line will be displayed below the line.
8892 The maximum number of lines is given by the variable
8893 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8894 prefix argument will temporarily modify that number to the prefix value.
8896 @orgcmd{G,org-agenda-toggle-time-grid}
8897 @vindex org-agenda-use-time-grid
8898 @vindex org-agenda-time-grid
8899 Toggle the time grid on and off. See also the variables
8900 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8902 @orgcmd{r,org-agenda-redo}
8903 Recreate the agenda buffer, for example to reflect the changes after
8904 modification of the timestamps of items with @kbd{S-@key{left}} and
8905 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8906 argument is interpreted to create a selective list for a specific TODO
8908 @orgcmd{g,org-agenda-redo}
8911 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8912 Save all Org buffers in the current Emacs session, and also the locations of
8915 @orgcmd{C-c C-x C-c,org-agenda-columns}
8916 @vindex org-columns-default-format
8917 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8918 view format is taken from the entry at point, or (if there is no entry at
8919 point), from the first entry in the agenda view. So whatever the format for
8920 that entry would be in the original buffer (taken from a property, from a
8921 @code{#+COLUMNS} line, or from the default variable
8922 @code{org-columns-default-format}), will be used in the agenda.
8924 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8925 Remove the restriction lock on the agenda, if it is currently restricted to a
8926 file or subtree (@pxref{Agenda files}).
8928 @tsubheading{Secondary filtering and query editing}
8930 For a detailed description of these commands, see @pxref{Filtering/limiting
8933 @orgcmd{/,org-agenda-filter-by-tag}
8934 @vindex org-agenda-tag-filter-preset
8935 Filter the agenda view with respect to a tag and/or effort estimates.
8937 @orgcmd{<,org-agenda-filter-by-category}
8938 @vindex org-agenda-category-filter-preset
8940 Filter the current agenda view with respect to the category of the item at
8941 point. Pressing @code{<} another time will remove this filter.
8943 @orgcmd{^,org-agenda-filter-by-top-headline}
8944 Filter the current agenda view and only display the siblings and the parent
8945 headline of the one at point.
8947 @orgcmd{=,org-agenda-filter-by-regexp}
8948 @vindex org-agenda-regexp-filter-preset
8950 Filter the agenda view by a regular expression: only show agenda entries
8951 matching the regular expression the user entered. When called with a prefix
8952 argument, it will filter @emph{out} entries matching the regexp. With two
8953 universal prefix arguments, it will remove all the regexp filters, which can
8954 be accumulated. You can add a filter preset through the option
8955 @code{org-agenda-category-filter-preset} (see below.)
8957 @orgcmd{|,org-agenda-filter-remove-all}
8958 Remove all filters in the current agenda view.
8960 @tsubheading{Remote editing}
8961 @cindex remote editing, from agenda
8966 @cindex undoing remote-editing events
8967 @cindex remote editing, undo
8968 @orgcmd{C-_,org-agenda-undo}
8969 Undo a change due to a remote editing command. The change is undone
8970 both in the agenda buffer and in the remote buffer.
8972 @orgcmd{t,org-agenda-todo}
8973 Change the TODO state of the item, both in the agenda and in the
8976 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8977 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8978 Switch to the next/previous set of TODO keywords.
8980 @orgcmd{C-k,org-agenda-kill}
8981 @vindex org-agenda-confirm-kill
8982 Delete the current agenda item along with the entire subtree belonging
8983 to it in the original Org file. If the text to be deleted remotely
8984 is longer than one line, the kill needs to be confirmed by the user. See
8985 variable @code{org-agenda-confirm-kill}.
8987 @orgcmd{C-c C-w,org-agenda-refile}
8988 Refile the entry at point.
8990 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8991 @vindex org-archive-default-command
8992 Archive the subtree corresponding to the entry at point using the default
8993 archiving command set in @code{org-archive-default-command}. When using the
8994 @code{a} key, confirmation will be required.
8996 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8997 Toggle the ARCHIVE tag for the current headline.
8999 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
9000 Move the subtree corresponding to the current entry to its @emph{archive
9003 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
9004 Archive the subtree corresponding to the current headline. This means the
9005 entry will be moved to the configured archive location, most likely a
9008 @orgcmd{T,org-agenda-show-tags}
9009 @vindex org-agenda-show-inherited-tags
9010 Show all tags associated with the current item. This is useful if you have
9011 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
9012 tags of a headline occasionally.
9014 @orgcmd{:,org-agenda-set-tags}
9015 Set tags for the current headline. If there is an active region in the
9016 agenda, change a tag for all headings in the region.
9020 Set the priority for the current item (@command{org-agenda-priority}).
9021 Org mode prompts for the priority character. If you reply with @key{SPC},
9022 the priority cookie is removed from the entry.
9024 @orgcmd{P,org-agenda-show-priority}
9025 Display weighted priority of current item.
9027 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
9028 Increase the priority of the current item. The priority is changed in
9029 the original buffer, but the agenda is not resorted. Use the @kbd{r}
9032 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
9033 Decrease the priority of the current item.
9035 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
9036 @vindex org-log-into-drawer
9037 Add a note to the entry. This note will be recorded, and then filed to the
9038 same location where state change notes are put. Depending on
9039 @code{org-log-into-drawer}, this may be inside a drawer.
9041 @orgcmd{C-c C-a,org-attach}
9042 Dispatcher for all command related to attachments.
9044 @orgcmd{C-c C-s,org-agenda-schedule}
9045 Schedule this item. With prefix arg remove the scheduling timestamp
9047 @orgcmd{C-c C-d,org-agenda-deadline}
9048 Set a deadline for this item. With prefix arg remove the deadline.
9050 @orgcmd{S-@key{right},org-agenda-do-date-later}
9051 Change the timestamp associated with the current line by one day into the
9052 future. If the date is in the past, the first call to this command will move
9054 With a numeric prefix argument, change it by that many days. For example,
9055 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
9056 change the time by one hour. If you immediately repeat the command, it will
9057 continue to change hours even without the prefix arg. With a double @kbd{C-u
9058 C-u} prefix, do the same for changing minutes.@*
9059 The stamp is changed in the original Org file, but the change is not directly
9060 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
9062 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
9063 Change the timestamp associated with the current line by one day
9066 @orgcmd{>,org-agenda-date-prompt}
9067 Change the timestamp associated with the current line. The key @kbd{>} has
9068 been chosen, because it is the same as @kbd{S-.} on my keyboard.
9070 @orgcmd{I,org-agenda-clock-in}
9071 Start the clock on the current item. If a clock is running already, it
9074 @orgcmd{O,org-agenda-clock-out}
9075 Stop the previously started clock.
9077 @orgcmd{X,org-agenda-clock-cancel}
9078 Cancel the currently running clock.
9080 @orgcmd{J,org-agenda-clock-goto}
9081 Jump to the running clock in another window.
9083 @orgcmd{k,org-agenda-capture}
9084 Like @code{org-capture}, but use the date at point as the default date for
9085 the capture template. See @code{org-capture-use-agenda-date} to make this
9086 the default behavior of @code{org-capture}.
9087 @cindex capturing, from agenda
9088 @vindex org-capture-use-agenda-date
9090 @tsubheading{Dragging agenda lines forward/backward}
9091 @cindex dragging, agenda lines
9093 @orgcmd{M-<up>,org-agenda-drag-line-backward}
9094 Drag the line at point backward one line@footnote{Moving agenda lines does
9095 not persist after an agenda refresh and does not modify the contributing
9096 @file{.org} files}. With a numeric prefix argument, drag backward by that
9099 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9100 Drag the line at point forward one line. With a numeric prefix argument,
9101 drag forward by that many lines.
9103 @tsubheading{Bulk remote editing selected entries}
9104 @cindex remote editing, bulk, from agenda
9105 @vindex org-agenda-bulk-custom-functions
9107 @orgcmd{m,org-agenda-bulk-mark}
9108 Mark the entry at point for bulk action. With numeric prefix argument, mark
9109 that many successive entries.
9111 @orgcmd{*,org-agenda-bulk-mark-all}
9112 Mark all visible agenda entries for bulk action.
9114 @orgcmd{u,org-agenda-bulk-unmark}
9115 Unmark entry at point for bulk action.
9117 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9118 Unmark all marked entries for bulk action.
9120 @orgcmd{M-m,org-agenda-bulk-toggle}
9121 Toggle mark of the entry at point for bulk action.
9123 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9124 Toggle marks of all visible entries for bulk action.
9126 @orgcmd{%,org-agenda-bulk-mark-regexp}
9127 Mark entries matching a regular expression for bulk action.
9129 @orgcmd{B,org-agenda-bulk-action}
9130 Bulk action: act on all marked entries in the agenda. This will prompt for
9131 another key to select the action to be applied. The prefix arg to @kbd{B}
9132 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9133 these special timestamps. By default, marks are removed after the bulk. If
9134 you want them to persist, set @code{org-agenda-persistent-marks} to @code{t}
9135 or hit @kbd{p} at the prompt.
9139 Toggle persistent marks.
9141 Archive all selected entries.
9143 Archive entries by moving them to their respective archive siblings.
9145 Change TODO state. This prompts for a single TODO keyword and changes the
9146 state of all selected entries, bypassing blocking and suppressing logging
9147 notes (but not timestamps).
9149 Add a tag to all selected entries.
9151 Remove a tag from all selected entries.
9153 Schedule all items to a new date. To shift existing schedule dates by a
9154 fixed number of days, use something starting with double plus at the prompt,
9155 for example @samp{++8d} or @samp{++2w}.
9157 Set deadline to a specific date.
9159 Prompt for a single refile target and move all entries. The entries will no
9160 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9162 Reschedule randomly into the coming N days. N will be prompted for. With
9163 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9165 Apply a function@footnote{You can also create persistent custom functions
9166 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
9167 example, the function below sets the CATEGORY property of the entries to web.
9171 (defun set-category ()
9173 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9174 (org-agenda-error)))
9175 (buffer (marker-buffer marker)))
9176 (with-current-buffer buffer
9181 (org-back-to-heading t)
9182 (org-set-property "CATEGORY" "web"))))))
9187 @tsubheading{Calendar commands}
9188 @cindex calendar commands, from agenda
9190 @orgcmd{c,org-agenda-goto-calendar}
9191 Open the Emacs calendar and move to the date at the agenda cursor.
9193 @orgcmd{c,org-calendar-goto-agenda}
9194 When in the calendar, compute and show the Org mode agenda for the
9197 @cindex diary entries, creating from agenda
9198 @orgcmd{i,org-agenda-diary-entry}
9199 @vindex org-agenda-diary-file
9200 Insert a new entry into the diary, using the date at the cursor and (for
9201 block entries) the date at the mark. This will add to the Emacs diary
9202 file@footnote{This file is parsed for the agenda when
9203 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9204 command in the calendar. The diary file will pop up in another window, where
9205 you can add the entry.
9207 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9208 Org will create entries (in Org mode syntax) in that file instead. Most
9209 entries will be stored in a date-based outline tree that will later make it
9210 easy to archive appointments from previous months/years. The tree will be
9211 built under an entry with a @code{DATE_TREE} property, or else with years as
9212 top-level entries. Emacs will prompt you for the entry text---if you specify
9213 it, the entry will be created in @code{org-agenda-diary-file} without further
9214 interaction. If you directly press @key{RET} at the prompt without typing
9215 text, the target file will be shown in another window for you to finish the
9216 entry there. See also the @kbd{k r} command.
9218 @orgcmd{M,org-agenda-phases-of-moon}
9219 Show the phases of the moon for the three months around current date.
9221 @orgcmd{S,org-agenda-sunrise-sunset}
9222 Show sunrise and sunset times. The geographical location must be set
9223 with calendar variables, see the documentation for the Emacs calendar.
9225 @orgcmd{C,org-agenda-convert-date}
9226 Convert the date at cursor into many other cultural and historic
9229 @orgcmd{H,org-agenda-holidays}
9230 Show holidays for three months around the cursor date.
9232 @item M-x org-icalendar-combine-agenda-files RET
9233 Export a single iCalendar file containing entries from all agenda files.
9234 This is a globally available command, and also available in the agenda menu.
9236 @tsubheading{Exporting to a file}
9237 @orgcmd{C-x C-w,org-agenda-write}
9238 @cindex exporting agenda views
9239 @cindex agenda views, exporting
9240 @vindex org-agenda-exporter-settings
9241 Write the agenda view to a file. Depending on the extension of the selected
9242 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9243 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9244 (any other extension). When exporting to Org, only the body of original
9245 headlines are exported, not subtrees or inherited tags. When called with a
9246 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9247 variable @code{org-agenda-exporter-settings} to set options for
9248 @file{ps-print} and for @file{htmlize} to be used during export.
9250 @tsubheading{Quit and Exit}
9251 @orgcmd{q,org-agenda-quit}
9252 Quit agenda, remove the agenda buffer.
9254 @cindex agenda files, removing buffers
9255 @orgcmd{x,org-agenda-exit}
9256 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9257 for the compilation of the agenda. Buffers created by the user to
9258 visit Org files will not be removed.
9262 @node Custom agenda views
9263 @section Custom agenda views
9264 @cindex custom agenda views
9265 @cindex agenda views, custom
9267 Custom agenda commands serve two purposes: to store and quickly access
9268 frequently used TODO and tags searches, and to create special composite
9269 agenda buffers. Custom agenda commands will be accessible through the
9270 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9273 * Storing searches:: Type once, use often
9274 * Block agenda:: All the stuff you need in a single buffer
9275 * Setting options:: Changing the rules
9278 @node Storing searches
9279 @subsection Storing searches
9281 The first application of custom searches is the definition of keyboard
9282 shortcuts for frequently used searches, either creating an agenda
9283 buffer, or a sparse tree (the latter covering of course only the current
9286 @vindex org-agenda-custom-commands
9287 @cindex agenda views, main example
9288 @cindex agenda, as an agenda views
9289 @cindex agenda*, as an agenda views
9290 @cindex tags, as an agenda view
9291 @cindex todo, as an agenda view
9297 Custom commands are configured in the variable
9298 @code{org-agenda-custom-commands}. You can customize this variable, for
9299 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9300 Lisp in @file{.emacs}. The following example contains all valid agenda
9305 (setq org-agenda-custom-commands
9308 ("w" todo "WAITING")
9309 ("W" todo-tree "WAITING")
9310 ("u" tags "+boss-urgent")
9311 ("v" tags-todo "+boss-urgent")
9312 ("U" tags-tree "+boss-urgent")
9313 ("f" occur-tree "\\<FIXME\\>")
9314 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9315 ("hl" tags "+home+Lisa")
9316 ("hp" tags "+home+Peter")
9317 ("hk" tags "+home+Kim")))
9322 The initial string in each entry defines the keys you have to press
9323 after the dispatcher command @kbd{C-c a} in order to access the command.
9324 Usually this will be just a single character, but if you have many
9325 similar commands, you can also define two-letter combinations where the
9326 first character is the same in several combinations and serves as a
9327 prefix key@footnote{You can provide a description for a prefix key by
9328 inserting a cons cell with the prefix and the description.}. The second
9329 parameter is the search type, followed by the string or regular
9330 expression to be used for the matching. The example above will
9335 as a global search for agenda entries planned@footnote{@emph{Planned} means
9336 here that these entries have some planning information attached to them, like
9337 a time-stamp, a scheduled or a deadline string. See
9338 @code{org-agenda-entry-types} on how to set what planning information will be
9339 taken into account.} this week/day.
9341 as a global search for agenda entries planned this week/day, but only those
9342 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9344 as a global search for TODO entries with @samp{WAITING} as the TODO
9347 as the same search, but only in the current buffer and displaying the
9348 results as a sparse tree
9350 as a global tags search for headlines marked @samp{:boss:} but not
9353 as the same search as @kbd{C-c a u}, but limiting the search to
9354 headlines that are also TODO items
9356 as the same search as @kbd{C-c a u}, but only in the current buffer and
9357 displaying the result as a sparse tree
9359 to create a sparse tree (again: current buffer only) with all entries
9360 containing the word @samp{FIXME}
9362 as a prefix command for a HOME tags search where you have to press an
9363 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9364 Peter, or Kim) as additional tag to match.
9367 Note that the @code{*-tree} agenda views need to be called from an
9368 Org buffer as they operate on the current buffer only.
9371 @subsection Block agenda
9372 @cindex block agenda
9373 @cindex agenda, with block views
9375 Another possibility is the construction of agenda views that comprise
9376 the results of @emph{several} commands, each of which creates a block in
9377 the agenda buffer. The available commands include @code{agenda} for the
9378 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9379 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9380 matching commands discussed above: @code{todo}, @code{tags}, and
9381 @code{tags-todo}. Here are two examples:
9385 (setq org-agenda-custom-commands
9386 '(("h" "Agenda and Home-related tasks"
9390 ("o" "Agenda and Office-related tasks"
9398 This will define @kbd{C-c a h} to create a multi-block view for stuff
9399 you need to attend to at home. The resulting agenda buffer will contain
9400 your agenda for the current week, all TODO items that carry the tag
9401 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9402 command @kbd{C-c a o} provides a similar view for office tasks.
9404 @node Setting options
9405 @subsection Setting options for custom commands
9406 @cindex options, for custom agenda views
9408 @vindex org-agenda-custom-commands
9409 Org mode contains a number of variables regulating agenda construction
9410 and display. The global variables define the behavior for all agenda
9411 commands, including the custom commands. However, if you want to change
9412 some settings just for a single custom view, you can do so. Setting
9413 options requires inserting a list of variable names and values at the
9414 right spot in @code{org-agenda-custom-commands}. For example:
9418 (setq org-agenda-custom-commands
9419 '(("w" todo "WAITING"
9420 ((org-agenda-sorting-strategy '(priority-down))
9421 (org-agenda-prefix-format " Mixed: ")))
9422 ("U" tags-tree "+boss-urgent"
9423 ((org-show-context-detail 'minimal)))
9425 ((org-agenda-files '("~org/notes.org"))
9426 (org-agenda-text-search-extra-files nil)))))
9431 Now the @kbd{C-c a w} command will sort the collected entries only by
9432 priority, and the prefix format is modified to just say @samp{ Mixed: }
9433 instead of giving the category of the entry. The sparse tags tree of
9434 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9435 headline hierarchy above the match, nor the headline following the match
9436 will be shown. The command @kbd{C-c a N} will do a text search limited
9437 to only a single file.
9439 @vindex org-agenda-custom-commands
9440 For command sets creating a block agenda,
9441 @code{org-agenda-custom-commands} has two separate spots for setting
9442 options. You can add options that should be valid for just a single
9443 command in the set, and options that should be valid for all commands in
9444 the set. The former are just added to the command entry; the latter
9445 must come after the list of command entries. Going back to the block
9446 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9447 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9448 the results for GARDEN tags query in the opposite order,
9449 @code{priority-up}. This would look like this:
9453 (setq org-agenda-custom-commands
9454 '(("h" "Agenda and Home-related tasks"
9458 ((org-agenda-sorting-strategy '(priority-up)))))
9459 ((org-agenda-sorting-strategy '(priority-down))))
9460 ("o" "Agenda and Office-related tasks"
9467 As you see, the values and parentheses setting is a little complex.
9468 When in doubt, use the customize interface to set this variable---it
9469 fully supports its structure. Just one caveat: when setting options in
9470 this interface, the @emph{values} are just Lisp expressions. So if the
9471 value is a string, you need to add the double-quotes around the value
9474 @vindex org-agenda-custom-commands-contexts
9475 To control whether an agenda command should be accessible from a specific
9476 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9477 say for example that you have an agenda command @code{"o"} displaying a view
9478 that you only need when reading emails. Then you would configure this option
9482 (setq org-agenda-custom-commands-contexts
9483 '(("o" (in-mode . "message-mode"))))
9486 You can also tell that the command key @code{"o"} should refer to another
9487 command key @code{"r"}. In that case, add this command key like this:
9490 (setq org-agenda-custom-commands-contexts
9491 '(("o" "r" (in-mode . "message-mode"))))
9494 See the docstring of the variable for more information.
9496 @node Exporting agenda views
9497 @section Exporting agenda views
9498 @cindex agenda views, exporting
9500 If you are away from your computer, it can be very useful to have a printed
9501 version of some agenda views to carry around. Org mode can export custom
9502 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9503 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9504 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9505 a PDF file will also create the postscript file.}, and iCalendar files. If
9506 you want to do this only occasionally, use the command
9509 @orgcmd{C-x C-w,org-agenda-write}
9510 @cindex exporting agenda views
9511 @cindex agenda views, exporting
9512 @vindex org-agenda-exporter-settings
9513 Write the agenda view to a file. Depending on the extension of the selected
9514 file name, the view will be exported as HTML (extension @file{.html} or
9515 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9516 @file{.ics}), or plain text (any other extension). Use the variable
9517 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9518 for @file{htmlize} to be used during export, for example
9520 @vindex org-agenda-add-entry-text-maxlines
9521 @vindex htmlize-output-type
9522 @vindex ps-number-of-columns
9523 @vindex ps-landscape-mode
9525 (setq org-agenda-exporter-settings
9526 '((ps-number-of-columns 2)
9527 (ps-landscape-mode t)
9528 (org-agenda-add-entry-text-maxlines 5)
9529 (htmlize-output-type 'css)))
9533 If you need to export certain agenda views frequently, you can associate
9534 any custom agenda command with a list of output file names
9535 @footnote{If you want to store standard views like the weekly agenda
9536 or the global TODO list as well, you need to define custom commands for
9537 them in order to be able to specify file names.}. Here is an example
9538 that first defines custom commands for the agenda and the global
9539 TODO list, together with a number of files to which to export them.
9540 Then we define two block agenda commands and specify file names for them
9541 as well. File names can be relative to the current working directory,
9546 (setq org-agenda-custom-commands
9547 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9548 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9549 ("h" "Agenda and Home-related tasks"
9554 ("~/views/home.html"))
9555 ("o" "Agenda and Office-related tasks"
9560 ("~/views/office.ps" "~/calendars/office.ics"))))
9564 The extension of the file name determines the type of export. If it is
9565 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9566 the buffer to HTML and save it to this file name. If the extension is
9567 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9568 Postscript output. If the extension is @file{.ics}, iCalendar export is
9569 run export over all files that were used to construct the agenda, and
9570 limit the export to entries listed in the agenda. Any other
9571 extension produces a plain ASCII file.
9573 The export files are @emph{not} created when you use one of those
9574 commands interactively because this might use too much overhead.
9575 Instead, there is a special command to produce @emph{all} specified
9579 @orgcmd{C-c a e,org-store-agenda-views}
9580 Export all agenda views that have export file names associated with
9584 You can use the options section of the custom agenda commands to also
9585 set options for the export commands. For example:
9588 (setq org-agenda-custom-commands
9590 ((ps-number-of-columns 2)
9591 (ps-landscape-mode t)
9592 (org-agenda-prefix-format " [ ] ")
9593 (org-agenda-with-colors nil)
9594 (org-agenda-remove-tags t))
9599 This command sets two options for the Postscript exporter, to make it
9600 print in two columns in landscape format---the resulting page can be cut
9601 in two and then used in a paper agenda. The remaining settings modify
9602 the agenda prefix to omit category and scheduling information, and
9603 instead include a checkbox to check off items. We also remove the tags
9604 to make the lines compact, and we don't want to use colors for the
9605 black-and-white printer. Settings specified in
9606 @code{org-agenda-exporter-settings} will also apply, but the settings
9607 in @code{org-agenda-custom-commands} take precedence.
9610 From the command line you may also use
9612 emacs -eval (org-batch-store-agenda-views) -kill
9615 or, if you need to modify some parameters@footnote{Quoting depends on the
9616 system you use, please check the FAQ for examples.}
9618 emacs -eval '(org-batch-store-agenda-views \
9619 org-agenda-span (quote month) \
9620 org-agenda-start-day "2007-11-01" \
9621 org-agenda-include-diary nil \
9622 org-agenda-files (quote ("~/org/project.org")))' \
9626 which will create the agenda views restricted to the file
9627 @file{~/org/project.org}, without diary entries and with a 30-day
9630 You can also extract agenda information in a way that allows further
9631 processing by other programs. See @ref{Extracting agenda information}, for
9635 @node Agenda column view
9636 @section Using column view in the agenda
9637 @cindex column view, in agenda
9638 @cindex agenda, column view
9640 Column view (@pxref{Column view}) is normally used to view and edit
9641 properties embedded in the hierarchical structure of an Org file. It can be
9642 quite useful to use column view also from the agenda, where entries are
9643 collected by certain criteria.
9646 @orgcmd{C-c C-x C-c,org-agenda-columns}
9647 Turn on column view in the agenda.
9650 To understand how to use this properly, it is important to realize that the
9651 entries in the agenda are no longer in their proper outline environment.
9652 This causes the following issues:
9656 @vindex org-columns-default-format
9657 @vindex org-overriding-columns-format
9658 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9659 entries in the agenda are collected from different files, and different files
9660 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9661 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9662 currently set, and if so, takes the format from there. Otherwise it takes
9663 the format associated with the first item in the agenda, or, if that item
9664 does not have a specific format (defined in a property, or in its file), it
9665 uses @code{org-columns-default-format}.
9667 @cindex property, special, CLOCKSUM
9668 If any of the columns has a summary type defined (@pxref{Column attributes}),
9669 turning on column view in the agenda will visit all relevant agenda files and
9670 make sure that the computations of this property are up to date. This is
9671 also true for the special @code{CLOCKSUM} property. Org will then sum the
9672 values displayed in the agenda. In the daily/weekly agenda, the sums will
9673 cover a single day; in all other views they cover the entire block. It is
9674 vital to realize that the agenda may show the same entry @emph{twice} (for
9675 example as scheduled and as a deadline), and it may show two entries from the
9676 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9677 cases, the summation in the agenda will lead to incorrect results because
9678 some values will count double.
9680 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9681 the entire clocked time for this item. So even in the daily/weekly agenda,
9682 the clocksum listed in column view may originate from times outside the
9683 current view. This has the advantage that you can compare these values with
9684 a column listing the planned total effort for a task---one of the major
9685 applications for column view in the agenda. If you want information about
9686 clocked time in the displayed period use clock table mode (press @kbd{R} in
9690 @cindex property, special, CLOCKSUM_T
9691 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9692 always today's clocked time for this item. So even in the weekly agenda,
9693 the clocksum listed in column view only originates from today. This lets
9694 you compare the time you spent on a task for today, with the time already
9695 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9700 @chapter Markup for rich export
9702 When exporting Org mode documents, the exporter tries to reflect the
9703 structure of the document as accurately as possible in the back-end. Since
9704 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9705 rules on how to prepare text for rich export. This section summarizes the
9706 markup rules used in an Org mode buffer.
9709 * Structural markup elements:: The basic structure as seen by the exporter
9710 * Images and tables:: Images, tables and caption mechanism
9711 * Literal examples:: Source code examples with special formatting
9712 * Include files:: Include additional files into a document
9713 * Index entries:: Making an index
9714 * Macro replacement:: Use macros to create templates
9715 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9716 * Special blocks:: Containers targeted at export back-ends
9719 @node Structural markup elements
9720 @section Structural markup elements
9723 * Document title:: Where the title is taken from
9724 * Headings and sections:: The document structure as seen by the exporter
9725 * Table of contents:: The if and where of the table of contents
9727 * Paragraphs:: Paragraphs
9728 * Footnote markup:: Footnotes
9729 * Emphasis and monospace:: Bold, italic, etc.
9730 * Horizontal rules:: Make a line
9731 * Comment lines:: What will *not* be exported
9734 @node Document title
9735 @subheading Document title
9736 @cindex document title, markup rules
9739 The title of the exported document is taken from the special line
9743 #+TITLE: This is the title of the document
9746 @cindex property, EXPORT_TITLE
9747 If you are exporting only a subtree, its heading will become the title of the
9748 document. If the subtree has a property @code{EXPORT_TITLE}, that will take
9751 @node Headings and sections
9752 @subheading Headings and sections
9753 @cindex headings and sections, markup rules
9755 @vindex org-export-headline-levels
9756 The outline structure of the document as described in @ref{Document
9757 structure}, forms the basis for defining sections of the exported document.
9758 However, since the outline structure is also used for (for example) lists of
9759 tasks, only the first three outline levels will be used as headings. Deeper
9760 levels will become itemized lists. You can change the location of this
9761 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9762 per-file basis with a line
9769 @node Table of contents
9770 @subheading Table of contents
9771 @cindex table of contents, markup rules
9774 @vindex org-export-with-toc
9775 The table of contents is normally inserted directly before the first headline
9776 of the file. The depth of the table is by default the same as the number of
9777 headline levels, but you can choose a smaller number, or turn off the table
9778 of contents entirely, by configuring the variable @code{org-export-with-toc},
9779 or on a per-file basis with a line like
9782 #+OPTIONS: toc:2 @r{only inlcude two levels in TOC}
9783 #+OPTIONS: toc:nil @r{no default TOC at all}
9786 If you would like to move the table of contents to a different location, you
9787 should turn off the default table using @code{org-export-with-toc} or
9788 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9792 #+OPTIONS: toc:nil @r{no default TOC}
9794 #+TOC: headlines 2 @r{insert TOC here, with two headline levels}
9797 Moreover, if you append @samp{local} parameter, the table contains only
9798 entries for the children of the current section@footnote{For @LaTeX{} export,
9799 this feature requires the @code{titletoc} package. Note that @code{titletoc}
9800 must be loaded @emph{before} @code{hyperref}. Thus, you may have to
9801 customize @code{org-latex-default-packages-alist}.}. In this case, any depth
9802 parameter becomes relative to the current level.
9806 #+TOC: headlines 1 local @r{insert local TOC, with direct children only}
9809 The same @code{TOC} keyword can also generate a list of all tables (resp.@:
9810 all listings) with a caption in the document.
9813 #+TOC: listings @r{build a list of listings}
9814 #+TOC: tables @r{build a list of tables}
9817 @cindex property, ALT_TITLE
9818 The headline's title usually determines its corresponding entry in a table of
9819 contents. However, it is possible to specify an alternative title by
9820 setting @code{ALT_TITLE} property accordingly. It will then be used when
9825 @cindex lists, markup rules
9827 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9828 syntax for such lists. Most back-ends support unordered, ordered, and
9832 @subheading Paragraphs, line breaks, and quoting
9833 @cindex paragraphs, markup rules
9835 Paragraphs are separated by at least one empty line. If you need to enforce
9836 a line break within a paragraph, use @samp{\\} at the end of a line.
9838 To keep the line breaks in a region, but otherwise use normal formatting, you
9839 can use this construct, which can also be used to format poetry.
9841 @cindex #+BEGIN_VERSE
9844 Great clouds overhead
9845 Tiny black birds rise and fall
9852 When quoting a passage from another document, it is customary to format this
9853 as a paragraph that is indented on both the left and the right margin. You
9854 can include quotations in Org mode documents like this:
9856 @cindex #+BEGIN_QUOTE
9859 Everything should be made as simple as possible,
9860 but not any simpler -- Albert Einstein
9864 If you would like to center some text, do it like this:
9865 @cindex #+BEGIN_CENTER
9868 Everything should be made as simple as possible, \\
9874 @node Footnote markup
9875 @subheading Footnote markup
9876 @cindex footnotes, markup rules
9877 @cindex @file{footnote.el}
9879 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9880 by all back-ends. Org allows multiple references to the same note, and
9881 multiple footnotes side by side.
9883 @node Emphasis and monospace
9884 @subheading Emphasis and monospace
9886 @cindex underlined text, markup rules
9887 @cindex bold text, markup rules
9888 @cindex italic text, markup rules
9889 @cindex verbatim text, markup rules
9890 @cindex code text, markup rules
9891 @cindex strike-through text, markup rules
9892 @vindex org-fontify-emphasized-text
9893 @vindex org-emphasis-regexp-components
9894 @vindex org-emphasis-alist
9895 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9896 and @code{~code~}, and, if you must, @samp{+strike-through+}. Text
9897 in the code and verbatim string is not processed for Org mode specific
9898 syntax, it is exported verbatim.
9900 To turn off fontification for marked up text, you can set
9901 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9902 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9903 tune what characters are allowed before and after the markup characters, you
9904 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9905 the above variables will no take effect until you reload Org, for which you
9906 may need to restart Emacs.
9908 @node Horizontal rules
9909 @subheading Horizontal rules
9910 @cindex horizontal rules, markup rules
9911 A line consisting of only dashes, and at least 5 of them, will be exported as
9915 @subheading Comment lines
9916 @cindex comment lines
9917 @cindex exporting, not
9918 @cindex #+BEGIN_COMMENT
9920 Lines starting with zero or more whitespace characters followed by one
9921 @samp{#} and a whitespace are treated as comments and, as such, are not
9924 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9925 ... @samp{#+END_COMMENT} are not exported.
9927 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9928 other keyword or priority cookie, comments out the entire subtree. In this
9929 case, the subtree is not exported and no code block within it is executed
9930 either@footnote{For a less drastic behavior, consider using a select tag
9931 (@pxref{Export settings}) instead.}. The command below helps changing the
9932 comment status of a headline.
9937 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9941 @node Images and tables
9942 @section Images and Tables
9944 @cindex tables, markup rules
9947 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9948 the @file{table.el} package will be exported properly. For Org mode tables,
9949 the lines before the first horizontal separator line will become table header
9950 lines. You can use the following lines somewhere before the table to assign
9951 a caption and a label for cross references, and in the text you can refer to
9952 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9955 #+CAPTION: This is the caption for the next table (or link)
9956 #+NAME: tab:basic-data
9961 Optionally, the caption can take the form:
9963 #+CAPTION[Caption for list of tables]: Caption for table.
9966 @cindex inlined images, markup rules
9967 Some back-ends allow you to directly include images into the exported
9968 document. Org does this, if a link to an image files does not have
9969 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9970 define a caption for the image and maybe a label for internal cross
9971 references, make sure that the link is on a line by itself and precede it
9972 with @code{#+CAPTION} and @code{#+NAME} as follows:
9975 #+CAPTION: This is the caption for the next figure link (or table)
9976 #+NAME: fig:SED-HR4049
9981 Such images can be displayed within the buffer. @xref{Handling links,the
9982 discussion of image links}.
9984 Even though images and tables are prominent examples of captioned structures,
9985 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9986 equations, source code blocks). Depending on the export back-end, those may
9987 or may not be handled.
9989 @node Literal examples
9990 @section Literal examples
9991 @cindex literal examples, markup rules
9992 @cindex code line references, markup rules
9994 You can include literal examples that should not be subjected to
9995 markup. Such examples will be typeset in monospace, so this is well suited
9996 for source code and similar examples.
9997 @cindex #+BEGIN_EXAMPLE
10001 Some example from a text file.
10005 Note that such blocks may be @i{indented} in order to align nicely with
10006 indented text and in particular with plain list structure (@pxref{Plain
10007 lists}). For simplicity when using small examples, you can also start the
10008 example lines with a colon followed by a space. There may also be additional
10009 whitespace before the colon:
10013 : Some example from a text file.
10016 @cindex formatting source code, markup rules
10017 @vindex org-latex-listings
10018 If the example is source code from a programming language, or any other text
10019 that can be marked up by font-lock in Emacs, you can ask for the example to
10020 look like the fontified Emacs buffer@footnote{This works automatically for
10021 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
10022 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
10023 achieved using either the
10024 @url{https://www.ctan.org/tex-archive/macros/latex/contrib/listings/?lang=en, listings,}
10026 @url{https://github.com/gpoore/minted, minted,} package.
10027 If you use minted or listing, you must load the packages manually, for
10028 example by adding the desired package to
10029 @code{org-latex-packages-alist}. Refer to @code{org-latex-listings}
10030 for details.}. This is done with the @samp{src} block, where you also need
10031 to specify the name of the major mode that should be used to fontify the
10032 example@footnote{Code in @samp{src} blocks may also be evaluated either
10033 interactively or on export. See @pxref{Working with source code} for more
10034 information on evaluating code blocks.}, see @ref{Easy templates} for
10035 shortcuts to easily insert code blocks.
10036 @cindex #+BEGIN_SRC
10039 #+BEGIN_SRC emacs-lisp
10040 (defun org-xor (a b)
10046 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
10047 switch to the end of the @code{BEGIN} line, to get the lines of the example
10048 numbered. The @code{-n} takes an optional numeric argument specifying the
10049 starting line number of the block. If you use a @code{+n} switch, the
10050 numbering from the previous numbered snippet will be continued in the current
10051 one. The @code{+n} can also take a numeric argument. The value of the
10052 argument will be added to the last line of the previous block to determine
10053 the starting line number.
10056 #+BEGIN_SRC emacs-lisp -n 20
10057 ;; this will export with line number 20
10058 (message "This is line 21")
10060 #+BEGIN_SRC emacs-lisp +n 10
10061 ;; This will be listed as line 31
10062 (message "This is line 32")
10066 In literal examples, Org will interpret strings like @samp{(ref:name)} as
10067 labels, and use them as targets for special hyperlinks like @code{[[(name)]]}
10068 (i.e., the reference name enclosed in single parenthesis). In HTML, hovering
10069 the mouse over such a link will remote-highlight the corresponding code line,
10070 which is kind of cool.
10072 You can also add a @code{-r} switch which @i{removes} the labels from the
10073 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
10074 labels in the source code while using line numbers for the links, which might
10075 be useful to explain those in an Org mode example code.}. With the @code{-n}
10076 switch, links to these references will be labeled by the line numbers from
10077 the code listing, otherwise links will use the labels with no parentheses.
10078 Here is an example:
10081 #+BEGIN_SRC emacs-lisp -n -r
10082 (save-excursion (ref:sc)
10083 (goto-char (point-min))) (ref:jump)
10085 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
10086 jumps to point-min.
10089 @cindex indentation, in source blocks
10090 Finally, you can use @code{-i} to preserve the indentation of a specific code
10091 block (@pxref{Editing source code}).
10093 @vindex org-coderef-label-format
10094 If the syntax for the label format conflicts with the language syntax, use a
10095 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
10096 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
10098 HTML export also allows examples to be published as text areas (@pxref{Text
10099 areas in HTML export}).
10101 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
10102 so often, shortcuts are provided using the Easy templates facility
10103 (@pxref{Easy templates}).
10108 Edit the source code example at point in its native mode. This works by
10109 switching to a temporary buffer with the source code. You need to exit by
10110 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
10111 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
10112 from being interpreted by Org as outline nodes or special syntax. These
10113 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
10114 The edited version will then replace the old version in the Org buffer.
10115 Fixed-width regions (where each line starts with a colon followed by a space)
10116 will be edited using @code{artist-mode}@footnote{You may select
10117 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
10118 to allow creating ASCII drawings easily. Using this command in an empty line
10119 will create a new fixed-width region.
10122 Calling @code{org-store-link} while editing a source code example in a
10123 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
10124 that it is unique in the current buffer, and insert it with the proper
10125 formatting like @samp{(ref:label)} at the end of the current line. Then the
10126 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
10130 @node Include files
10131 @section Include files
10132 @cindex include files, markup rules
10134 During export, you can include the content of another file. For example, to
10135 include your @file{.emacs} file, you could use:
10139 #+INCLUDE: "~/.emacs" src emacs-lisp
10143 The first parameter names the the file to include. The optional second and
10144 third parameter specify the markup (i.e., @samp{example}, @samp{export} or
10145 @samp{src}), and, if the markup is either @samp{export} or @samp{src}, the
10146 language for formatting the contents.
10148 If markup is requested, the included content will be placed within an
10149 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10150 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10151 of content that is permissible}. No changes to the included content are made
10152 and it is the responsibility of the user to ensure that the result is valid
10153 Org syntax. For markup @samp{example} and @samp{src}, which is requesting a
10154 literal example, the content will be code-escaped before inclusion.
10156 If no markup is requested, the text will be assumed to be in Org mode format
10157 and will be processed normally. However, footnote labels (@pxref{Footnotes})
10158 in the file will be made local to that file. Contents of the included file
10159 will belong to the same structure (headline, item) containing the
10160 @code{INCLUDE} keyword. In particular, headlines within the file will become
10161 children of the current section. That behavior can be changed by providing
10162 an additional keyword parameter, @code{:minlevel}. In that case, all
10163 headlines in the included file will be shifted so the one with the lowest
10164 level reaches that specified level. For example, to make a file become a
10165 sibling of the current top-level headline, use
10168 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10171 You can also include a portion of a file by specifying a lines range using
10172 the @code{:lines} keyword parameter. The line at the upper end of the range
10173 will not be included. The start and/or the end of the range may be omitted
10174 to use the obvious defaults.
10177 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
10178 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
10179 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
10182 Finally, you may use a file-link to extract an object as matched by
10183 @code{org-link-search}@footnote{Note that
10184 @code{org-link-search-must-match-exact-headline} is locally bound to non-@code{nil}.
10185 Therefore, @code{org-link-search} only matches headlines and named elements.}
10186 (@pxref{Search options}). If the @code{:only-contents} property is non-@code{nil},
10187 only the contents of the requested element will be included, omitting
10188 properties drawer and planning-line if present. The @code{:lines} keyword
10189 operates locally with respect to the requested element. Some examples:
10192 #+INCLUDE: "./paper.org::#theory" :only-contents t
10193 @r{Include the body of the heading with the custom id @samp{theory}}
10194 #+INCLUDE: "./paper.org::mytable" @r{Include named element.}
10195 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10196 @r{Include the first 20 lines of the headline named @samp{conclusion}.}
10202 Visit the include file at point.
10205 @node Index entries
10206 @section Index entries
10207 @cindex index entries, for publishing
10209 You can specify entries that will be used for generating an index during
10210 publishing. This is done by lines starting with @code{#+INDEX}. An entry
10211 the contains an exclamation mark will create a sub item. See @ref{Generating
10212 an index} for more information.
10217 #+INDEX: Application!CV
10222 @node Macro replacement
10223 @section Macro replacement
10224 @cindex macro replacement, during export
10227 You can define text snippets with
10230 #+MACRO: name replacement text $1, $2 are arguments
10233 @noindent which can be referenced
10234 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10235 commas within arguments have to be escaped with a backslash character.
10236 Conversely, backslash characters before a comma, and only them, need to be
10237 escaped with another backslash character.}.
10239 These references, called macros, can be inserted anywhere Org markup is
10240 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10241 They can also be used in keywords accepting Org syntax, e.g.,
10242 @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR}, @code{#+DATE} and some
10243 others, export back-end specific, ones.
10245 In addition to user-defined macros, a set of predefined macros can be used:
10248 @item @{@{@{title@}@}@}
10249 @itemx @{@{@{author@}@}@}
10250 @itemx @{@{@{email@}@}@}
10251 @cindex title, macro
10252 @cindex author, macro
10253 @cindex email, macro
10254 These macros are replaced with the information available at the time of
10257 @item @{@{@{date@}@}@}
10258 @itemx @{@{@{date(@var{FORMAT})@}@}@}
10259 @cindex date, macro
10260 This macro refers to the @code{#+DATE} keyword. @var{FORMAT} is an optional
10261 argument to the @code{@{@{@{date@}@}@}} macro that will be used only if
10262 @code{#+DATE} is a single timestamp. @var{FORMAT} should be a format string
10263 understood by @code{format-time-string}.
10265 @item @{@{@{time(@var{FORMAT})@}@}@}
10266 @itemx @{@{@{modification-time(@var{FORMAT}, @var{VC})@}@}@}
10267 @cindex time, macro
10268 @cindex modification time, macro
10269 These macros refer to the date and time when the document is exported and to
10270 the modification date and time, respectively. @var{FORMAT} should be a
10271 format string understood by @code{format-time-string}. If the second
10272 argument to the @code{modification-time} macro is non-@code{nil}, Org
10273 retrieves the information from the version control system, using
10274 @file{vc.el}, instead of the file attributes.
10276 @item @{@{@{input-file@}@}@}
10277 @cindex input file, macro
10278 This macro refers to the filename of the exported file, if any.
10280 @item @{@{@{property(@var{PROPERTY-NAME})@}@}@}
10281 @itemx @{@{@{property(@var{PROPERTY-NAME},@var{SEARCH-OPTION})@}@}@}
10282 @cindex property, macro
10283 This macro returns the value of property @var{PROPERTY-NAME} in current
10284 entry. If @var{SEARCH-OPTION} (@pxref{Search options}) refers to a remote
10285 entry, it will be used instead.
10288 The surrounding brackets can be made invisible by setting
10289 @code{org-hide-macro-markers} non-@code{nil}.
10291 Macro expansion takes place during the very beginning of the export process.
10294 @node Embedded @LaTeX{}
10295 @section Embedded @LaTeX{}
10296 @cindex @TeX{} interpretation
10297 @cindex @LaTeX{} interpretation
10299 Plain ASCII is normally sufficient for almost all note taking. Exceptions
10300 include scientific notes, which often require mathematical symbols and the
10301 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10302 Donald E. Knuth's @TeX{} system. Many of the features described here as
10303 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10304 distinction.} is widely used to typeset scientific documents. Org mode
10305 supports embedding @LaTeX{} code into its files, because many academics are
10306 used to writing and reading @LaTeX{} source code, and because it can be
10307 readily processed to produce pretty output for a number of export back-ends.
10310 * Special symbols:: Greek letters and other symbols
10311 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10312 * @LaTeX{} fragments:: Complex formulas made easy
10313 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10314 * CDLaTeX mode:: Speed up entering of formulas
10317 @node Special symbols
10318 @subsection Special symbols
10319 @cindex math symbols
10320 @cindex special symbols
10321 @cindex @TeX{} macros
10322 @cindex @LaTeX{} fragments, markup rules
10323 @cindex HTML entities
10324 @cindex @LaTeX{} entities
10326 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10327 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10328 for these symbols is available, just type @samp{\} and maybe a few letters,
10329 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10330 code, Org mode allows these symbols to be present without surrounding math
10331 delimiters, for example:
10334 Angles are written as Greek letters \alpha, \beta and \gamma.
10337 @vindex org-entities
10338 During export, these symbols will be transformed into the native format of
10339 the exporter back-end. Strings like @code{\alpha} will be exported as
10340 @code{α} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10341 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10342 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10343 like this: @samp{\Aacute@{@}stor}.
10345 A large number of entities is provided, with names taken from both HTML and
10346 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10347 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10348 @samp{...} are all converted into special commands creating hyphens of
10349 different lengths or a compact set of dots.
10351 If you would like to see entities displayed as UTF-8 characters, use the
10352 following command@footnote{You can turn this on by default by setting the
10353 variable @code{org-pretty-entities}, or on a per-file base with the
10354 @code{#+STARTUP} option @code{entitiespretty}.}:
10357 @cindex @code{entitiespretty}, STARTUP keyword
10360 Toggle display of entities as UTF-8 characters. This does not change the
10361 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10362 for display purposes only.
10365 @node Subscripts and superscripts
10366 @subsection Subscripts and superscripts
10368 @cindex superscript
10370 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10371 subscripts. Again, these can be used without embedding them in math-mode
10372 delimiters. To increase the readability of ASCII text, it is not necessary
10373 (but OK) to surround multi-character sub- and superscripts with curly braces.
10377 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10378 the sun is R_@{sun@} = 6.96 x 10^8 m.
10381 @vindex org-use-sub-superscripts
10382 If you write a text where the underscore is often used in a different
10383 context, Org's convention to always interpret these as subscripts can get in
10384 your way. Configure the variable @code{org-use-sub-superscripts} to change
10385 this convention. For example, when setting this variable to @code{@{@}},
10386 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10391 In addition to showing entities as UTF-8 characters, this command will also
10392 format sub- and superscripts in a WYSIWYM way.
10395 @node @LaTeX{} fragments
10396 @subsection @LaTeX{} fragments
10397 @cindex @LaTeX{} fragments
10399 @vindex org-format-latex-header
10400 Going beyond symbols and sub- and superscripts, a full formula language is
10401 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10402 to process these for several export back-ends. When exporting to @LaTeX{},
10403 the code is left as it is. When exporting to HTML, Org can use either
10404 @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML
10405 export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
10408 @LaTeX{} fragments don't need any special marking at all. The following
10409 snippets will be identified as @LaTeX{} source code:
10412 Environments of any kind@footnote{When MathJax is used, only the
10413 environments recognized by MathJax will be processed. When
10414 @file{dvipng} program, @file{dvisvgm} program or @file{imagemagick} suite is
10415 used to create images, any @LaTeX{} environment will be handled.}. The only
10416 requirement is that the @code{\begin} statement appears on a new line, at the
10417 beginning of the line or after whitespaces only.
10419 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10420 currency specifications, single @samp{$} characters are only recognized as
10421 math delimiters if the enclosed text contains at most two line breaks, is
10422 directly attached to the @samp{$} characters with no whitespace in between,
10423 and if the closing @samp{$} is followed by whitespace or punctuation
10424 (parentheses and quotes are considered to be punctuation in this
10425 context). For the other delimiters, there is no such restriction, so when in
10426 doubt, use @samp{\(...\)} as inline math delimiters.
10429 @noindent For example:
10436 If $a^2=b$ and \( b=2 \), then the solution must be
10437 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10442 @c @vindex org-format-latex-options
10443 @c If you need any of the delimiter ASCII sequences for other purposes, you
10444 @c can configure the option @code{org-format-latex-options} to deselect the
10445 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10447 @vindex org-export-with-latex
10448 @LaTeX{} processing can be configured with the variable
10449 @code{org-export-with-latex}. The default setting is @code{t} which means
10450 MathJax for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10451 You can also set this variable on a per-file basis using one of these
10455 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10456 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10457 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10460 @node Previewing @LaTeX{} fragments
10461 @subsection Previewing @LaTeX{} fragments
10462 @cindex @LaTeX{} fragments, preview
10464 @vindex org-preview-latex-default-process
10465 If you have a working @LaTeX{} installation and @file{dvipng}, @file{dvisvgm}
10466 or @file{convert} installed@footnote{These are respectively available at
10467 @url{http://sourceforge.net/projects/dvipng/}, @url{http://dvisvgm.bplaced.net/}
10468 and from the @file{imagemagick} suite. Choose the converter by setting the
10469 variable @code{org-preview-latex-default-process} accordingly.}, @LaTeX{}
10470 fragments can be processed to produce images of the typeset expressions to be
10471 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10472 or for inline previewing within Org mode.
10474 @vindex org-format-latex-options
10475 @vindex org-format-latex-header
10476 You can customize the variables @code{org-format-latex-options} and
10477 @code{org-format-latex-header} to influence some aspects of the preview. In
10478 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10479 property of the former can be used to adjust the size of the preview images.
10482 @kindex C-c C-x C-l
10484 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10485 over the source code. If there is no fragment at point, process all
10486 fragments in the current entry (between two headlines). When called
10487 with a prefix argument, process the entire subtree. When called with
10488 two prefix arguments, or when the cursor is before the first headline,
10489 process the entire buffer.
10492 Remove the overlay preview images.
10495 @vindex org-startup-with-latex-preview
10496 You can turn on the previewing of all @LaTeX{} fragments in a file with
10499 #+STARTUP: latexpreview
10502 To disable it, simply use
10505 #+STARTUP: nolatexpreview
10509 @subsection Using CD@LaTeX{} to enter math
10512 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10513 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10514 environments and math templates. Inside Org mode, you can make use of
10515 some of the features of CD@LaTeX{} mode. You need to install
10516 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10517 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10518 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10519 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10520 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10524 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10527 When this mode is enabled, the following features are present (for more
10528 details see the documentation of CD@LaTeX{} mode):
10532 Environment templates can be inserted with @kbd{C-c @{}.
10535 The @key{TAB} key will do template expansion if the cursor is inside a
10536 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10537 inside such a fragment, see the documentation of the function
10538 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10539 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10540 correctly inside the first brace. Another @key{TAB} will get you into
10541 the second brace. Even outside fragments, @key{TAB} will expand
10542 environment abbreviations at the beginning of a line. For example, if
10543 you write @samp{equ} at the beginning of a line and press @key{TAB},
10544 this abbreviation will be expanded to an @code{equation} environment.
10545 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10549 @vindex cdlatex-simplify-sub-super-scripts
10550 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10551 characters together with a pair of braces. If you use @key{TAB} to move
10552 out of the braces, and if the braces surround only a single character or
10553 macro, they are removed again (depending on the variable
10554 @code{cdlatex-simplify-sub-super-scripts}).
10557 Pressing the grave accent @kbd{`} followed by a character inserts math
10558 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10559 after the grave accent, a help window will pop up.
10562 Pressing the apostrophe @kbd{'} followed by another character modifies
10563 the symbol before point with an accent or a font. If you wait more than
10564 1.5 seconds after the apostrophe, a help window will pop up. Character
10565 modification will work only inside @LaTeX{} fragments; outside the quote
10569 @node Special blocks
10570 @section Special blocks
10571 @cindex Special blocks
10573 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10574 examples}). It is also possible to create blocks containing raw code
10575 targeted at a specific back-end (e.g., @samp{#+BEGIN_EXPORT latex}).
10577 Any other block is a @emph{special block}. Its name is case-sensitive.
10579 For example, @samp{#+BEGIN_abstract} and @samp{#+BEGIN_video} are special
10580 blocks. The first one is useful when exporting to @LaTeX{}, the second one
10581 when exporting to HTML5.
10583 Each export back-end decides if they should be exported, and how. When the
10584 block is ignored, its contents are still exported, as if the opening and
10585 closing block lines were not there. For example, when exporting a
10586 @samp{#+BEGIN_test} block, HTML back-end wraps its contents within a
10587 @samp{<div name="test">} tag.
10589 Refer to back-end specific documentation for more information.
10595 The Org mode export facilities can be used to export Org documents or parts
10596 of Org documents to a variety of other formats. In addition, these
10597 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10598 in foreign buffers so you can author tables and lists in Org syntax and
10599 convert them in place to the target language.
10601 ASCII export produces a readable and simple version of an Org file for
10602 printing and sharing notes. HTML export allows you to easily publish notes
10603 on the web, or to build full-fledged websites. @LaTeX{} export lets you use
10604 Org mode and its structured editing functions to create arbitrarily complex
10605 @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export
10606 allows seamless collaboration across organizational boundaries. Markdown
10607 export lets you seamlessly collaborate with other developers. Finally, iCal
10608 export can extract entries with deadlines or appointments to produce a file
10609 in the iCalendar format.
10612 * The export dispatcher:: The main exporter interface
10613 * Export back-ends:: Built-in export formats
10614 * Export settings:: Generic export settings
10615 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10616 * Beamer export:: Exporting as a Beamer presentation
10617 * HTML export:: Exporting to HTML
10618 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
10619 * Markdown export:: Exporting to Markdown
10620 * OpenDocument Text export:: Exporting to OpenDocument Text
10621 * Org export:: Exporting to Org
10622 * Texinfo export:: Exporting to Texinfo
10623 * iCalendar export:: Exporting to iCalendar
10624 * Other built-in back-ends:: Exporting to a man page
10625 * Export in foreign buffers:: Author tables and lists in Org syntax
10626 * Advanced configuration:: Fine-tuning the export output
10629 @node The export dispatcher
10630 @section The export dispatcher
10631 @vindex org-export-dispatch-use-expert-ui
10632 @cindex Export, dispatcher
10634 The main entry point for export related tasks is the dispatcher, a
10635 hierarchical menu from which it is possible to select an export format and
10636 toggle export options@footnote{It is also possible to use a less intrusive
10637 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10638 non-@code{nil} value. In that case, only a prompt is visible from the
10639 minibuffer. From there one can still switch back to regular menu by pressing
10643 @orgcmd{C-c C-e,org-export-dispatch}
10645 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10646 prefix argument, repeat the last export command on the current buffer while
10647 preserving toggled options. If the current buffer hasn't changed and subtree
10648 export was activated, the command will affect that same subtree.
10651 Normally the entire buffer is exported, but if there is an active region
10652 only that part of the buffer will be exported.
10654 Several export options (@pxref{Export settings}) can be toggled from the
10655 export dispatcher with the following key combinations:
10659 @vindex org-export-async-init-file
10660 Toggle asynchronous export. Asynchronous export uses an external Emacs
10661 process that is configured with a specified initialization file.
10663 While exporting asynchronously, the output is not displayed, but stored in
10664 a place called ``the export stack''. This stack can be displayed by calling
10665 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10666 from the dispatcher menu.
10668 @vindex org-export-in-background
10669 To make this behavior the default, customize the variable
10670 @code{org-export-in-background}.
10673 Toggle body-only export. Its effect depends on the back-end used.
10674 Typically, if the back-end has a header section (like @code{<head>...</head>}
10675 in the HTML back-end), a body-only export will not include this header.
10678 @vindex org-export-initial-scope
10679 Toggle subtree export. The top heading becomes the document title.
10681 You can change the default state of this option by setting
10682 @code{org-export-initial-scope}.
10685 Toggle visible-only export. Only export the text that is currently
10686 visible, i.e., not hidden by outline visibility in the buffer.
10689 @node Export back-ends
10690 @section Export back-ends
10691 @cindex Export, back-ends
10693 An export back-end is a library that translates Org syntax into a foreign
10694 format. An export format is not available until the proper back-end has been
10697 @vindex org-export-backends
10698 By default, the following four back-ends are loaded: @code{ascii},
10699 @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
10700 (or remove some) by customizing @code{org-export-backends}.
10702 Built-in back-ends include:
10705 @item ascii (ASCII format)
10706 @item beamer (@LaTeX{} Beamer format)
10707 @item html (HTML format)
10708 @item icalendar (iCalendar format)
10709 @item latex (@LaTeX{} format)
10710 @item man (Man page format)
10711 @item md (Markdown format)
10712 @item odt (OpenDocument Text format)
10713 @item org (Org format)
10714 @item texinfo (Texinfo format)
10717 Other back-ends might be found in the @code{contrib/} directory
10718 (@pxref{Installation}).
10720 @node Export settings
10721 @section Export settings
10722 @cindex Export, settings
10725 Export options can be set: globally with variables; for an individual file by
10726 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10727 settings}), by setting individual keywords, or by specifying them in a
10728 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10729 properties (@pxref{Properties and columns}). Options set at a specific level
10730 override options set at a more general level.
10732 @cindex #+SETUPFILE
10733 In-buffer settings may appear anywhere in the file, either directly or
10734 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10735 Option keyword sets tailored to a particular back-end can be inserted from
10736 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10737 template} command by pressing @key{#}. To insert keywords individually,
10738 a good way to make sure the keyword is correct is to type @code{#+} and then
10739 to use @kbd{M-<TAB>} for completion.
10741 The export keywords available for every back-end, and their equivalent global
10742 variables, include:
10747 @vindex user-full-name
10748 The document author (@code{user-full-name}).
10752 @vindex org-export-creator-string
10753 Entity responsible for output generation (@code{org-export-creator-string}).
10757 @vindex org-export-date-timestamp-format
10758 A date or a time-stamp@footnote{The variable
10759 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10764 @vindex user-mail-address
10765 The email address (@code{user-mail-address}).
10769 @vindex org-export-default-language
10770 The language used for translating some strings
10771 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10772 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10776 @cindex #+SELECT_TAGS
10777 @vindex org-export-select-tags
10778 The tags that select a tree for export (@code{org-export-select-tags}). The
10779 default value is @code{:export:}. Within a subtree tagged with
10780 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10781 below). When headlines are selectively exported with @code{:export:}
10782 anywhere in a file, text before the first headline is ignored.
10785 @cindex #+EXCLUDE_TAGS
10786 @vindex org-export-exclude-tags
10787 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10788 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10789 tag will be unconditionally excluded from the export, even if they have an
10790 @code{:export:} tag. Code blocks contained in excluded subtrees will still
10791 be executed during export even though the subtree is not exported.
10795 The title to be shown. You can use several such keywords for long titles.
10798 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10799 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10800 recognizes the following arguments:
10804 @vindex org-export-with-smart-quotes
10805 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10808 Toggle emphasized text (@code{org-export-with-emphasize}).
10811 @vindex org-export-with-special-strings
10812 Toggle conversion of special strings
10813 (@code{org-export-with-special-strings}).
10816 @vindex org-export-with-fixed-width
10817 Toggle fixed-width sections
10818 (@code{org-export-with-fixed-width}).
10821 @vindex org-export-with-timestamps
10822 Toggle inclusion of any time/date active/inactive stamps
10823 (@code{org-export-with-timestamps}).
10826 @vindex org-export-preserve-breaks
10827 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10830 @vindex org-export-with-sub-superscripts
10831 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10832 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10833 it is (@code{org-export-with-sub-superscripts}).
10836 @vindex org-export-with-archived-trees
10837 Configure export of archived trees. Can be set to @code{headline} to only
10838 process the headline, skipping its contents
10839 (@code{org-export-with-archived-trees}).
10842 @vindex org-export-with-author
10843 Toggle inclusion of author name into exported file
10844 (@code{org-export-with-author}).
10846 @item broken-links:
10847 @vindex org-export-with-broken-links
10848 Decide whether to raise an error or not when encountering a broken internal
10849 link. When set to @code{mark}, signal the problem clearly in the output
10850 (@code{org-export-with-broken-links}).
10853 @vindex org-export-with-clocks
10854 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10857 @vindex org-export-with-creator
10858 Toggle inclusion of creator info into exported file
10859 (@code{org-export-with-creator}).
10862 @vindex org-export-with-drawers
10863 Toggle inclusion of drawers, or list drawers to include
10864 (@code{org-export-with-drawers}).
10867 @vindex org-export-with-date
10868 Toggle inclusion of a date into exported file (@code{org-export-with-date}).
10871 @vindex org-export-with-entities
10872 Toggle inclusion of entities (@code{org-export-with-entities}).
10875 @vindex org-export-with-email
10876 Toggle inclusion of the author's e-mail into exported file
10877 (@code{org-export-with-email}).
10880 @vindex org-export-with-footnotes
10881 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10884 @vindex org-export-headline-levels
10885 Set the number of headline levels for export
10886 (@code{org-export-headline-levels}). Below that level, headlines are treated
10887 differently. In most back-ends, they become list items.
10890 @vindex org-export-with-inlinetasks
10891 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10894 @vindex org-export-with-section-numbers
10895 @cindex property, UNNUMBERED
10896 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10897 be set to a number @samp{n}, so only headlines at that level or above will be
10898 numbered. Finally, irrespective of the level of a specific headline, the
10899 numbering of it can be disabled by setting the @code{UNNUMBERED} property to
10900 non-@code{nil}. This also affects subheadings.
10903 @vindex org-export-with-planning
10904 Toggle export of planning information (@code{org-export-with-planning}).
10905 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10906 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10909 @vindex org-export-with-priority
10910 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10913 @vindex org-export-with-properties
10914 Toggle inclusion of property drawers, or list properties to include
10915 (@code{org-export-with-properties}).
10918 @vindex org-export-with-statistics-cookies
10919 Toggle inclusion of statistics cookies
10920 (@code{org-export-with-statistics-cookies}).
10923 @vindex org-export-with-tags
10924 Toggle inclusion of tags, may also be @code{not-in-toc}
10925 (@code{org-export-with-tags}).
10928 @vindex org-export-with-tasks
10929 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10930 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10931 (@code{org-export-with-tasks}).
10934 @vindex org-export-with-latex
10935 Configure export of @LaTeX{} fragments and environments. It may be set to
10936 @code{verbatim} (@code{org-export-with-latex}).
10939 @vindex org-export-time-stamp-file
10940 Toggle inclusion of the creation time into exported file
10941 (@code{org-export-time-stamp-file}).
10944 @vindex org-export-with-title
10945 Toggle inclusion of title (@code{org-export-with-title}).
10948 @vindex org-export-with-toc
10949 Toggle inclusion of the table of contents, or set the level limit
10950 (@code{org-export-with-toc}).
10953 @vindex org-export-with-todo-keywords
10954 Toggle inclusion of TODO keywords into exported text
10955 (@code{org-export-with-todo-keywords}).
10958 @vindex org-export-with-tables
10959 Toggle inclusion of tables (@code{org-export-with-tables}).
10963 When exporting only a subtree, each of the previous keywords@footnote{With
10964 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10965 properties. These begin with @samp{EXPORT_}, followed by the name of the
10966 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10967 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10971 @vindex org-export-allow-bind-keywords
10972 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10973 can become buffer-local during export by using the BIND keyword. Its syntax
10974 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10975 settings that cannot be changed using specific keywords.
10977 @cindex property, EXPORT_FILE_NAME
10978 The name of the output file to be generated is taken from the file associated
10979 to the buffer, when possible, or asked to you otherwise. For subtree export,
10980 you can also set @code{EXPORT_FILE_NAME} property. In all cases, only the
10981 base name of the file is retained, and a back-end specific extension is
10984 @node ASCII/Latin-1/UTF-8 export
10985 @section ASCII/Latin-1/UTF-8 export
10986 @cindex ASCII export
10987 @cindex Latin-1 export
10988 @cindex UTF-8 export
10990 ASCII export produces a simple and very readable version of an Org mode
10991 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10992 with special characters and symbols available in these encodings.
10994 @vindex org-ascii-text-width
10995 Upon exporting, text is filled and justified, when appropriate, according the
10996 text width set in @code{org-ascii-text-width}.
10998 @vindex org-ascii-links-to-notes
10999 Links are exported in a footnote-like style, with the descriptive part in the
11000 text and the link in a note before the next heading. See the variable
11001 @code{org-ascii-links-to-notes} for details and other options.
11003 @subheading ASCII export commands
11006 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
11007 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
11008 will be @file{myfile.txt}. The file will be overwritten without warning.
11009 When the original file is @file{myfile.txt}, the resulting file becomes
11010 @file{myfile.txt.txt} in order to prevent data loss.
11011 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
11012 Export to a temporary buffer. Do not create a file.
11015 @subheading ASCII specific export settings
11017 ASCII export introduces a single of keywords, similar to the general options
11018 settings described in @ref{Export settings}.
11022 @cindex #+SUBTITLE (ASCII)
11023 The document subtitle.
11026 @subheading Header and sectioning structure
11028 In the exported version, the first three outline levels become headlines,
11029 defining a general document structure. Additional levels are exported as
11030 lists. The transition can also occur at a different level (@pxref{Export
11033 @subheading Quoting ASCII text
11035 You can insert text that will only appear when using @code{ASCII} back-end
11036 with the following constructs:
11039 @cindex #+BEGIN_EXPORT ascii
11041 Text @@@@ascii:and additional text@@@@ within a paragraph.
11045 #+BEGIN_EXPORT ascii
11046 All lines in this block will appear only when using this back-end.
11050 @subheading ASCII specific attributes
11051 @cindex #+ATTR_ASCII
11052 @cindex horizontal rules, in ASCII export
11054 @code{ASCII} back-end only understands one attribute, @code{:width}, which
11055 specifies the length, in characters, of a given horizontal rule. It must be
11056 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
11059 #+ATTR_ASCII: :width 10
11063 @subheading ASCII special blocks
11064 @cindex special blocks, in ASCII export
11065 @cindex #+BEGIN_JUSTIFYLEFT
11066 @cindex #+BEGIN_JUSTIFYRIGHT
11068 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
11069 possible to justify contents to the left or the right of the page with the
11070 following dedicated blocks.
11073 #+BEGIN_JUSTIFYLEFT
11074 It's just a jump to the left...
11077 #+BEGIN_JUSTIFYRIGHT
11078 ...and then a step to the right.
11082 @node Beamer export
11083 @section Beamer export
11084 @cindex Beamer export
11086 The @LaTeX{} class @emph{Beamer} allows production of high quality
11087 presentations using @LaTeX{} and pdf processing. Org mode has special
11088 support for turning an Org mode file or tree into a Beamer presentation.
11091 * Beamer export commands:: How to export Beamer documents.
11092 * Beamer specific export settings:: Export settings for Beamer export.
11093 * Sectioning Frames and Blocks in Beamer:: Blocks and sections in Beamer.
11094 * Beamer specific syntax:: Syntax specific to Beamer.
11095 * Editing support:: Helper functions for Org Beamer export.
11096 * A Beamer Example:: An complete Beamer example.
11099 @node Beamer export commands
11100 @subsection Beamer export commands
11103 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
11104 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11105 file will be @file{myfile.tex}. The file will be overwritten without
11107 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
11108 Export to a temporary buffer. Do not create a file.
11109 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
11110 Export as @LaTeX{} and then process to PDF.
11112 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11115 @node Beamer specific export settings
11116 @subsection Beamer specific export settings
11118 Beamer export introduces a number of keywords, similar to the general options
11119 settings described in @ref{Export settings}.
11123 @cindex #+BEAMER_THEME
11124 @vindex org-beamer-theme
11125 The Beamer theme (@code{org-beamer-theme}). Options can be specified via
11126 brackets, for example:
11128 #+BEAMER_THEME: Rochester [height=20pt]
11131 @item BEAMER_FONT_THEME
11132 @cindex #+BEAMER_FONT_THEME
11133 The Beamer font theme.
11135 @item BEAMER_INNER_THEME
11136 @cindex #+BEAMER_INNER_THEME
11137 The Beamer inner theme.
11139 @item BEAMER_OUTER_THEME
11140 @cindex #+BEAMER_OUTER_THEME
11141 The Beamer outer theme.
11143 @item BEAMER_HEADER
11144 @cindex #+BEAMER_HEADER
11145 Arbitrary lines inserted into the preamble, just before the @samp{hyperref}
11149 @cindex #+DESCRIPTION (Beamer)
11150 The document description. By default these are inserted as metadata using
11151 @samp{hyperref}. Document metadata can be configured via
11152 @code{org-latex-hyperref-template}. Description can also be typeset as part
11153 of the front matter via @code{org-latex-title-command}. You can use several
11154 @code{#+DESCRIPTION} keywords if the description is is long.
11157 @cindex #+KEYWORDS (Beamer)
11158 The keywords defining the contents of the document. By default these are
11159 inserted as metadata using @samp{hyperref}. Document metadata can be
11160 configured via @code{org-latex-hyperref-template}. Description can also be
11161 typeset as part of the front matter via @code{org-latex-title-command}. You
11162 can use several @code{#+KEYWORDS} if the description is is long.
11165 @cindex #+SUBTITLE (Beamer)
11166 @vindex org-beamer-subtitle-format
11167 The document subtitle. This is typeset using the format string
11168 @code{org-beamer-subtitle-format}. It can also access via
11169 @code{org-latex-hyperref-template} or typeset as part of the front
11170 matter via @code{org-latex-title-command}.
11173 @node Sectioning Frames and Blocks in Beamer
11174 @subsection Sectioning, Frames and Blocks in Beamer
11176 Any tree with not-too-deep level nesting should in principle be exportable as
11177 a Beamer presentation. Headlines fall into three categories: sectioning
11178 elements, frames and blocks.
11182 @vindex org-beamer-frame-level
11183 Headlines become frames when their level is equal to
11184 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
11185 (@pxref{Export settings}).
11187 @cindex property, BEAMER_ENV
11188 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
11189 set to either to @code{frame} or @code{fullframe}, its level overrides the
11190 variable. A @code{fullframe} is a frame with an empty (ignored) title.
11193 @vindex org-beamer-environments-default
11194 @vindex org-beamer-environments-extra
11195 All frame's children become @code{block} environments. Special block types
11196 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
11197 this property is set, the entry will also get a @code{:B_environment:} tag to
11198 make this visible. This tag has no semantic meaning, it is only a visual
11199 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
11200 supported values and @code{org-beamer-environments-extra} for adding more).
11203 @cindex property, BEAMER_REF
11204 As a special case, if the @code{BEAMER_ENV} property is set to either
11205 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
11206 headline will become, respectively, an appendix, a note (within frame or
11207 between frame, depending on its level), a note with its title ignored or an
11208 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
11209 is mandatory in order to refer to the frame being resumed, and contents are
11212 Also, a headline with an @code{ignoreheading} environment will have its
11213 contents only inserted in the output. This special value is useful to have
11214 data between frames, or to properly close a @code{column} environment.
11217 @cindex property, BEAMER_ACT
11218 @cindex property, BEAMER_OPT
11219 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
11220 The former is translated as an overlay/action specification, or a default
11221 overlay specification when enclosed within square brackets. The latter
11222 specifies options@footnote{The @code{fragile} option is added automatically
11223 if it contains code that requires a verbatim environment, though.} for the
11224 current frame or block. The export back-end will automatically wrap
11225 properties within angular or square brackets when appropriate.
11227 @cindex property, BEAMER_COL
11228 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
11229 be a decimal number representing the width of the column as a fraction of the
11230 total text width. If the headline has no specific environment, its title
11231 will be ignored and its contents will fill the column created. Otherwise,
11232 the block will fill the whole column and the title will be preserved. Two
11233 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
11234 @code{columns} @LaTeX{} environment. It will end before the next headline
11235 without such a property. This environment is generated automatically.
11236 Although, it can also be explicitly created, with a special @code{columns}
11237 value for @code{BEAMER_ENV} property (if it needs to be set up with some
11238 specific options, for example).
11240 @node Beamer specific syntax
11241 @subsection Beamer specific syntax
11243 The Beamer back-end is an extension of the @LaTeX{} back-end. As such, all @LaTeX{}
11244 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
11245 recognized. See @ref{@LaTeX{} and PDF export} for more information.
11247 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11248 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
11249 keyword (@pxref{Table of contents}) are not. In that case, it is also
11250 possible to specify options, enclosed within square brackets.
11253 #+TOC: headlines [currentsection]
11256 Beamer specific code can be inserted with the following constructs:
11259 @cindex #+BEGIN_EXPORT beamer
11263 #+BEGIN_EXPORT beamer
11264 All lines in this block will appear only when using this back-end.
11267 Text @@@@beamer:some code@@@@ within a paragraph.
11270 In particular, this last example can be used to add overlay specifications to
11271 objects whose type is among @code{bold}, @code{item}, @code{link},
11272 @code{radio-target} and @code{target}, when the value is enclosed within
11273 angular brackets and put at the beginning the object.
11276 A *@@@@beamer:<2->@@@@useful* feature
11279 @cindex #+ATTR_BEAMER
11280 Eventually, every plain list has support for @code{:environment},
11281 @code{:overlay} and @code{:options} attributes through
11282 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
11283 of a different environment, the second sets overlay specifications and
11284 the last one inserts optional arguments in current list environment.
11287 #+ATTR_BEAMER: :overlay +-
11292 @node Editing support
11293 @subsection Editing support
11295 You can turn on a special minor mode @code{org-beamer-mode} for faster
11303 @orgcmd{C-c C-b,org-beamer-select-environment}
11304 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11305 environment or the @code{BEAMER_COL} property.
11308 @node A Beamer Example
11309 @subsection A Beamer example
11311 Here is a simple example Org document that is intended for Beamer export.
11314 #+TITLE: Example Presentation
11315 #+AUTHOR: Carsten Dominik
11316 #+OPTIONS: H:2 toc:t num:t
11317 #+LATEX_CLASS: beamer
11318 #+LATEX_CLASS_OPTIONS: [presentation]
11319 #+BEAMER_THEME: Madrid
11320 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11322 * This is the first structural section
11325 *** Thanks to Eric Fraga :B_block:
11330 for the first viable Beamer setup in Org
11331 *** Thanks to everyone else :B_block:
11337 for contributing to the discussion
11338 **** This will be formatted as a beamer note :B_note:
11342 ** Frame 2 (where we will not use columns)
11344 Please test this stuff!
11348 @section HTML export
11349 @cindex HTML export
11351 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11352 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11353 language, but with additional support for tables.
11356 * HTML Export commands:: How to invoke HTML export
11357 * HTML Specific export settings:: Export settings for HTML export.
11358 * HTML doctypes:: Org can export to various (X)HTML flavors
11359 * HTML preamble and postamble:: How to insert a preamble and a postamble
11360 * Quoting HTML tags:: Using direct HTML in Org mode
11361 * Links in HTML export:: How links will be interpreted and formatted
11362 * Tables in HTML export:: How to modify the formatting of tables
11363 * Images in HTML export:: How to insert figures into HTML output
11364 * Math formatting in HTML export:: Beautiful math also on the web
11365 * Text areas in HTML export:: An alternative way to show an example
11366 * CSS support:: Changing the appearance of the output
11367 * JavaScript support:: Info and Folding in a web browser
11371 @node HTML Export commands
11372 @subsection HTML export commands
11375 @orgcmd{C-c C-e h h,org-html-export-to-html}
11376 Export as an HTML file. For an Org file @file{myfile.org},
11377 the HTML file will be @file{myfile.html}. The file will be overwritten
11380 Export as an HTML file and immediately open it with a browser.
11381 @orgcmd{C-c C-e h H,org-html-export-as-html}
11382 Export to a temporary buffer. Do not create a file.
11385 @c FIXME Exporting sublevels
11386 @c @cindex headline levels, for exporting
11387 @c In the exported version, the first 3 outline levels will become headlines,
11388 @c defining a general document structure. Additional levels will be exported as
11389 @c itemized lists. If you want that transition to occur at a different level,
11390 @c specify it with a numeric prefix argument. For example,
11393 @c @kbd{C-2 C-c C-e b}
11397 @c creates two levels of headings and does the rest as items.
11399 @node HTML Specific export settings
11400 @subsection HTML Specific export settings
11401 HTML export introduces a number of keywords, similar to the general options
11402 settings described in @ref{Export settings}.
11406 @cindex #+DESCRIPTION (HTML)
11407 The document description. This description is inserted as a HTML meta tag.
11408 You can use several such keywords if the list is long.
11411 @cindex #+HTML_DOCTYPE
11412 @vindex org-html-doctype
11413 The document type, e.g. HTML5, (@code{org-html-doctype}).
11415 @item HTML_CONTAINER
11416 @cindex #+HTML_CONTAINER
11417 @vindex org-html-container-element
11418 The container, e.g. @samp{div}, used to wrap sections and elements
11419 (@code{org-html-container-element}).
11421 @item HTML_LINK_HOME
11422 @cindex #+HTML_LINK_HOME
11423 @vindex org-html-link-home
11424 The home link URL (@code{org-html-link-home}).
11427 @cindex #+HTML_LINK_UP
11428 @vindex org-html-link-up
11429 The up link URL (@code{org-html-link-up}).
11432 @cindex #+HTML_MATHJAX
11433 @vindex org-html-mathjax-options
11434 Options for the MathJax (@code{org-html-mathjax-options}). MathJax is used
11435 to typeset @LaTeX{} math in HTML documents. @ref{Math formatting in HTML
11436 export} contains an example.
11439 @cindex #+HTML_HEAD
11440 @vindex org-html-head
11441 Arbitrary lines appended to the end of the head of the document
11442 (@code{org-html-head}).
11444 @item HTML_HEAD_EXTRA
11445 @cindex #+HTML_HEAD_EXTRA
11446 @vindex org-html-head-extra
11447 Arbitrary lines appended to the end of the header of the document
11448 (@code{org-html-head-extra}).
11451 @cindex #+KEYWORDS (HTML)
11452 The keywords defining the contents of the document. This description is
11453 inserted as a HTML meta tag. You can use several such keywords if the list
11457 @cindex #+LATEX_HEADER (HTML)
11458 Arbitrary lines appended to the preamble used when transcoding @LaTeX{}
11459 fragments to images. See @ref{Math formatting in HTML export} for details.
11462 @cindex #+SUBTILE (HTML)
11463 The document subtitle. The formatting depends on whether HTML5 in used
11464 and on the @samp{subtitle} CSS class.
11467 These keywords are treated in details in the following sections.
11469 @node HTML doctypes
11470 @subsection HTML doctypes
11471 @vindex org-html-doctype
11472 @vindex org-html-doctype-alist
11474 Org can export to various (X)HTML flavors.
11476 Setting the variable @code{org-html-doctype} allows you to export to different
11477 (X)HTML variants. The exported HTML will be adjusted according to the syntax
11478 requirements of that variant. You can either set this variable to a doctype
11479 string directly, in which case the exporter will try to adjust the syntax
11480 automatically, or you can use a ready-made doctype. The ready-made options
11487 ``html4-transitional''
11493 ``xhtml-transitional''
11504 See the variable @code{org-html-doctype-alist} for details. The default is
11507 @subsubheading Fancy HTML5 export
11508 @vindex org-html-html5-fancy
11509 @vindex org-html-html5-elements
11511 HTML5 introduces several new element types. By default, Org will not make
11512 use of these element types, but you can set @code{org-html-html5-fancy} to
11513 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11514 enable a few new block-level elements. These are created using arbitrary
11515 #+BEGIN and #+END blocks. For instance:
11534 #+ATTR_HTML: :controls controls :width 350
11536 #+HTML: <source src="movie.mp4" type="video/mp4">
11537 #+HTML: <source src="movie.ogg" type="video/ogg">
11538 Your browser does not support the video tag.
11545 <video controls="controls" width="350">
11546 <source src="movie.mp4" type="video/mp4">
11547 <source src="movie.ogg" type="video/ogg">
11548 <p>Your browser does not support the video tag.</p>
11552 Special blocks that do not correspond to HTML5 elements (see
11553 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11554 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11556 Headlines cannot appear within special blocks. To wrap a headline and its
11557 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11558 @code{HTML_CONTAINER} property on the headline itself.
11560 @node HTML preamble and postamble
11561 @subsection HTML preamble and postamble
11562 @vindex org-html-preamble
11563 @vindex org-html-postamble
11564 @vindex org-html-preamble-format
11565 @vindex org-html-postamble-format
11566 @vindex org-html-validation-link
11567 @vindex org-export-creator-string
11568 @vindex org-export-time-stamp-file
11570 The HTML exporter lets you define a preamble and a postamble.
11572 The default value for @code{org-html-preamble} is @code{t}, which means
11573 that the preamble is inserted depending on the relevant format string in
11574 @code{org-html-preamble-format}.
11576 Setting @code{org-html-preamble} to a string will override the default format
11577 string. If you set it to a function, it will insert the output of the
11578 function, which must be a string. Setting to @code{nil} will not insert any
11581 The default value for @code{org-html-postamble} is @code{'auto}, which means
11582 that the HTML exporter will look for information about the author, the email,
11583 the creator and the date, and build the postamble from these values. Setting
11584 @code{org-html-postamble} to @code{t} will insert the postamble from the
11585 relevant format string found in @code{org-html-postamble-format}. Setting it
11586 to @code{nil} will not insert any postamble.
11588 @node Quoting HTML tags
11589 @subsection Quoting HTML tags
11591 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11592 @samp{>} in HTML export. If you want to include raw HTML code, which
11593 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11594 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11595 that should be copied verbatim to the exported file use either
11598 @cindex #+BEGIN_EXPORT html
11600 #+HTML: Literal HTML code for export
11604 @cindex #+BEGIN_EXPORT html
11607 #+BEGIN_EXPORT html
11608 All lines between these markers are exported literally
11613 @node Links in HTML export
11614 @subsection Links in HTML export
11616 @cindex links, in HTML export
11617 @cindex internal links, in HTML export
11618 @cindex external links, in HTML export
11619 @vindex org-html-link-org-files-as-html
11620 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11621 includes automatic links created by radio targets (@pxref{Radio
11622 targets}). Links to external files will still work if the target file is on
11623 the same @i{relative} path as the published Org file. Links to other
11624 @file{.org} files will be translated into HTML links under the assumption
11625 that an HTML version also exists of the linked file, at the same relative
11626 path; setting @code{org-html-link-org-files-as-html} to @code{nil} disables
11627 this translation. @samp{id:} links can then be used to jump to specific
11628 entries across files. For information related to linking files while
11629 publishing them to a publishing directory see @ref{Publishing links}.
11631 If you want to specify attributes for links, you can do so using a special
11632 @code{#+ATTR_HTML} line to define attributes that will be added to the
11633 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11634 and @code{style} attributes for a link:
11636 @cindex #+ATTR_HTML
11638 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11639 [[http://orgmode.org]]
11642 @node Tables in HTML export
11643 @subsection Tables in HTML export
11644 @cindex tables, in HTML
11645 @vindex org-html-table-default-attributes
11647 Org mode tables are exported to HTML using the table attributes defined in
11648 @code{org-html-table-default-attributes}. The default setting makes tables
11649 without cell borders and frame. If you would like to change this for
11650 individual tables, place something like the following before the table:
11653 @cindex #+ATTR_HTML
11655 #+CAPTION: This is a table with lines around and between cells
11656 #+ATTR_HTML: :border 2 :rules all :frame border
11659 You can also group columns in the HTML output (@pxref{Column groups}).
11661 Below is a list of options for customizing tables HTML export.
11664 @vindex org-html-table-align-individual-fields
11665 @item org-html-table-align-individual-fields
11666 Non-@code{nil} means attach style attributes for alignment to each table field.
11668 @vindex org-html-table-caption-above
11669 @item org-html-table-caption-above
11670 When non-@code{nil}, place caption string at the beginning of the table.
11672 @vindex org-html-table-data-tags
11673 @item org-html-table-data-tags
11674 The opening and ending tags for table data fields.
11676 @vindex org-html-table-default-attributes
11677 @item org-html-table-default-attributes
11678 Default attributes and values which will be used in table tags.
11680 @vindex org-html-table-header-tags
11681 @item org-html-table-header-tags
11682 The opening and ending tags for table header fields.
11684 @vindex org-html-table-row-tags
11685 @item org-html-table-row-tags
11686 The opening and ending tags for table rows.
11688 @vindex org-html-table-use-header-tags-for-first-column
11689 @item org-html-table-use-header-tags-for-first-column
11690 Non-@code{nil} means format column one in tables with header tags.
11693 @node Images in HTML export
11694 @subsection Images in HTML export
11696 @cindex images, inline in HTML
11697 @cindex inlining images in HTML
11698 @vindex org-html-inline-images
11699 HTML export can inline images given as links in the Org file, and
11700 it can make an image the clickable part of a link. By
11701 default@footnote{But see the variable
11702 @code{org-html-inline-images}.}, images are inlined if a link does
11703 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11704 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11705 @samp{the image} that points to the image. If the description part
11706 itself is a @code{file:} link or a @code{http:} URL pointing to an
11707 image, this image will be inlined and activated so that clicking on the
11708 image will activate the link. For example, to include a thumbnail that
11709 will link to a high resolution version of the image, you could use:
11712 [[file:highres.jpg][file:thumb.jpg]]
11715 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11716 In the example below we specify the @code{alt} and @code{title} attributes to
11717 support text viewers and accessibility, and align it to the right.
11720 @cindex #+ATTR_HTML
11722 #+CAPTION: A black cat stalking a spider
11723 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11728 You could use @code{http} addresses just as well.
11730 @node Math formatting in HTML export
11731 @subsection Math formatting in HTML export
11735 @cindex imagemagick
11737 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11738 different ways on HTML pages. The default is to use
11739 @uref{http://www.mathjax.org, MathJax} which should work out of the box with
11740 Org@footnote{By default Org loads MathJax from
11741 @uref{http://docs.mathjax.org/en/latest/start.html#using-the-mathjax-content-delivery-network-cdn,
11742 MathJax.org}. A link to the terms of service of the MathJax CDN can be found
11743 in the docstring of @code{org-html-mathjax-options}.}. Some MathJax display
11744 options can be configured via @code{org-html-mathjax-options}, or in the
11745 buffer. For example, with the following settings,
11747 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
11749 equation labels will be displayed on the left marign and equations will be
11750 five ems from the left margin.
11752 @noindent See the docstring of
11753 @code{org-html-mathjax-options} for all supported variables. The MathJax
11754 template can be configure via @code{org-html-mathjax-template}.
11756 If you prefer, you can also request that @LaTeX{} fragments are processed
11757 into small images that will be inserted into the browser page. Before the
11758 availability of MathJax, this was the default method for Org files. This
11759 method requires that the @file{dvipng} program, @file{dvisvgm} or
11760 @file{imagemagick} suite is available on your system. You can still get
11761 this processing with
11764 #+OPTIONS: tex:dvipng
11768 #+OPTIONS: tex:dvisvgm
11774 #+OPTIONS: tex:imagemagick
11777 @node Text areas in HTML export
11778 @subsection Text areas in HTML export
11780 @cindex text areas, in HTML
11781 An alternative way to publish literal code examples in HTML is to use text
11782 areas, where the example can even be edited before pasting it into an
11783 application. It is triggered by @code{:textarea} attribute at an
11784 @code{example} or @code{src} block.
11786 You may also use @code{:height} and @code{:width} attributes to specify the
11787 height and width of the text area, which default to the number of lines in
11788 the example, and 80, respectively. For example
11791 #+ATTR_HTML: :textarea t :width 40
11793 (defun org-xor (a b)
11801 @subsection CSS support
11802 @cindex CSS, for HTML export
11803 @cindex HTML export, CSS
11805 @vindex org-html-todo-kwd-class-prefix
11806 @vindex org-html-tag-class-prefix
11807 You can modify the CSS style definitions for the exported file. The HTML
11808 exporter assigns the following special CSS classes@footnote{If the classes on
11809 TODO keywords and tags lead to conflicts, use the variables
11810 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11811 make them unique.} to appropriate parts of the document---your style
11812 specifications may change these, in addition to any of the standard classes
11813 like for headlines, tables, etc.
11815 p.author @r{author information, including email}
11816 p.date @r{publishing date}
11817 p.creator @r{creator info, about org mode version}
11818 .title @r{document title}
11819 .subtitle @r{document subtitle}
11820 .todo @r{TODO keywords, all not-done states}
11821 .done @r{the DONE keywords, all states that count as done}
11822 .WAITING @r{each TODO keyword also uses a class named after itself}
11823 .timestamp @r{timestamp}
11824 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11825 .timestamp-wrapper @r{span around keyword plus timestamp}
11826 .tag @r{tag in a headline}
11827 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11828 .target @r{target for links}
11829 .linenr @r{the line number in a code example}
11830 .code-highlighted @r{for highlighting referenced code lines}
11831 div.outline-N @r{div for outline level N (headline plus text))}
11832 div.outline-text-N @r{extra div for text at outline level N}
11833 .section-number-N @r{section number in headlines, different for each level}
11834 .figure-number @r{label like "Figure 1:"}
11835 .table-number @r{label like "Table 1:"}
11836 .listing-number @r{label like "Listing 1:"}
11837 div.figure @r{how to format an inlined image}
11838 pre.src @r{formatted source code}
11839 pre.example @r{normal example}
11840 p.verse @r{verse paragraph}
11841 div.footnotes @r{footnote section headline}
11842 p.footnote @r{footnote definition paragraph, containing a footnote}
11843 .footref @r{a footnote reference number (always a <sup>)}
11844 .footnum @r{footnote number in footnote definition (always <sup>)}
11847 @vindex org-html-style-default
11848 @vindex org-html-head-include-default-style
11849 @vindex org-html-head
11850 @vindex org-html-head-extra
11851 @cindex #+HTML_INCLUDE_STYLE
11852 Each exported file contains a compact default style that defines these
11853 classes in a basic way@footnote{This style is defined in the constant
11854 @code{org-html-style-default}, which you should not modify. To turn
11855 inclusion of these defaults off, customize
11856 @code{org-html-head-include-default-style} or set @code{html-style} to
11857 @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or
11858 add to them by using the variables @code{org-html-head} and
11859 @code{org-html-head-extra}. You can override the global values of these
11860 variables for each file by using these keywords:
11862 @cindex #+HTML_HEAD
11863 @cindex #+HTML_HEAD_EXTRA
11865 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11866 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11870 For longer style definitions, you can use several such lines. You could also
11871 directly write a @code{<style>} @code{</style>} section in this way, without
11872 referring to an external file.
11874 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11875 property to assign a class to the tree. In order to specify CSS styles for a
11876 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11879 @c FIXME: More about header and footer styles
11880 @c FIXME: Talk about links and targets.
11882 @node JavaScript support
11883 @subsection JavaScript supported display of web pages
11885 @cindex Rose, Sebastian
11886 Sebastian Rose has written a JavaScript program especially designed to
11887 enhance the web viewing experience of HTML files created with Org. This
11888 program allows you to view large files in two different ways. The first one
11889 is an @emph{Info}-like mode where each section is displayed separately and
11890 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11891 as well, press @kbd{?} for an overview of the available keys). The second
11892 view type is a @emph{folding} view much like Org provides inside Emacs. The
11893 script is available at @url{http://orgmode.org/org-info.js} and you can find
11894 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11895 We host the script at our site, but if you use it a lot, you might not want
11896 to be dependent on @url{http://orgmode.org} and prefer to install a local
11897 copy on your own web server.
11899 All it then takes to use this program is adding a single line to the Org
11902 @cindex #+INFOJS_OPT
11904 #+INFOJS_OPT: view:info toc:nil
11908 If this line is found, the HTML header will automatically contain the code
11909 needed to invoke the script. Using the line above, you can set the following
11913 path: @r{The path to the script. The default is to grab the script from}
11914 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11915 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11916 view: @r{Initial view when the website is first shown. Possible values are:}
11917 info @r{Info-like interface with one section per page.}
11918 overview @r{Folding interface, initially showing only top-level.}
11919 content @r{Folding interface, starting with all headlines visible.}
11920 showall @r{Folding interface, all headlines and text visible.}
11921 sdepth: @r{Maximum headline level that will still become an independent}
11922 @r{section for info and folding modes. The default is taken from}
11923 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11924 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11925 @r{info/folding section can still contain child headlines.}
11926 toc: @r{Should the table of contents @emph{initially} be visible?}
11927 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11928 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11929 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11930 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11931 @r{If yes, the toc will never be displayed as a section.}
11932 ltoc: @r{Should there be short contents (children) in each section?}
11933 @r{Make this @code{above} if the section should be above initial text.}
11934 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11935 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11936 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11937 @r{default), only one such button will be present.}
11940 @vindex org-html-infojs-options
11941 @vindex org-html-use-infojs
11942 You can choose default values for these options by customizing the variable
11943 @code{org-html-infojs-options}. If you always want to apply the script to your
11944 pages, configure the variable @code{org-html-use-infojs}.
11946 @node @LaTeX{} and PDF export
11947 @section @LaTeX{} and PDF export
11948 @cindex @LaTeX{} export
11951 The @LaTeX{} exporter can produce an arbitrarily complex @LaTeX{} document of
11952 any standard or custom document class@footnote{The @LaTeX{} exporter can be
11953 configured to support alternative @LaTeX{} engines (see
11954 @code{org-latex-compiler}), build sequences (see
11955 @code{org-latex-pdf-process}), and packages, (see
11956 @code{org-latex-default-packages-alist} and
11957 @code{org-latex-packages-alist}).}. The Org @LaTeX{} exporter is geared
11958 towards producing fully-linked PDF output.
11960 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11961 will not be started if two contiguous syntactical elements are not separated
11964 This back-end also offers enhanced support for footnotes. Thus, it handles
11965 nested footnotes, footnotes in tables and footnotes in a list item's
11969 * @LaTeX{} export commands:: How to export to LaTeX and PDF
11970 * @LaTeX{} specific export settings:: Export settings for @LaTeX{}
11971 * Header and sectioning:: Setting up the export file structure
11972 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11973 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
11976 @node @LaTeX{} export commands
11977 @subsection @LaTeX{} export commands
11980 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11981 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11982 file will be @file{myfile.tex}. The file will be overwritten without
11984 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11985 Export to a temporary buffer. Do not create a file.
11986 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11987 Export as @LaTeX{} and then process to PDF.
11989 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11992 @vindex org-latex-compiler
11993 @vindex org-latex-bibtex-compiler
11994 @vindex org-latex-default-packages-alist
11995 The exporter supports several @LaTeX{} engines, namely @samp{pdflatex},
11996 @samp{xelatex} and @samp{lualatex}. The default @LaTeX{} compiler can be set
11997 via @code{org-latex-compiler} or the @code{#+LATEX_COMPILER} keyword. It is
11998 possible to only load some packages with certain compilers (see the docstring
11999 of @code{org-latex-default-packages-alist}). The bibliography compiler may
12000 also be set via @code{org-latex-bibtex-compiler}@footnote{You cannot set the
12001 bibliography compiler on a file basis via a keyword. However, ``smart''
12002 @LaTeX{} compilation systems, such as @samp{latexmk}, are usually able to
12003 select the correct bibliography compiler.}.
12005 @node @LaTeX{} specific export settings
12006 @subsection @LaTeX{} specific export settings
12007 The @LaTeX{} exporter introduces a number of keywords, similar to the general
12008 options settings described in @ref{Export settings}.
12012 @cindex #+DESCRIPTION (@LaTeX{})
12013 The document description. By default these are inserted as metadata using
12014 @samp{hyperref}. Document metadata can be configured via
12015 @code{org-latex-hyperref-template}. Description can also be typeset as part
12016 of the front matter via @code{org-latex-title-command}. You can use several
12017 @code{#+DESCRIPTION} keywords if the description is is long.
12020 @cindex #+LATEX_CLASS
12021 @vindex org-latex-default-class
12022 @vindex org-latex-classes
12023 The predefined preamble and headline level mapping to use
12024 (@code{org-latex-default-class}). Must be an element in
12025 @code{org-latex-classes}.
12027 @item LATEX_CLASS_OPTIONS
12028 @cindex #+LATEX_CLASS_OPTIONS
12029 Options given to the @LaTeX{} document class.
12031 @item LATEX_COMPILER
12032 @cindex #+LATEX_COMPILER
12033 @vindex org-latex-compiler
12034 The compiler used to produce the PDF (@code{org-latex-compiler}).
12037 @cindex #+LATEX_HEADER
12038 @vindex org-latex-classes
12039 Arbitrary lines added to the preamble of the document, before the
12040 @samp{hyperref} settings. The location can be controlled via
12041 @code{org-latex-classes}.
12043 @item LATEX_HEADER_EXTRA
12044 @cindex #+LATEX_HEADER_EXTRA
12045 @vindex org-latex-classes
12046 Arbitrary lines added to the preamble of the document, before the
12047 @samp{hyperref} settings. The location can be controlled via
12048 @code{org-latex-classes}.
12051 @cindex #+KEYWORDS (@LaTeX{})
12052 The keywords defining the contents of the document. By default these are
12053 inserted as metadata using @samp{hyperref}. Document metadata can be
12054 configured via @code{org-latex-hyperref-template}. Description can also be
12055 typeset as part of the front matter via @code{org-latex-title-command}. You
12056 can use several @code{#+KEYWORDS} if the description is is long.
12059 @cindex #+SUBTITLE (@LaTeX{})
12060 @vindex org-latex-subtitle-separate
12061 @vindex org-latex-subtitle-format
12062 The document subtitle. This is typeset according to
12063 @code{org-latex-subtitle-format}. If @code{org-latex-subtitle-separate}
12064 is non-@code{nil} it is typed as part of the @samp{\title}-macro. It
12065 can also access via @code{org-latex-hyperref-template} or typeset as
12066 part of the front matter via @code{org-latex-title-command}.
12069 These keywords are treated in details in the following sections.
12071 @node Header and sectioning
12072 @subsection Header and sectioning structure
12073 @cindex @LaTeX{} class
12074 @cindex @LaTeX{} sectioning structure
12075 @cindex @LaTeX{} header
12076 @cindex header, for @LaTeX{} files
12077 @cindex sectioning structure, for @LaTeX{} export
12079 By default, the first three outline levels become headlines, defining a
12080 general document structure. Additional levels are exported as @code{itemize}
12081 or @code{enumerate} lists. The transition can also occur at a different
12082 level (@pxref{Export settings}).
12084 By default, the @LaTeX{} output uses the class @code{article}.
12086 @vindex org-latex-default-class
12087 @vindex org-latex-classes
12088 @vindex org-latex-default-packages-alist
12089 @vindex org-latex-packages-alist
12090 You can change this globally by setting a different value for
12091 @code{org-latex-default-class} or locally by adding an option like
12092 @code{#+LATEX_CLASS: myclass} in your file, or with
12093 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
12094 containing only this (sub)tree. The class must be listed in
12095 @code{org-latex-classes}. This variable defines a header template for each
12096 class@footnote{Into which the values of
12097 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
12098 are spliced.}, and allows you to define the sectioning structure for each
12099 class. You can also define your own classes there.
12101 @cindex #+LATEX_CLASS
12102 @cindex #+LATEX_CLASS_OPTIONS
12103 @cindex property, EXPORT_LATEX_CLASS
12104 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
12105 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
12106 property can specify the options for the @code{\documentclass} macro. These
12107 options have to be provided, as expected by @LaTeX{}, within square brackets.
12109 @cindex #+LATEX_HEADER
12110 @cindex #+LATEX_HEADER_EXTRA
12111 You can also use the @code{LATEX_HEADER} and
12112 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
12113 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
12114 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
12115 to add lines to the header. See the docstring of @code{org-latex-classes} for
12118 An example is shown below.
12121 #+LATEX_CLASS: article
12122 #+LATEX_CLASS_OPTIONS: [a4paper]
12123 #+LATEX_HEADER: \usepackage@{xyz@}
12129 @node Quoting @LaTeX{} code
12130 @subsection Quoting @LaTeX{} code
12132 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
12133 inserted into the @LaTeX{} file. Furthermore, you can add special code that
12134 should only be present in @LaTeX{} export with the following constructs:
12137 @cindex #+BEGIN_EXPORT latex
12139 Code within @@@@latex:some code@@@@ a paragraph.
12141 #+LATEX: Literal @LaTeX{} code for export
12143 #+BEGIN_EXPORT latex
12144 All lines between these markers are exported literally
12148 @node @LaTeX{} specific attributes
12149 @subsection @LaTeX{} specific attributes
12150 @cindex #+ATTR_LATEX
12152 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
12153 affect tables, images, plain lists, source blocks, example blocks and special
12156 @subsubheading Tables in @LaTeX{} export
12157 @cindex tables, in @LaTeX{} export
12159 For @LaTeX{} export of a table, you can specify a label and a caption
12160 (@pxref{Images and tables}). You can also use attributes to control table
12161 layout and contents. Valid @LaTeX{} attributes include:
12165 @vindex org-latex-default-table-mode
12166 Nature of table's contents. It can be set to @code{table}, @code{math},
12167 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
12168 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
12169 ignored and the table will be wrapped in a math environment. Also,
12170 contiguous tables sharing the same math mode will be wrapped within the same
12171 environment. Default mode is determined in
12172 @code{org-latex-default-table-mode}.
12174 @vindex org-latex-default-table-environment
12175 Environment used for the table. It can be set to any @LaTeX{} table
12176 environment, like @code{tabularx}@footnote{Requires adding the
12177 @code{tabularx} package to @code{org-latex-packages-alist}.},
12178 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
12179 @code{tabu} package to @code{org-latex-packages-alist}.},
12180 @code{bmatrix}@enddots{} It defaults to
12181 @code{org-latex-default-table-environment} value.
12183 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
12184 (@pxref{Images and tables}). If you need more advanced commands for that
12185 task, you can use @code{:caption} attribute instead. Its value should be raw
12186 @LaTeX{} code. It has precedence over @code{#+CAPTION}.
12189 The @code{:float} specifies the float environment for the table. Possible
12190 values are @code{sideways}@footnote{Formerly, the value was
12191 @code{sidewaystable}. This is deprecated since Org 8.3.},
12192 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
12193 a caption will have a @code{table} environment. Moreover, the
12194 @code{:placement} attribute can specify the positioning of the float. Note:
12195 @code{:placement} is ignored for @code{:float sideways} tables.
12199 Set, respectively, the alignment string of the table, its font size and its
12200 width. They only apply on regular tables.
12202 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
12203 only takes effect when used in conjunction with the @code{:width} attribute.
12204 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
12205 value of @code{:width}.
12209 @vindex org-latex-tables-booktabs
12210 @vindex org-latex-tables-centered
12211 They toggle, respectively, @code{booktabs} usage (assuming the package is
12212 properly loaded), table centering and removal of every horizontal rule but
12213 the first one (in a "table.el" table only). In particular,
12214 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
12215 activates the first (respectively second) attribute globally.
12217 @itemx :math-suffix
12218 @itemx :math-arguments
12219 A string that will be inserted, respectively, before the table within the
12220 math environment, after the table within the math environment, and between
12221 the macro name and the contents of the table. The @code{:math-arguments}
12222 attribute is used for matrix macros that require more than one argument
12223 (e.g., @code{qbordermatrix}).
12226 Thus, attributes can be used in a wide array of situations, like writing
12227 a table that will span over multiple pages, or a matrix product:
12230 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
12234 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
12237 #+ATTR_LATEX: :mode math :environment bmatrix
12242 In the example below, @LaTeX{} command
12243 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
12246 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12252 @subsubheading Images in @LaTeX{} export
12253 @cindex images, inline in @LaTeX{}
12254 @cindex inlining images in @LaTeX{}
12256 Images that are linked to without a description part in the link, like
12257 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
12258 output file resulting from @LaTeX{} processing. Org will use an
12259 @code{\includegraphics} macro to insert the image@footnote{In the case of
12260 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
12261 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
12263 You can specify image width or height with, respectively, @code{:width} and
12264 @code{:height} attributes. It is also possible to add any other option with
12265 the @code{:options} attribute, as shown in the following example:
12268 #+ATTR_LATEX: :width 5cm :options angle=90
12269 [[./img/sed-hr4049.pdf]]
12272 If you need a specific command for the caption, use @code{:caption}
12273 attribute. It will override standard @code{#+CAPTION} value, if any.
12276 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12277 [[./img/sed-hr4049.pdf]]
12280 If you have specified a caption as described in @ref{Images and tables}, the
12281 picture will be wrapped into a @code{figure} environment and thus become
12282 a floating element. You can also ask Org to export an image as a float
12283 without specifying caption by setting the @code{:float} attribute. You may
12287 @code{t}: if you want to use the standard @samp{figure} environment. It is
12288 used by default if you provide a caption to the image.
12290 @code{multicolumn}: if you wish to include an image which spans multiple
12291 columns in a page. This will export the image wrapped in a @code{figure*}
12294 @code{wrap}: if you would like to let text flow around the image. It will
12295 make the figure occupy the left half of the page.
12297 @code{sideways}: if you would like the image to appear alone on a separate
12298 page rotated ninety degrees using the @code{sidewaysfigure}
12299 environment. Setting this @code{:float} option will ignore the
12300 @code{:placement} setting.
12302 @code{nil}: if you need to avoid any floating environment, even when
12303 a caption is provided.
12306 To modify the placement option of any floating environment, set the
12307 @code{placement} attribute.
12310 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
12314 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
12315 the @LaTeX{} @code{\includegraphics} macro will be commented out.
12317 @subsubheading Plain lists in @LaTeX{} export
12318 @cindex plain lists, in @LaTeX{} export
12320 Plain lists accept two optional attributes: @code{:environment} and
12321 @code{:options}. The first can be used to specify the environment. The
12322 second can be used to specifies additional arguments to the environment.
12323 Both attributes are illustrated in the following example:
12326 #+LATEX_HEADER: \usepackage[inline]@{enumitem@}
12327 Some ways to say "Hello":
12328 #+ATTR_LATEX: :environment itemize*
12329 #+ATTR_LATEX: :options [label=@{@}, itemjoin=@{,@}, itemjoin*=@{, and@}]
12335 By default, @LaTeX{} only supports four levels of nesting for lists. If
12336 deeper nesting is needed, the @samp{enumitem} @LaTeX{} package can be
12337 employed, as shown in this example:
12340 #+LATEX_HEADER: \usepackage@{enumitem@}
12341 #+LATEX_HEADER: \renewlist@{itemize@}@{itemize@}@{9@}
12342 #+LATEX_HEADER: \setlist[itemize]@{label=$\circ$@}
12350 @subsubheading Source blocks in @LaTeX{} export
12351 @cindex source blocks, in @LaTeX{} export
12353 In addition to syntax defined in @ref{Literal examples}, names and captions
12354 (@pxref{Images and tables}), source blocks also accept two additional
12355 attributes: @code{:float} and @code{:options}.
12357 You may set the former to
12360 @code{t}: if you want to make the source block a float. It is the default
12361 value when a caption is provided.
12363 @code{multicolumn}: if you wish to include a source block which spans multiple
12366 @code{nil}: if you need to avoid any floating environment, even when a caption
12367 is provided. It is useful for source code that may not fit in a single page.
12371 #+ATTR_LATEX: :float nil
12372 #+BEGIN_SRC emacs-lisp
12373 Code that may not fit in a single page.
12377 @vindex org-latex-listings-options
12378 @vindex org-latex-minted-options
12379 The latter allows to specify options relative to the package used to
12380 highlight code in the output (e.g., @code{listings}). This is the local
12381 counterpart to @code{org-latex-listings-options} and
12382 @code{org-latex-minted-options} variables, which see.
12385 #+ATTR_LATEX: :options commentstyle=\bfseries
12386 #+BEGIN_SRC emacs-lisp
12387 (defun Fib (n) ; Count rabbits.
12388 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
12392 @subsubheading Example blocks in @LaTeX{} export
12393 @cindex example blocks, in @LaTeX{} export
12394 @cindex verbatim blocks, in @LaTeX{} export
12396 By default, when exporting to @LaTeX{}, example blocks contents are wrapped
12397 in a @samp{verbatim} environment. It is possible to use a different
12398 environment globally using an appropriate export filter (@pxref{Advanced
12399 configuration}). You can also change this per block using
12400 @code{:environment} parameter.
12403 #+ATTR_LATEX: :environment myverbatim
12405 This sentence is false.
12409 @subsubheading Special blocks in @LaTeX{} export
12410 @cindex special blocks, in @LaTeX{} export
12411 @cindex abstract, in @LaTeX{} export
12412 @cindex proof, in @LaTeX{} export
12414 In @LaTeX{} back-end, special blocks become environments of the same name.
12415 Value of @code{:options} attribute will be appended as-is to that
12416 environment's opening string. For example:
12420 We demonstrate how to solve the Syracuse problem.
12423 #+ATTR_LATEX: :options [Proof of important theorem]
12426 Therefore, any even number greater than 2 is the sum of two primes.
12435 We demonstrate how to solve the Syracuse problem.
12438 \begin@{proof@}[Proof of important theorem]
12440 Therefore, any even number greater than 2 is the sum of two primes.
12444 If you need to insert a specific caption command, use @code{:caption}
12445 attribute. It will override standard @code{#+CAPTION} value, if any. For
12449 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12455 @subsubheading Horizontal rules
12456 @cindex horizontal rules, in @LaTeX{} export
12458 Width and thickness of a given horizontal rule can be controlled with,
12459 respectively, @code{:width} and @code{:thickness} attributes:
12462 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12466 @node Markdown export
12467 @section Markdown export
12468 @cindex Markdown export
12470 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12471 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12474 It is built over HTML back-end: any construct not supported by Markdown
12475 syntax (e.g., tables) will be controlled and translated by @code{html}
12476 back-end (@pxref{HTML export}).
12478 @subheading Markdown export commands
12481 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12482 Export as a text file written in Markdown syntax. For an Org file,
12483 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
12484 will be overwritten without warning.
12485 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12486 Export to a temporary buffer. Do not create a file.
12488 Export as a text file with Markdown syntax, then open it.
12491 @subheading Header and sectioning structure
12493 @vindex org-md-headline-style
12494 Markdown export can generate both @code{atx} and @code{setext} types for
12495 headlines, according to @code{org-md-headline-style}. The former introduces
12496 a hard limit of two levels, whereas the latter pushes it to six. Headlines
12497 below that limit are exported as lists. You can also set a soft limit before
12498 that one (@pxref{Export settings}).
12500 @c begin opendocument
12502 @node OpenDocument Text export
12503 @section OpenDocument Text export
12505 @cindex OpenDocument
12506 @cindex export, OpenDocument
12507 @cindex LibreOffice
12509 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12510 (ODT) format. Documents created by this exporter use the
12511 @cite{OpenDocument-v1.2
12512 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12513 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12514 are compatible with LibreOffice 3.4.
12517 * Pre-requisites for ODT export:: What packages ODT exporter relies on
12518 * ODT export commands:: How to invoke ODT export
12519 * ODT specific export settings:: Export settings for ODT
12520 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
12521 * Applying custom styles:: How to apply custom styles to the output
12522 * Links in ODT export:: How links will be interpreted and formatted
12523 * Tables in ODT export:: How Tables are exported
12524 * Images in ODT export:: How to insert images
12525 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
12526 * Labels and captions in ODT export:: How captions are rendered
12527 * Literal examples in ODT export:: How source and example blocks are formatted
12528 * Advanced topics in ODT export:: Read this if you are a power user
12531 @node Pre-requisites for ODT export
12532 @subsection Pre-requisites for ODT export
12534 The ODT exporter relies on the @file{zip} program to create the final
12535 output. Check the availability of this program before proceeding further.
12537 @node ODT export commands
12538 @subsection ODT export commands
12539 @anchor{x-export-to-odt}
12540 @cindex region, active
12541 @cindex active region
12542 @cindex transient-mark-mode
12544 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12545 @cindex property EXPORT_FILE_NAME
12547 Export as OpenDocument Text file.
12549 @vindex org-odt-preferred-output-format
12550 If @code{org-odt-preferred-output-format} is specified, automatically convert
12551 the exported file to that format. @xref{x-export-to-other-formats, ,
12552 Automatically exporting to other formats}.
12554 For an Org file @file{myfile.org}, the ODT file will be
12555 @file{myfile.odt}. The file will be overwritten without warning. If there
12556 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12557 turned on} only the region will be exported. If the selected region is a
12558 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12559 tree head will become the document title. If the tree head entry has, or
12560 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12564 Export as an OpenDocument Text file and open the resulting file.
12566 @vindex org-odt-preferred-output-format
12567 If @code{org-odt-preferred-output-format} is specified, open the converted
12568 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
12572 @node ODT specific export settings
12573 @subsection ODT specific export settings
12574 The ODT exporter introduces a number of keywords, similar to the general
12575 options settings described in @ref{Export settings}.
12579 @cindex #+DESCRIPTION (ODT)
12580 The document description. These are inserted as document metadata. You can
12581 use several such keywords if the list is long.
12584 @cindex #+KEYWORDS (ODT)
12585 The keywords defining the contents of the document. These are inserted as
12586 document metadata. You can use several such keywords if the list is long.
12588 @item ODT_STYLES_FILE
12589 @cindex ODT_STYLES_FILE
12590 @vindex org-odt-styles-file
12591 The style file of the document (@code{org-odt-styles-file}). See
12592 @ref{Applying custom styles} for details.
12595 @cindex SUBTITLE (ODT)
12596 The document subtitle.
12599 @node Extending ODT export
12600 @subsection Extending ODT export
12602 The ODT exporter can interface with a variety of document
12603 converters and supports popular converters out of the box. As a result, you
12604 can use it to export to formats like @samp{doc} or convert a document from
12605 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12607 @cindex @file{unoconv}
12608 @cindex LibreOffice
12609 If you have a working installation of LibreOffice, a document converter is
12610 pre-configured for you and you can use it right away. If you would like to
12611 use @file{unoconv} as your preferred converter, customize the variable
12612 @code{org-odt-convert-process} to point to @code{unoconv}. You can
12613 also use your own favorite converter or tweak the default settings of the
12614 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
12615 document converter}.
12617 @subsubheading Automatically exporting to other formats
12618 @anchor{x-export-to-other-formats}
12620 @vindex org-odt-preferred-output-format
12621 Very often, you will find yourself exporting to ODT format, only to
12622 immediately save the exported document to other formats like @samp{doc},
12623 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
12624 preferred output format by customizing the variable
12625 @code{org-odt-preferred-output-format}. This way, the export commands
12626 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12627 format that is of immediate interest to you.
12629 @subsubheading Converting between document formats
12630 @anchor{x-convert-to-other-formats}
12632 There are many document converters in the wild which support conversion to
12633 and from various file formats, including, but not limited to the
12634 ODT format. LibreOffice converter, mentioned above, is one such
12635 converter. Once a converter is configured, you can interact with it using
12636 the following command.
12638 @vindex org-odt-convert
12641 @item M-x org-odt-convert RET
12642 Convert an existing document from one format to another. With a prefix
12643 argument, also open the newly produced file.
12646 @node Applying custom styles
12647 @subsection Applying custom styles
12648 @cindex styles, custom
12649 @cindex template, custom
12651 The ODT exporter ships with a set of OpenDocument styles
12652 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12653 output. These factory styles, however, may not cater to your specific
12654 tastes. To customize the output, you can either modify the above styles
12655 files directly, or generate the required styles using an application like
12656 LibreOffice. The latter method is suitable for expert and non-expert
12657 users alike, and is described here.
12659 @subsubheading Applying custom styles: the easy way
12663 Create a sample @file{example.org} file with the below settings and export it
12667 #+OPTIONS: H:10 num:t
12671 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
12672 to locate the target styles---these typically have the @samp{Org} prefix---and
12673 modify those to your taste. Save the modified file either as an
12674 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12677 @cindex #+ODT_STYLES_FILE
12678 @vindex org-odt-styles-file
12679 Customize the variable @code{org-odt-styles-file} and point it to the
12680 newly created file. For additional configuration options
12681 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12683 If you would like to choose a style on a per-file basis, you can use the
12684 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
12687 #+ODT_STYLES_FILE: "/path/to/example.ott"
12693 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12698 @subsubheading Using third-party styles and templates
12700 You can use third-party styles and templates for customizing your output.
12701 This will produce the desired output only if the template provides all
12702 style names that the @samp{ODT} exporter relies on. Unless this condition is
12703 met, the output is going to be less than satisfactory. So it is highly
12704 recommended that you only work with templates that are directly derived from
12705 the factory settings.
12707 @node Links in ODT export
12708 @subsection Links in ODT export
12709 @cindex links, in ODT export
12711 ODT exporter creates native cross-references for internal links. It creates
12712 Internet-style links for all other links.
12714 A link with no description and destined to a regular (un-itemized) outline
12715 heading is replaced with a cross-reference and section number of the heading.
12717 A @samp{\ref@{label@}}-style reference to an image, table etc.@: is replaced
12718 with a cross-reference and sequence number of the labeled entity.
12719 @xref{Labels and captions in ODT export}.
12721 @node Tables in ODT export
12722 @subsection Tables in ODT export
12723 @cindex tables, in ODT export
12725 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12726 tables is supported. However, export of complex @file{table.el} tables---tables
12727 that have column or row spans---is not supported. Such tables are
12728 stripped from the exported document.
12730 By default, a table is exported with top and bottom frames and with rules
12731 separating row and column groups (@pxref{Column groups}). Furthermore, all
12732 tables are typeset to occupy the same width. If the table specifies
12733 alignment and relative width for its columns (@pxref{Column width and
12734 alignment}) then these are honored on export.@footnote{The column widths are
12735 interpreted as weighted ratios with the default weight being 1}
12738 You can control the width of the table by specifying @code{:rel-width}
12739 property using an @code{#+ATTR_ODT} line.
12741 For example, consider the following table which makes use of all the rules
12745 #+ATTR_ODT: :rel-width 50
12746 | Area/Month | Jan | Feb | Mar | Sum |
12747 |---------------+-------+-------+-------+-------|
12749 | <l13> | <r5> | <r5> | <r5> | <r6> |
12750 | North America | 1 | 21 | 926 | 948 |
12751 | Middle East | 6 | 75 | 844 | 925 |
12752 | Asia Pacific | 9 | 27 | 790 | 826 |
12753 |---------------+-------+-------+-------+-------|
12754 | Sum | 16 | 123 | 2560 | 2699 |
12757 On export, the table will occupy 50% of text area. The columns will be sized
12758 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12759 and rest of the columns will be right-aligned. There will be vertical rules
12760 after separating the header and last columns from other columns. There will
12761 be horizontal rules separating the header and last rows from other rows.
12763 If you are not satisfied with the above formatting options, you can create
12764 custom table styles and associate them with a table using the
12765 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12767 @node Images in ODT export
12768 @subsection Images in ODT export
12769 @cindex images, embedding in ODT
12770 @cindex embedding images in ODT
12772 @subsubheading Embedding images
12773 You can embed images within the exported document by providing a link to the
12774 desired image file with no link description. For example, to embed
12775 @samp{img.png} do either of the following:
12785 @subsubheading Embedding clickable images
12786 You can create clickable images by providing a link whose description is a
12787 link to an image file. For example, to embed a image
12788 @file{org-mode-unicorn.png} which when clicked jumps to
12789 @uref{http://Orgmode.org} website, do the following
12792 [[http://orgmode.org][./org-mode-unicorn.png]]
12795 @subsubheading Sizing and scaling of embedded images
12798 You can control the size and scale of the embedded images using the
12799 @code{#+ATTR_ODT} attribute.
12801 @cindex identify, ImageMagick
12802 @vindex org-odt-pixels-per-inch
12803 The exporter specifies the desired size of the image in the final document in
12804 units of centimeters. In order to scale the embedded images, the exporter
12805 queries for pixel dimensions of the images using one of a) ImageMagick's
12806 @file{identify} program or b) Emacs @code{create-image} and @code{image-size}
12807 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12808 routinely produce documents that have large images or you export your Org
12809 files that has images using a Emacs batch script, then the use of
12810 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12811 converted in to units of centimeters using
12812 @code{org-odt-pixels-per-inch}. The default value of this variable is
12813 set to @code{display-pixels-per-inch}. You can tweak this variable to
12814 achieve the best results.
12816 The examples below illustrate the various possibilities.
12819 @item Explicitly size the image
12820 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12823 #+ATTR_ODT: :width 10 :height 10
12827 @item Scale the image
12828 To embed @file{img.png} at half its size, do the following:
12831 #+ATTR_ODT: :scale 0.5
12835 @item Scale the image to a specific width
12836 To embed @file{img.png} with a width of 10 cm while retaining the original
12837 height:width ratio, do the following:
12840 #+ATTR_ODT: :width 10
12844 @item Scale the image to a specific height
12845 To embed @file{img.png} with a height of 10 cm while retaining the original
12846 height:width ratio, do the following
12849 #+ATTR_ODT: :height 10
12854 @subsubheading Anchoring of images
12857 You can control the manner in which an image is anchored by setting the
12858 @code{:anchor} property of its @code{#+ATTR_ODT} line. You can specify one
12859 of the following three values for the @code{:anchor} property:
12860 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12862 To create an image that is anchored to a page, do the following:
12864 #+ATTR_ODT: :anchor "page"
12868 @node Math formatting in ODT export
12869 @subsection Math formatting in ODT export
12871 The ODT exporter has special support for handling math.
12874 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12875 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12878 @node Working with @LaTeX{} math snippets
12879 @subsubheading Working with @LaTeX{} math snippets
12881 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12882 document in one of the following ways:
12888 This option is activated on a per-file basis with
12894 With this option, @LaTeX{} fragments are first converted into MathML
12895 fragments using an external @LaTeX{}-to-MathML converter program. The
12896 resulting MathML fragments are then embedded as an OpenDocument Formula in
12897 the exported document.
12899 @vindex org-latex-to-mathml-convert-command
12900 @vindex org-latex-to-mathml-jar-file
12902 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12903 @code{org-latex-to-mathml-convert-command} and
12904 @code{org-latex-to-mathml-jar-file}.
12906 To use MathToWeb@footnote{See
12907 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}.} as your
12908 converter, you can configure the above variables as
12911 (setq org-latex-to-mathml-convert-command
12912 "java -jar %j -unicode -force -df %o %I"
12913 org-latex-to-mathml-jar-file
12914 "/path/to/mathtoweb.jar")
12916 To use @LaTeX{}ML@footnote{See @uref{http://dlmf.nist.gov/LaTeXML/}.} use
12918 (setq org-latex-to-mathml-convert-command
12919 "latexmlmath \"%i\" --presentationmathml=%o")
12922 You can use the following commands to quickly verify the reliability of
12923 the @LaTeX{}-to-MathML converter.
12926 @item M-x org-odt-export-as-odf RET
12927 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12929 @item M-x org-odt-export-as-odf-and-open RET
12930 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12931 and open the formula file with the system-registered application.
12936 @cindex imagemagick
12939 This option is activated on a per-file basis with
12942 #+OPTIONS: tex:dvipng
12946 #+OPTIONS: tex:dvisvgm
12952 #+OPTIONS: tex:imagemagick
12955 With this option, @LaTeX{} fragments are processed into PNG or SVG images and
12956 the resulting images are embedded in the exported document. This method requires
12957 that the @file{dvipng} program, @file{dvisvgm} or @file{imagemagick} suite be
12958 available on your system.
12961 @node Working with MathML or OpenDocument formula files
12962 @subsubheading Working with MathML or OpenDocument formula files
12964 For various reasons, you may find embedding @LaTeX{} math snippets in an
12965 ODT document less than reliable. In that case, you can embed a
12966 math equation by linking to its MathML (@file{.mml}) source or its
12967 OpenDocument formula (@file{.odf}) file as shown below:
12979 @node Labels and captions in ODT export
12980 @subsection Labels and captions in ODT export
12982 You can label and caption various category of objects---an inline image, a
12983 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12984 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12985 each labeled or captioned object of a given category separately. As a
12986 result, each such object is assigned a sequence number based on order of its
12987 appearance in the Org file.
12989 In the exported document, a user-provided caption is augmented with the
12990 category and sequence number. Consider the following inline image in an Org
12994 #+CAPTION: Bell curve
12995 #+LABEL: fig:SED-HR4049
12999 It could be rendered as shown below in the exported document.
13002 Figure 2: Bell curve
13005 @vindex org-odt-category-map-alist
13006 You can modify the category component of the caption by customizing the
13007 option @code{org-odt-category-map-alist}. For example, to tag all embedded
13008 images with the string @samp{Illustration} (instead of the default
13009 @samp{Figure}) use the following setting:
13012 (setq org-odt-category-map-alist
13013 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
13016 With this, previous image will be captioned as below in the exported
13020 Illustration 2: Bell curve
13023 @node Literal examples in ODT export
13024 @subsection Literal examples in ODT export
13026 Export of literal examples (@pxref{Literal examples}) with full fontification
13027 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
13028 generate all style definitions needed for a fancy listing.@footnote{Your
13029 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
13030 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
13031 as prefix and inherit their color from the faces used by Emacs
13032 @code{font-lock} library for the source language.
13034 @vindex org-odt-fontify-srcblocks
13035 If you prefer to use your own custom styles for fontification, you can do
13036 so by customizing the option
13037 @code{org-odt-create-custom-styles-for-srcblocks}.
13039 @vindex org-odt-create-custom-styles-for-srcblocks
13040 You can turn off fontification of literal examples by customizing the
13041 option @code{org-odt-fontify-srcblocks}.
13043 @node Advanced topics in ODT export
13044 @subsection Advanced topics in ODT export
13046 If you rely heavily on ODT export, you may want to exploit the full
13047 set of features that the exporter offers. This section describes features
13048 that would be of interest to power users.
13051 * Configuring a document converter:: How to register a document converter
13052 * Working with OpenDocument style files:: Explore the internals
13053 * Creating one-off styles:: How to produce custom highlighting etc
13054 * Customizing tables in ODT export:: How to define and use Table templates
13055 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
13058 @node Configuring a document converter
13059 @subsubheading Configuring a document converter
13061 @cindex doc, docx, rtf
13064 The ODT exporter can work with popular converters with little or no
13065 extra configuration from your side. @xref{Extending ODT export}.
13066 If you are using a converter that is not supported by default or if you would
13067 like to tweak the default converter settings, proceed as below.
13070 @item Register the converter
13072 @vindex org-odt-convert-processes
13073 Name your converter and add it to the list of known converters by
13074 customizing the option @code{org-odt-convert-processes}. Also specify how
13075 the converter can be invoked via command-line to effect the conversion.
13077 @item Configure its capabilities
13079 @vindex org-odt-convert-capabilities
13080 @anchor{x-odt-converter-capabilities} Specify the set of formats the
13081 converter can handle by customizing the variable
13082 @code{org-odt-convert-capabilities}. Use the default value for this
13083 variable as a guide for configuring your converter. As suggested by the
13084 default setting, you can specify the full set of formats supported by the
13085 converter and not limit yourself to specifying formats that are related to
13086 just the OpenDocument Text format.
13088 @item Choose the converter
13090 @vindex org-odt-convert-process
13091 Select the newly added converter as the preferred one by customizing the
13092 option @code{org-odt-convert-process}.
13095 @node Working with OpenDocument style files
13096 @subsubheading Working with OpenDocument style files
13097 @cindex styles, custom
13098 @cindex template, custom
13100 This section explores the internals of the ODT exporter and the
13101 means by which it produces styled documents. Read this section if you are
13102 interested in exploring the automatic and custom OpenDocument styles used by
13105 @anchor{x-factory-styles}
13106 @subsubheading a) Factory styles
13108 The ODT exporter relies on two files for generating its output.
13109 These files are bundled with the distribution under the directory pointed to
13110 by the variable @code{org-odt-styles-dir}. The two files are:
13113 @anchor{x-orgodtstyles-xml}
13115 @file{OrgOdtStyles.xml}
13117 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
13118 document. This file gets modified for the following purposes:
13122 To control outline numbering based on user settings.
13125 To add styles generated by @file{htmlfontify.el} for fontification of code
13129 @anchor{x-orgodtcontenttemplate-xml}
13131 @file{OrgOdtContentTemplate.xml}
13133 This file contributes to the @file{content.xml} file of the final @samp{ODT}
13134 document. The contents of the Org outline are inserted between the
13135 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
13137 Apart from serving as a template file for the final @file{content.xml}, the
13138 file serves the following purposes:
13142 It contains automatic styles for formatting of tables which are referenced by
13146 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
13147 elements that control how various entities---tables, images, equations,
13148 etc.---are numbered.
13152 @anchor{x-overriding-factory-styles}
13153 @subsubheading b) Overriding factory styles
13154 The following two variables control the location from which the ODT
13155 exporter picks up the custom styles and content template files. You can
13156 customize these variables to override the factory styles used by the
13160 @anchor{x-org-odt-styles-file}
13162 @code{org-odt-styles-file}
13164 Use this variable to specify the @file{styles.xml} that will be used in the
13165 final output. You can specify one of the following values:
13168 @item A @file{styles.xml} file
13170 Use this file instead of the default @file{styles.xml}
13172 @item A @file{.odt} or @file{.ott} file
13174 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13177 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
13179 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13180 Template file. Additionally extract the specified member files and embed
13181 those within the final @samp{ODT} document.
13183 Use this option if the @file{styles.xml} file references additional files
13184 like header and footer images.
13188 Use the default @file{styles.xml}
13191 @anchor{x-org-odt-content-template-file}
13193 @code{org-odt-content-template-file}
13195 Use this variable to specify the blank @file{content.xml} that will be used
13196 in the final output.
13199 @node Creating one-off styles
13200 @subsubheading Creating one-off styles
13202 There are times when you would want one-off formatting in the exported
13203 document. You can achieve this by embedding raw OpenDocument XML in the Org
13204 file. The use of this feature is better illustrated with couple of examples.
13207 @item Embedding ODT tags as part of regular text
13209 You can inline OpenDocument syntax by enclosing it within
13210 @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do
13214 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
13215 text</text:span>@@@@. But this is a regular text.
13218 @strong{Hint:} To see the above example in action, edit your
13219 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13220 custom @samp{Highlight} style as shown below.
13223 <style:style style:name="Highlight" style:family="text">
13224 <style:text-properties fo:background-color="#ff0000"/>
13228 @item Embedding a one-line OpenDocument XML
13230 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
13231 directive. For example, to force a page break do the following:
13234 #+ODT: <text:p text:style-name="PageBreak"/>
13237 @strong{Hint:} To see the above example in action, edit your
13238 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13239 custom @samp{PageBreak} style as shown below.
13242 <style:style style:name="PageBreak" style:family="paragraph"
13243 style:parent-style-name="Text_20_body">
13244 <style:paragraph-properties fo:break-before="page"/>
13248 @item Embedding a block of OpenDocument XML
13250 You can add a large block of OpenDocument XML using the @code{#+BEGIN_EXPORT
13251 odt}@dots{}@code{#+END_EXPORT} construct.
13253 For example, to create a one-off paragraph that uses bold text, do the
13258 <text:p text:style-name="Text_20_body_20_bold">
13259 This paragraph is specially formatted and uses bold text.
13266 @node Customizing tables in ODT export
13267 @subsubheading Customizing tables in ODT export
13268 @cindex tables, in ODT export
13271 You can override the default formatting of the table by specifying a custom
13272 table style with the @code{#+ATTR_ODT} line. For a discussion on default
13273 formatting of tables @pxref{Tables in ODT export}.
13275 This feature closely mimics the way table templates are defined in the
13277 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
13278 OpenDocument-v1.2 Specification}}
13280 @vindex org-odt-table-styles
13281 To have a quick preview of this feature, install the below setting and
13282 export the table that follows:
13285 (setq org-odt-table-styles
13286 (append org-odt-table-styles
13287 '(("TableWithHeaderRowAndColumn" "Custom"
13288 ((use-first-row-styles . t)
13289 (use-first-column-styles . t)))
13290 ("TableWithFirstRowandLastRow" "Custom"
13291 ((use-first-row-styles . t)
13292 (use-last-row-styles . t))))))
13296 #+ATTR_ODT: :style TableWithHeaderRowAndColumn
13297 | Name | Phone | Age |
13298 | Peter | 1234 | 17 |
13299 | Anna | 4321 | 25 |
13302 In the above example, you used a template named @samp{Custom} and installed
13303 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
13304 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
13305 styles needed for producing the above template have been pre-defined for
13306 you. These styles are available under the section marked @samp{Custom
13307 Table Template} in @file{OrgOdtContentTemplate.xml}
13308 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
13309 additional templates you have to define these styles yourselves.
13311 To use this feature proceed as follows:
13315 Create a table template@footnote{See the @code{<table:table-template>}
13316 element of the OpenDocument-v1.2 specification}
13318 A table template is nothing but a set of @samp{table-cell} and
13319 @samp{paragraph} styles for each of the following table cell categories:
13333 The names for the above styles must be chosen based on the name of the table
13334 template using a well-defined convention.
13336 The naming convention is better illustrated with an example. For a table
13337 template with the name @samp{Custom}, the needed style names are listed in
13338 the following table.
13340 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
13341 @headitem Table cell type
13342 @tab @code{table-cell} style
13343 @tab @code{paragraph} style
13348 @tab @samp{CustomTableCell}
13349 @tab @samp{CustomTableParagraph}
13351 @tab @samp{CustomFirstColumnTableCell}
13352 @tab @samp{CustomFirstColumnTableParagraph}
13354 @tab @samp{CustomLastColumnTableCell}
13355 @tab @samp{CustomLastColumnTableParagraph}
13357 @tab @samp{CustomFirstRowTableCell}
13358 @tab @samp{CustomFirstRowTableParagraph}
13360 @tab @samp{CustomLastRowTableCell}
13361 @tab @samp{CustomLastRowTableParagraph}
13363 @tab @samp{CustomEvenRowTableCell}
13364 @tab @samp{CustomEvenRowTableParagraph}
13366 @tab @samp{CustomOddRowTableCell}
13367 @tab @samp{CustomOddRowTableParagraph}
13369 @tab @samp{CustomEvenColumnTableCell}
13370 @tab @samp{CustomEvenColumnTableParagraph}
13372 @tab @samp{CustomOddColumnTableCell}
13373 @tab @samp{CustomOddColumnTableParagraph}
13376 To create a table template with the name @samp{Custom}, define the above
13378 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
13379 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
13383 Define a table style@footnote{See the attributes @code{table:template-name},
13384 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
13385 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
13386 @code{table:use-banding-rows-styles}, and
13387 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
13388 the OpenDocument-v1.2 specification}
13390 @vindex org-odt-table-styles
13391 To define a table style, create an entry for the style in the variable
13392 @code{org-odt-table-styles} and specify the following:
13395 @item the name of the table template created in step (1)
13396 @item the set of cell styles in that template that are to be activated
13399 For example, the entry below defines two different table styles
13400 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
13401 based on the same template @samp{Custom}. The styles achieve their intended
13402 effect by selectively activating the individual cell styles in that template.
13405 (setq org-odt-table-styles
13406 (append org-odt-table-styles
13407 '(("TableWithHeaderRowAndColumn" "Custom"
13408 ((use-first-row-styles . t)
13409 (use-first-column-styles . t)))
13410 ("TableWithFirstRowandLastRow" "Custom"
13411 ((use-first-row-styles . t)
13412 (use-last-row-styles . t))))))
13416 Associate a table with the table style
13418 To do this, specify the table style created in step (2) as part of
13419 the @code{ATTR_ODT} line as shown below.
13422 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
13423 | Name | Phone | Age |
13424 | Peter | 1234 | 17 |
13425 | Anna | 4321 | 25 |
13429 @node Validating OpenDocument XML
13430 @subsubheading Validating OpenDocument XML
13432 Occasionally, you will discover that the document created by the
13433 ODT exporter cannot be opened by your favorite application. One of
13434 the common reasons for this is that the @file{.odt} file is corrupt. In such
13435 cases, you may want to validate the document against the OpenDocument RELAX
13436 NG Compact Syntax (RNC) schema.
13438 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
13439 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
13440 general help with validation (and schema-sensitive editing) of XML files:
13441 @inforef{Introduction,,nxml-mode}.
13443 @vindex org-odt-schema-dir
13444 If you have ready access to OpenDocument @file{.rnc} files and the needed
13445 schema-locating rules in a single folder, you can customize the variable
13446 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
13447 will take care of updating the @code{rng-schema-locating-files} for you.
13449 @c end opendocument
13452 @section Org export
13455 @code{org} export back-end creates a normalized version of the Org document
13456 in current buffer. In particular, it evaluates Babel code (@pxref{Evaluating
13457 code blocks}) and removes other back-ends specific contents.
13459 @subheading Org export commands
13462 @orgcmd{C-c C-e O o,org-org-export-to-org}
13463 Export as an Org document. For an Org file, @file{myfile.org}, the resulting
13464 file will be @file{myfile.org.org}. The file will be overwritten without
13466 @orgcmd{C-c C-e O O,org-org-export-as-org}
13467 Export to a temporary buffer. Do not create a file.
13469 Export to an Org file, then open it.
13472 @node Texinfo export
13473 @section Texinfo export
13474 @cindex Texinfo export
13476 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13480 * Texinfo export commands:: How to invoke Texinfo export
13481 * Texinfo specific export settings:: Export settings for Texinfo
13482 * Document preamble:: File header, title and copyright page
13483 * Headings and sectioning structure:: Building document structure
13484 * Indices:: Creating indices
13485 * Quoting Texinfo code:: Incorporating literal Texinfo code
13486 * Texinfo specific attributes:: Controlling Texinfo output
13490 @node Texinfo export commands
13491 @subsection Texinfo export commands
13493 @vindex org-texinfo-info-process
13495 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13496 Export as a Texinfo file. For an Org file, @file{myfile.org}, the resulting
13497 file will be @file{myfile.texi}. The file will be overwritten without
13499 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13500 Export to Texinfo and then process to an Info file@footnote{By setting
13501 @code{org-texinfo-info-process}, it is possible to generate other formats,
13502 including DocBook.}.
13505 @node Texinfo specific export settings
13506 @subsection Texinfo specific export settings
13507 The Texinfo exporter introduces a number of keywords, similar to the general
13508 options settings described in @ref{Export settings}.
13513 @cindex #+SUBTITLE (Texinfo)
13514 The document subtitle.
13517 @cindex #+SUBAUTHOR
13518 The document subauthor.
13520 @item TEXINFO_FILENAME
13521 @cindex #+TEXINFO_FILENAME
13522 The Texinfo filename.
13524 @item TEXINFO_CLASS
13525 @cindex #+TEXINFO_CLASS
13526 @vindex org-texinfo-default-class
13527 The class of the document (@code{org-texinfo-default-class}). This must be a
13528 member of @code{org-texinfo-classes}.
13530 @item TEXINFO_HEADER
13531 @cindex #+TEXINFO_HEADER
13532 Arbitrary lines inserted at the end of the preamble.
13534 @item TEXINFO_POST_HEADER
13535 @cindex #+TEXINFO_POST_HEADER
13536 Arbitrary lines inserted at the end of the preamble.
13538 @item TEXINFO_DIR_CATEGORY
13539 @cindex #+TEXINFO_DIR_CATEGORY
13540 The directory category of the document.
13542 @item TEXINFO_DIR_TITLE
13543 @cindex #+TEXINFO_DIR_TITLE
13544 The directory title of the document.
13546 @item TEXINFO_DIR_DESC
13547 @cindex #+TEXINFO_DIR_DESC
13548 The directory description of the document.
13550 @item TEXINFO_PRINTED_TITLE
13551 @cindex #+TEXINFO_PRINTED_TITLE
13552 The printed title of the document.
13555 These keywords are treated in details in the following sections.
13557 @node Document preamble
13558 @subsection Document preamble
13560 When processing a document, @samp{texinfo} back-end generates a minimal file
13561 header along with a title page, a copyright page, and a menu. You control
13562 the latter through the structure of the document (@pxref{Headings and
13563 sectioning structure}). Various keywords allow you to tweak the other parts.
13564 It is also possible to give directions to install the document in the
13567 @subsubheading File header
13569 @cindex #+TEXINFO_FILENAME
13570 Upon creating the header of a Texinfo file, the back-end guesses a name for
13571 the Info file to be compiled. This may not be a sensible choice, e.g., if
13572 you want to produce the final document in a different directory. Specify an
13573 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13576 @vindex org-texinfo-coding-system
13577 @vindex org-texinfo-classes
13578 @cindex #+TEXINFO_HEADER
13579 @cindex #+TEXINFO_CLASS
13580 Along with the output file name, the header contains information about the
13581 language (@pxref{Export settings}) and current encoding used@footnote{See
13582 @code{org-texinfo-coding-system} for more information.}. Insert
13583 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13584 @@code@{@@synindex@}.
13586 If you happen to regularly install the same set of commands, it may be easier
13587 to define your own class in @code{org-texinfo-classes}, which see. Set
13588 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13590 @subsubheading Title and copyright page
13592 @cindex #+TEXINFO_PRINTED_TITLE
13593 The default template includes a title page for hard copy output. The title
13594 and author displayed on this page are extracted from, respectively,
13595 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}). It is
13596 also possible to print a different, more specific, title with
13597 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13598 @code{#+SUBTITLE} keyword. Both expect raw Texinfo code in their value.
13600 @cindex #+SUBAUTHOR
13601 Likewise, information brought by @code{#+AUTHOR} may not be enough. You can
13602 include other authors with several @code{#+SUBAUTHOR} keywords. Values are
13603 also expected to be written in Texinfo code.
13606 #+AUTHOR: Jane Smith
13607 #+SUBAUTHOR: John Doe
13608 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13611 @cindex property, COPYING
13612 Copying material is defined in a dedicated headline with a non-@code{nil}
13613 @code{:COPYING:} property. The contents are inserted within
13614 a @code{@@copying} command at the beginning of the document whereas the
13615 heading itself does not appear in the structure of the document.
13617 Copyright information is printed on the back of the title page.
13625 This is a short example of a complete Texinfo file, version 1.0.
13627 Copyright \copy 2016 Free Software Foundation, Inc.
13630 @subsubheading The Top node
13632 @cindex #+TEXINFO_DIR_CATEGORY
13633 @cindex #+TEXINFO_DIR_TITLE
13634 @cindex #+TEXINFO_DIR_DESC
13635 You may ultimately want to install your new Info file in your system. You
13636 can write an appropriate entry in the top level directory specifying its
13637 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13638 @code{#+TEXINFO_DIR_TITLE}. Optionally, you can add a short description
13639 using @code{#+TEXINFO_DIR_DESC}. The following example would write an entry
13640 similar to Org's in the @samp{Top} node.
13643 #+TEXINFO_DIR_CATEGORY: Emacs
13644 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13645 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13648 @node Headings and sectioning structure
13649 @subsection Headings and sectioning structure
13651 @vindex org-texinfo-classes
13652 @vindex org-texinfo-default-class
13653 @cindex #+TEXINFO_CLASS
13654 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13655 Texinfo structuring commands. For example, a top level headline appears as
13656 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13657 otherwise. If you need to use a different set of commands, e.g., to start
13658 with @code{@@part} instead of @code{@@chapter}, install a new class in
13659 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13660 keyword. Export process defaults to @code{org-texinfo-default-class} when
13661 there is no such keyword in the document.
13663 If a headline's level has no associated structuring command, or is below
13664 a certain threshold (@pxref{Export settings}), that headline becomes a list
13667 @cindex property, APPENDIX
13668 As an exception, a headline with a non-@code{nil} @code{:APPENDIX:} property becomes
13669 an appendix, independently on its level and the class used.
13671 @cindex property, DESCRIPTION
13672 Each regular sectioning structure creates a menu entry, named after the
13673 heading. You can provide a different, e.g., shorter, title in
13674 @code{:ALT_TITLE:} property (@pxref{Table of contents}). Optionally, you can
13675 specify a description for the item in @code{:DESCRIPTION:} property. E.g.,
13678 * Controlling Screen Display
13680 :ALT_TITLE: Display
13681 :DESCRIPTION: Controlling Screen Display
13686 @subsection Indices
13694 Index entries are created using dedicated keywords. @samp{texinfo} back-end
13695 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13696 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}. For
13697 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13701 #+CINDEX: Defining indexing entries
13704 @cindex property, INDEX
13705 To generate an index, you need to set the @code{:INDEX:} property of
13706 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13707 The headline is then exported as an unnumbered chapter or section command and
13708 the index is inserted after its contents.
13717 @node Quoting Texinfo code
13718 @subsection Quoting Texinfo code
13720 It is possible to insert raw Texinfo code using any of the following
13724 @cindex #+BEGIN_EXPORT texinfo
13726 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13728 #+TEXINFO: @@need800
13729 This paragraph is preceded by...
13731 #+BEGIN_EXPORT texinfo
13732 @@auindex Johnson, Mark
13733 @@auindex Lakoff, George
13737 @node Texinfo specific attributes
13738 @subsection Texinfo specific attributes
13740 @cindex #+ATTR_TEXINFO
13741 @samp{texinfo} back-end understands several attributes in plain lists, tables
13742 and images. They must be specified using an @code{#+ATTR_TEXINFO} keyword,
13743 written just above the list, table or image.
13745 @subsubheading Plain lists
13747 In Texinfo output, description lists appear as two-column tables, using the
13748 default command @code{@@table}. You can use @code{@@ftable} or
13749 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13750 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13752 @vindex org-texinfo-def-table-markup
13753 In any case, these constructs require a highlighting command for entries in
13754 the list. You can provide one with @code{:indic} attribute. If you do not,
13755 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13759 #+ATTR_TEXINFO: :indic @@asis
13760 - foo :: This is the text for /foo/, with no highlighting.
13763 @subsubheading Tables
13765 When exporting a table, column widths are deduced from the longest cell in
13766 each column. You can also define them explicitly as fractions of the line
13767 length, using @code{:columns} attribute.
13770 #+ATTR_TEXINFO: :columns .5 .5
13771 | a cell | another cell |
13774 @subsubheading Images
13776 Images are links to files with a supported image extension and no
13777 description. Image scaling is set with @code{:width} and @code{:height}
13778 attributes. You can also use @code{:alt} to specify alternate text, as
13782 #+ATTR_TEXINFO: :width 1in :alt Alternate @@i@{text@}
13786 @subsubheading Special blocks
13788 In Texinfo output, special blocks become commands of the same name. Value of
13789 @code{:options} attribute is added right after the beginning of the command.
13793 #+attr_texinfo: :options org-org-export-to-org ...
13795 A somewhat obsessive function.
13803 @@defun org-org-export-to-org ...
13804 A somewhat obsessive function.
13809 @subsection An example
13811 Here is a thorough example. @inforef{GNU Sample Texts,,texinfo} for an
13812 equivalent Texinfo code.
13815 #+MACRO: version 2.0
13816 #+MACRO: updated last updated 4 March 2014
13818 #+OPTIONS: ':t toc:t author:t email:t
13819 #+TITLE: GNU Sample @{@{@{version@}@}@}
13820 #+AUTHOR: A.U. Thor
13821 #+EMAIL: bug-sample@@gnu.org
13824 #+TEXINFO_FILENAME: sample.info
13825 #+TEXINFO_HEADER: @@syncodeindex pg cp
13827 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13828 #+TEXINFO_DIR_TITLE: sample: (sample)
13829 #+TEXINFO_DIR_DESC: Invoking sample
13831 #+TEXINFO_PRINTED_TITLE: GNU Sample
13832 #+SUBTITLE: for version @{@{@{version@}@}@}, @{@{@{updated@}@}@}
13839 This manual is for GNU Sample (version @{@{@{version@}@}@},
13840 @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13842 Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13846 Permission is granted to copy, distribute and/or modify this
13847 document under the terms of the GNU Free Documentation License,
13848 Version 1.3 or any later version published by the Free Software
13849 Foundation; with no Invariant Sections, with no Front-Cover Texts,
13850 and with no Back-Cover Texts. A copy of the license is included in
13851 the section entitled "GNU Free Documentation License".
13857 #+CINDEX: invoking @@command@{sample@}
13859 This is a sample manual. There is no sample program to invoke, but
13860 if there were, you could see its basic usage and command line
13863 * GNU Free Documentation License
13868 #+TEXINFO: @@include fdl.texi
13876 @node iCalendar export
13877 @section iCalendar export
13878 @cindex iCalendar export
13880 @vindex org-icalendar-include-todo
13881 @vindex org-icalendar-use-deadline
13882 @vindex org-icalendar-use-scheduled
13883 @vindex org-icalendar-categories
13884 @vindex org-icalendar-alarm-time
13885 Some people use Org mode for keeping track of projects, but still prefer a
13886 standard calendar application for anniversaries and appointments. In this
13887 case it can be useful to show deadlines and other time-stamped items in Org
13888 files in the calendar application. Org mode can export calendar information
13889 in the standard iCalendar format. If you also want to have TODO entries
13890 included in the export, configure the variable
13891 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
13892 and TODO items as VTODO@. It will also create events from deadlines that are
13893 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
13894 to set the start and due dates for the TODO entry@footnote{See the variables
13895 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13896 As categories, it will use the tags locally defined in the heading, and the
13897 file/tree category@footnote{To add inherited tags or the TODO state,
13898 configure the variable @code{org-icalendar-categories}.}. See the variable
13899 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13902 @vindex org-icalendar-store-UID
13903 @cindex property, ID
13904 The iCalendar standard requires each entry to have a globally unique
13905 identifier (UID). Org creates these identifiers during export. If you set
13906 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13907 @code{:ID:} property of the entry and re-used next time you report this
13908 entry. Since a single entry can give rise to multiple iCalendar entries (as
13909 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13910 prefixes to the UID, depending on what triggered the inclusion of the entry.
13911 In this way the UID remains unique, but a synchronization program can still
13912 figure out from which entry all the different instances originate.
13915 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13916 Create iCalendar entries for the current buffer and store them in the same
13917 directory, using a file extension @file{.ics}.
13918 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13919 @vindex org-agenda-files
13920 Like @kbd{C-c C-e c f}, but do this for all files in
13921 @code{org-agenda-files}. For each of these files, a separate iCalendar
13922 file will be written.
13923 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13924 @vindex org-icalendar-combined-agenda-file
13925 Create a single large iCalendar file from all files in
13926 @code{org-agenda-files} and write it to the file given by
13927 @code{org-icalendar-combined-agenda-file}.
13930 @vindex org-use-property-inheritance
13931 @vindex org-icalendar-include-body
13932 @cindex property, SUMMARY
13933 @cindex property, DESCRIPTION
13934 @cindex property, LOCATION
13935 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13936 property can be inherited from higher in the hierarchy if you configure
13937 @code{org-use-property-inheritance} accordingly.} properties if the selected
13938 entries have them. If not, the summary will be derived from the headline,
13939 and the description from the body (limited to
13940 @code{org-icalendar-include-body} characters).
13942 How this calendar is best read and updated, depends on the application
13943 you are using. The FAQ covers this issue.
13945 @node Other built-in back-ends
13946 @section Other built-in back-ends
13947 @cindex export back-ends, built-in
13948 @vindex org-export-backends
13950 On top of the aforementioned back-ends, Org comes with other built-in ones:
13953 @item @file{ox-man.el}: export to a man page.
13956 To activate these export back-end, customize @code{org-export-backends} or
13957 load them directly with e.g., @code{(require 'ox-man)}. This will add new
13958 keys in the export dispatcher (@pxref{The export dispatcher}).
13960 See the comment section of these files for more information on how to use
13963 @node Export in foreign buffers
13964 @section Export in foreign buffers
13966 Most built-in back-ends come with a command to convert the selected region
13967 into a selected format and replace this region by the exported output. Here
13968 is a list of such conversion commands:
13971 @item org-html-convert-region-to-html
13972 Convert the selected region into HTML.
13973 @item org-latex-convert-region-to-latex
13974 Convert the selected region into @LaTeX{}.
13975 @item org-texinfo-convert-region-to-texinfo
13976 Convert the selected region into @code{Texinfo}.
13977 @item org-md-convert-region-to-md
13978 Convert the selected region into @code{MarkDown}.
13981 This is particularly useful for converting tables and lists in foreign
13982 buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13983 use Org commands for editing a list, and finally select and convert the list
13984 with @code{M-x org-html-convert-region-to-html RET}.
13986 @node Advanced configuration
13987 @section Advanced configuration
13991 @vindex org-export-before-processing-hook
13992 @vindex org-export-before-parsing-hook
13993 Two hooks are run during the first steps of the export process. The first
13994 one, @code{org-export-before-processing-hook} is called before expanding
13995 macros, Babel code and include keywords in the buffer. The second one,
13996 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13997 before parsing the buffer. Their main use is for heavy duties, that is
13998 duties involving structural modifications of the document. For example, one
13999 may want to remove every headline in the buffer during export. The following
14000 code can achieve this:
14004 (defun my-headline-removal (backend)
14005 "Remove all headlines in the current buffer.
14006 BACKEND is the export back-end being used, as a symbol."
14008 (lambda () (delete-region (point) (progn (forward-line) (point))))))
14010 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
14014 Note that functions used in these hooks require a mandatory argument,
14015 a symbol representing the back-end used.
14017 @subheading Filters
14019 @cindex Filters, exporting
14020 Filters are lists of functions applied on a specific part of the output from
14021 a given back-end. More explicitly, each time a back-end transforms an Org
14022 object or element into another language, all functions within a given filter
14023 type are called in turn on the string produced. The string returned by the
14024 last function will be the one used in the final output.
14026 There are filter sets for each type of element or object, for plain text,
14027 for the parse tree, for the export options and for the final output. They
14028 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
14029 where @code{TYPE} is the type targeted by the filter. Valid types are:
14031 @multitable @columnfractions .33 .33 .33
14044 @item export-snippet
14047 @item footnote-definition
14048 @tab footnote-reference
14050 @item horizontal-rule
14051 @tab inline-babel-call
14052 @tab inline-src-block
14057 @tab latex-environment
14058 @tab latex-fragment
14068 @item property-drawer
14074 @item statistics-cookie
14075 @tab strike-through
14088 For example, the following snippet allows me to use non-breaking spaces in
14089 the Org buffer and get them translated into @LaTeX{} without using the
14090 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
14094 (defun my-latex-filter-nobreaks (text backend info)
14095 "Ensure \"_\" are properly handled in LaTeX export."
14096 (when (org-export-derived-backend-p backend 'latex)
14097 (replace-regexp-in-string "_" "~" text)))
14099 (add-to-list 'org-export-filter-plain-text-functions
14100 'my-latex-filter-nobreaks)
14104 Three arguments must be provided to a filter: the code being changed, the
14105 back-end used, and some information about the export process. You can safely
14106 ignore the third argument for most purposes. Note the use of
14107 @code{org-export-derived-backend-p}, which ensures that the filter will only
14108 be applied when using @code{latex} back-end or any other back-end derived
14109 from it (e.g., @code{beamer}).
14111 @subheading Defining filters for individual files
14113 You can customize the export for just a specific file by binding export
14114 filter variables using @code{#+BIND}. Here is an example where we introduce
14115 two filters, one to remove brackets from time stamps, and one to entirely
14116 remove any strike-through text. The functions doing the filtering are
14117 defined in an src block that allows the filter function definitions to exist
14118 in the file itself and ensures that the functions will be there when needed.
14121 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
14122 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
14123 #+begin_src emacs-lisp :exports results :results none
14124 (defun tmp-f-timestamp (s backend info)
14125 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
14126 (defun tmp-f-strike-through (s backend info) "")
14130 @subheading Extending an existing back-end
14132 This is obviously the most powerful customization, since the changes happen
14133 at the parser level. Indeed, some export back-ends are built as extensions
14134 of other ones (e.g., Markdown back-end an extension of HTML back-end).
14136 Extending a back-end means that if an element type is not transcoded by the
14137 new back-end, it will be handled by the original one. Hence you can extend
14138 specific parts of a back-end without too much work.
14140 As an example, imagine we want the @code{ascii} back-end to display the
14141 language used in a source block, when it is available, but only when some
14142 attribute is non-@code{nil}, like the following:
14145 #+ATTR_ASCII: :language t
14148 Because that back-end is lacking in that area, we are going to create a new
14149 back-end, @code{my-ascii} that will do the job.
14153 (defun my-ascii-src-block (src-block contents info)
14154 "Transcode a SRC-BLOCK element from Org to ASCII.
14155 CONTENTS is nil. INFO is a plist used as a communication
14157 (if (not (org-export-read-attribute :attr_ascii src-block :language))
14158 (org-export-with-backend 'ascii src-block contents info)
14160 (format ",--[ %s ]--\n%s`----"
14161 (org-element-property :language src-block)
14162 (replace-regexp-in-string
14164 (org-element-normalize-string
14165 (org-export-format-code-default src-block info)))))))
14167 (org-export-define-derived-backend 'my-ascii 'ascii
14168 :translate-alist '((src-block . my-ascii-src-block)))
14172 The @code{my-ascii-src-block} function looks at the attribute above the
14173 element. If it isn't true, it gives hand to the @code{ascii} back-end.
14174 Otherwise, it creates a box around the code, leaving room for the language.
14175 A new back-end is then created. It only changes its behavior when
14176 translating @code{src-block} type element. Now, all it takes to use the new
14177 back-end is calling the following from an Org buffer:
14180 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
14183 It is obviously possible to write an interactive function for this, install
14184 it in the export dispatcher menu, and so on.
14188 @chapter Publishing
14191 Org includes a publishing management system that allows you to configure
14192 automatic HTML conversion of @emph{projects} composed of interlinked org
14193 files. You can also configure Org to automatically upload your exported HTML
14194 pages and related attachments, such as images and source code files, to a web
14197 You can also use Org to convert files into PDF, or even combine HTML and PDF
14198 conversion so that files are available in both formats on the server.
14200 Publishing has been contributed to Org by David O'Toole.
14203 * Configuration:: Defining projects
14204 * Uploading files:: How to get files up on the server
14205 * Sample configuration:: Example projects
14206 * Triggering publication:: Publication commands
14209 @node Configuration
14210 @section Configuration
14212 Publishing needs significant configuration to specify files, destination
14213 and many other properties of a project.
14216 * Project alist:: The central configuration variable
14217 * Sources and destinations:: From here to there
14218 * Selecting files:: What files are part of the project?
14219 * Publishing action:: Setting the function doing the publishing
14220 * Publishing options:: Tweaking HTML/@LaTeX{} export
14221 * Publishing links:: Which links keep working after publishing?
14222 * Sitemap:: Generating a list of all pages
14223 * Generating an index:: An index that reaches across pages
14226 @node Project alist
14227 @subsection The variable @code{org-publish-project-alist}
14228 @cindex org-publish-project-alist
14229 @cindex projects, for publishing
14231 @vindex org-publish-project-alist
14232 Publishing is configured almost entirely through setting the value of one
14233 variable, called @code{org-publish-project-alist}. Each element of the list
14234 configures one project, and may be in one of the two following forms:
14237 ("project-name" :property value :property value ...)
14238 @r{i.e., a well-formed property list with alternating keys and values}
14240 ("project-name" :components ("project-name" "project-name" ...))
14244 In both cases, projects are configured by specifying property values. A
14245 project defines the set of files that will be published, as well as the
14246 publishing configuration to use when publishing those files. When a project
14247 takes the second form listed above, the individual members of the
14248 @code{:components} property are taken to be sub-projects, which group
14249 together files requiring different publishing options. When you publish such
14250 a ``meta-project'', all the components will also be published, in the
14253 @node Sources and destinations
14254 @subsection Sources and destinations for files
14255 @cindex directories, for publishing
14257 Most properties are optional, but some should always be set. In
14258 particular, Org needs to know where to look for source files,
14259 and where to put published files.
14261 @multitable @columnfractions 0.3 0.7
14262 @item @code{:base-directory}
14263 @tab Directory containing publishing source files
14264 @item @code{:publishing-directory}
14265 @tab Directory where output files will be published. You can directly
14266 publish to a web server using a file name syntax appropriate for
14267 the Emacs @file{tramp} package. Or you can publish to a local directory and
14268 use external tools to upload your website (@pxref{Uploading files}).
14269 @item @code{:preparation-function}
14270 @tab Function or list of functions to be called before starting the
14271 publishing process, for example, to run @code{make} for updating files to be
14272 published. The project property list is scoped into this call as the
14273 variable @code{project-plist}.
14274 @item @code{:completion-function}
14275 @tab Function or list of functions called after finishing the publishing
14276 process, for example, to change permissions of the resulting files. The
14277 project property list is scoped into this call as the variable
14278 @code{project-plist}.
14282 @node Selecting files
14283 @subsection Selecting files
14284 @cindex files, selecting for publishing
14286 By default, all files with extension @file{.org} in the base directory
14287 are considered part of the project. This can be modified by setting the
14289 @multitable @columnfractions 0.25 0.75
14290 @item @code{:base-extension}
14291 @tab Extension (without the dot!) of source files. This actually is a
14292 regular expression. Set this to the symbol @code{any} if you want to get all
14293 files in @code{:base-directory}, even without extension.
14295 @item @code{:exclude}
14296 @tab Regular expression to match file names that should not be
14297 published, even though they have been selected on the basis of their
14300 @item @code{:include}
14301 @tab List of files to be included regardless of @code{:base-extension}
14302 and @code{:exclude}.
14304 @item @code{:recursive}
14305 @tab non-@code{nil} means, check base-directory recursively for files to publish.
14308 @node Publishing action
14309 @subsection Publishing action
14310 @cindex action, for publishing
14312 Publishing means that a file is copied to the destination directory and
14313 possibly transformed in the process. The default transformation is to export
14314 Org files as HTML files, and this is done by the function
14315 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
14316 export}). But you also can publish your content as PDF files using
14317 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
14318 using the corresponding functions.
14320 If you want to publish the Org file as an @code{.org} file but with the
14321 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
14322 function @code{org-org-publish-to-org}. This will produce @file{file.org}
14323 and put it in the publishing directory. If you want a htmlized version of
14324 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
14325 produce @file{file.org.html} in the publishing directory@footnote{If the
14326 publishing directory is the same than the source directory, @file{file.org}
14327 will be exported as @file{file.org.org}, so probably don't want to do this.}.
14329 Other files like images only need to be copied to the publishing destination.
14330 For this you can use @code{org-publish-attachment}. For non-org files, you
14331 always need to specify the publishing function:
14333 @multitable @columnfractions 0.3 0.7
14334 @item @code{:publishing-function}
14335 @tab Function executing the publication of a file. This may also be a
14336 list of functions, which will all be called in turn.
14337 @item @code{:htmlized-source}
14338 @tab non-@code{nil} means, publish htmlized source.
14341 The function must accept three arguments: a property list containing at least
14342 a @code{:publishing-directory} property, the name of the file to be published
14343 and the path to the publishing directory of the output file. It should take
14344 the specified file, make the necessary transformation (if any) and place the
14345 result into the destination folder.
14347 @node Publishing options
14348 @subsection Options for the exporters
14349 @cindex options, for publishing
14351 The property list can be used to set export options during the publishing
14352 process. In most cases, these properties correspond to user variables in
14353 Org. While some properties are available for all export back-ends, most of
14354 them are back-end specific. The following sections list properties along
14355 with the variable they belong to. See the documentation string of these
14356 options for details.
14358 @vindex org-publish-project-alist
14359 When a property is given a value in @code{org-publish-project-alist}, its
14360 setting overrides the value of the corresponding user variable (if any)
14361 during publishing. Options set within a file (@pxref{Export settings}),
14362 however, override everything.
14364 @subsubheading Generic properties
14366 @multitable {@code{:with-sub-superscript}} {@code{org-export-with-sub-superscripts}}
14367 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
14368 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
14369 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
14370 @item @code{:language} @tab @code{org-export-default-language}
14371 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
14372 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
14373 @item @code{:select-tags} @tab @code{org-export-select-tags}
14374 @item @code{:with-author} @tab @code{org-export-with-author}
14375 @item @code{:with-broken-links} @tab @code{org-export-with-broken-links}
14376 @item @code{:with-clocks} @tab @code{org-export-with-clocks}
14377 @item @code{:with-creator} @tab @code{org-export-with-creator}
14378 @item @code{:with-date} @tab @code{org-export-with-date}
14379 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
14380 @item @code{:with-email} @tab @code{org-export-with-email}
14381 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
14382 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
14383 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
14384 @item @code{:with-latex} @tab @code{org-export-with-latex}
14385 @item @code{:with-planning} @tab @code{org-export-with-planning}
14386 @item @code{:with-priority} @tab @code{org-export-with-priority}
14387 @item @code{:with-properties} @tab @code{org-export-with-properties}
14388 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
14389 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
14390 @item @code{:with-tables} @tab @code{org-export-with-tables}
14391 @item @code{:with-tags} @tab @code{org-export-with-tags}
14392 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
14393 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
14394 @item @code{:with-title} @tab @code{org-export-with-title}
14395 @item @code{:with-toc} @tab @code{org-export-with-toc}
14396 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
14399 @subsubheading ASCII specific properties
14401 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
14402 @item @code{:ascii-bullets} @tab @code{org-ascii-bullets}
14403 @item @code{:ascii-caption-above} @tab @code{org-ascii-caption-above}
14404 @item @code{:ascii-charset} @tab @code{org-ascii-charset}
14405 @item @code{:ascii-global-margin} @tab @code{org-ascii-global-margin}
14406 @item @code{:ascii-format-drawer-function} @tab @code{org-ascii-format-drawer-function}
14407 @item @code{:ascii-format-inlinetask-function} @tab @code{org-ascii-format-inlinetask-function}
14408 @item @code{:ascii-headline-spacing} @tab @code{org-ascii-headline-spacing}
14409 @item @code{:ascii-indented-line-width} @tab @code{org-ascii-indented-line-width}
14410 @item @code{:ascii-inlinetask-width} @tab @code{org-ascii-inlinetask-width}
14411 @item @code{:ascii-inner-margin} @tab @code{org-ascii-inner-margin}
14412 @item @code{:ascii-links-to-notes} @tab @code{org-ascii-links-to-notes}
14413 @item @code{:ascii-list-margin} @tab @code{org-ascii-list-margin}
14414 @item @code{:ascii-paragraph-spacing} @tab @code{org-ascii-paragraph-spacing}
14415 @item @code{:ascii-quote-margin} @tab @code{org-ascii-quote-margin}
14416 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
14417 @item @code{:ascii-table-use-ascii-art} @tab @code{org-ascii-table-use-ascii-art}
14418 @item @code{:ascii-table-widen-columns} @tab @code{org-ascii-table-widen-columns}
14419 @item @code{:ascii-text-width} @tab @code{org-ascii-text-width}
14420 @item @code{:ascii-underline} @tab @code{org-ascii-underline}
14421 @item @code{:ascii-verbatim-format} @tab @code{org-ascii-verbatim-format}
14424 @subsubheading Beamer specific properties
14426 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
14427 @item @code{:beamer-theme} @tab @code{org-beamer-theme}
14428 @item @code{:beamer-column-view-format} @tab @code{org-beamer-column-view-format}
14429 @item @code{:beamer-environments-extra} @tab @code{org-beamer-environments-extra}
14430 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
14431 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
14432 @item @code{:beamer-outline-frame-title} @tab @code{org-beamer-outline-frame-title}
14433 @item @code{:beamer-subtitle-format} @tab @code{org-beamer-subtitle-format}
14436 @subsubheading HTML specific properties
14438 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
14439 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
14440 @item @code{:html-checkbox-type} @tab @code{org-html-checkbox-type}
14441 @item @code{:html-container} @tab @code{org-html-container-element}
14442 @item @code{:html-divs} @tab @code{org-html-divs}
14443 @item @code{:html-doctype} @tab @code{org-html-doctype}
14444 @item @code{:html-extension} @tab @code{org-html-extension}
14445 @item @code{:html-footnote-format} @tab @code{org-html-footnote-format}
14446 @item @code{:html-footnote-separator} @tab @code{org-html-footnote-separator}
14447 @item @code{:html-footnotes-section} @tab @code{org-html-footnotes-section}
14448 @item @code{:html-format-drawer-function} @tab @code{org-html-format-drawer-function}
14449 @item @code{:html-format-headline-function} @tab @code{org-html-format-headline-function}
14450 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
14451 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
14452 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
14453 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
14454 @item @code{:html-head} @tab @code{org-html-head}
14455 @item @code{:html-home/up-format} @tab @code{org-html-home/up-format}
14456 @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy}
14457 @item @code{:html-indent} @tab @code{org-html-indent}
14458 @item @code{:html-infojs-options} @tab @code{org-html-infojs-options}
14459 @item @code{:html-infojs-template} @tab @code{org-html-infojs-template}
14460 @item @code{:html-inline-image-rules} @tab @code{org-html-inline-image-rules}
14461 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
14462 @item @code{:html-link-home} @tab @code{org-html-link-home}
14463 @item @code{:html-link-org-files-as-html} @tab @code{org-html-link-org-files-as-html}
14464 @item @code{:html-link-up} @tab @code{org-html-link-up}
14465 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
14466 @item @code{:html-mathjax-options} @tab @code{org-html-mathjax-options}
14467 @item @code{:html-mathjax-template} @tab @code{org-html-mathjax-template}
14468 @item @code{:html-metadata-timestamp-format} @tab @code{org-html-metadata-timestamp-format}
14469 @item @code{:html-postamble-format} @tab @code{org-html-postamble-format}
14470 @item @code{:html-postamble} @tab @code{org-html-postamble}
14471 @item @code{:html-preamble-format} @tab @code{org-html-preamble-format}
14472 @item @code{:html-preamble} @tab @code{org-html-preamble}
14473 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
14474 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
14475 @item @code{:html-table-caption-above} @tab @code{org-html-table-caption-above}
14476 @item @code{:html-table-data-tags} @tab @code{org-html-table-data-tags}
14477 @item @code{:html-table-header-tags} @tab @code{org-html-table-header-tags}
14478 @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags}
14479 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
14480 @item @code{:html-tag-class-prefix} @tab @code{org-html-tag-class-prefix}
14481 @item @code{:html-text-markup-alist} @tab @code{org-html-text-markup-alist}
14482 @item @code{:html-todo-kwd-class-prefix} @tab @code{org-html-todo-kwd-class-prefix}
14483 @item @code{:html-toplevel-hlevel} @tab @code{org-html-toplevel-hlevel}
14484 @item @code{:html-use-infojs} @tab @code{org-html-use-infojs}
14485 @item @code{:html-validation-link} @tab @code{org-html-validation-link}
14486 @item @code{:html-viewport} @tab @code{org-html-viewport}
14487 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
14490 @subsubheading @LaTeX{} specific properties
14492 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}}
14493 @item @code{:latex-active-timestamp-format} @tab @code{org-latex-active-timestamp-format}
14494 @item @code{:latex-caption-above} @tab @code{org-latex-caption-above}
14495 @item @code{:latex-classes} @tab @code{org-latex-classes}
14496 @item @code{:latex-class} @tab @code{org-latex-default-class}
14497 @item @code{:latex-compiler} @tab @code{org-latex-compiler}
14498 @item @code{:latex-default-figure-position} @tab @code{org-latex-default-figure-position}
14499 @item @code{:latex-default-table-environment} @tab @code{org-latex-default-table-environment}
14500 @item @code{:latex-default-table-mode} @tab @code{org-latex-default-table-mode}
14501 @item @code{:latex-diary-timestamp-format} @tab @code{org-latex-diary-timestamp-format}
14502 @item @code{:latex-footnote-defined-format} @tab @code{org-latex-footnote-defined-format}
14503 @item @code{:latex-footnote-separator} @tab @code{org-latex-footnote-separator}
14504 @item @code{:latex-format-drawer-function} @tab @code{org-latex-format-drawer-function}
14505 @item @code{:latex-format-headline-function} @tab @code{org-latex-format-headline-function}
14506 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
14507 @item @code{:latex-hyperref-template} @tab @code{org-latex-hyperref-template}
14508 @item @code{:latex-image-default-height} @tab @code{org-latex-image-default-height}
14509 @item @code{:latex-image-default-option} @tab @code{org-latex-image-default-option}
14510 @item @code{:latex-image-default-width} @tab @code{org-latex-image-default-width}
14511 @item @code{:latex-inactive-timestamp-format} @tab @code{org-latex-inactive-timestamp-format}
14512 @item @code{:latex-inline-image-rules} @tab @code{org-latex-inline-image-rules}
14513 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
14514 @item @code{:latex-listings-langs} @tab @code{org-latex-listings-langs}
14515 @item @code{:latex-listings-options} @tab @code{org-latex-listings-options}
14516 @item @code{:latex-listings} @tab @code{org-latex-listings}
14517 @item @code{:latex-minted-langs} @tab @code{org-latex-minted-langs}
14518 @item @code{:latex-minted-options} @tab @code{org-latex-minted-options}
14519 @item @code{:latex-prefer-user-labels} @tab @code{org-latex-prefer-user-labels}
14520 @item @code{:latex-subtitle-format} @tab @code{org-latex-subtitle-format}
14521 @item @code{:latex-subtitle-separate} @tab @code{org-latex-subtitle-separate}
14522 @item @code{:latex-table-scientific-notation} @tab @code{org-latex-table-scientific-notation}
14523 @item @code{:latex-tables-booktabs} @tab @code{org-latex-tables-booktabs}
14524 @item @code{:latex-tables-centered} @tab @code{org-latex-tables-centered}
14525 @item @code{:latex-text-markup-alist} @tab @code{org-latex-text-markup-alist}
14526 @item @code{:latex-title-command} @tab @code{org-latex-title-command}
14527 @item @code{:latex-toc-command} @tab @code{org-latex-toc-command}
14530 @subsubheading Markdown specific properties
14532 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
14533 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
14536 @subsubheading ODT specific properties
14538 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
14539 @item @code{:odt-content-template-file} @tab @code{org-odt-content-template-file}
14540 @item @code{:odt-display-outline-level} @tab @code{org-odt-display-outline-level}
14541 @item @code{:odt-fontify-srcblocks} @tab @code{org-odt-fontify-srcblocks}
14542 @item @code{:odt-format-drawer-function} @tab @code{org-odt-format-drawer-function}
14543 @item @code{:odt-format-headline-function} @tab @code{org-odt-format-headline-function}
14544 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
14545 @item @code{:odt-inline-formula-rules} @tab @code{org-odt-inline-formula-rules}
14546 @item @code{:odt-inline-image-rules} @tab @code{org-odt-inline-image-rules}
14547 @item @code{:odt-pixels-per-inch} @tab @code{org-odt-pixels-per-inch}
14548 @item @code{:odt-styles-file} @tab @code{org-odt-styles-file}
14549 @item @code{:odt-table-styles} @tab @code{org-odt-table-styles}
14550 @item @code{:odt-use-date-fields} @tab @code{org-odt-use-date-fields}
14553 @subsubheading Texinfo specific properties
14555 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14556 @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format}
14557 @item @code{:texinfo-classes} @tab @code{org-texinfo-classes}
14558 @item @code{:texinfo-class} @tab @code{org-texinfo-default-class}
14559 @item @code{:texinfo-def-table-markup} @tab @code{org-texinfo-def-table-markup}
14560 @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format}
14561 @item @code{:texinfo-filename} @tab @code{org-texinfo-filename}
14562 @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function}
14563 @item @code{:texinfo-format-headline-function} @tab @code{org-texinfo-format-headline-function}
14564 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14565 @item @code{:texinfo-inactive-timestamp-format} @tab @code{org-texinfo-inactive-timestamp-format}
14566 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14567 @item @code{:texinfo-node-description-column} @tab @code{org-texinfo-node-description-column}
14568 @item @code{:texinfo-table-scientific-notation} @tab @code{org-texinfo-table-scientific-notation}
14569 @item @code{:texinfo-tables-verbatim} @tab @code{org-texinfo-tables-verbatim}
14570 @item @code{:texinfo-text-markup-alist} @tab @code{org-texinfo-text-markup-alist}
14573 @node Publishing links
14574 @subsection Links between published files
14575 @cindex links, publishing
14577 To create a link from one Org file to another, you would use something like
14578 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org}
14579 (@pxref{External links}). When published, this link becomes a link to
14580 @file{foo.html}. You can thus interlink the pages of your ``org web''
14581 project and the links will work as expected when you publish them to HTML.
14582 If you also publish the Org source file and want to link to it, use an
14583 @code{http:} link instead of a @code{file:} link, because @code{file:} links
14584 are converted to link to the corresponding @file{html} file.
14586 You may also link to related files, such as images. Provided you are careful
14587 with relative file names, and provided you have also configured Org to upload
14588 the related files, these links will work too. See @ref{Complex example}, for
14589 an example of this usage.
14591 Eventually, links between published documents can contain some search options
14592 (@pxref{Search options}), which will be resolved to the appropriate location
14593 in the linked file. For example, once published to HTML, the following links
14594 all point to a dedicated anchor in @file{foo.html}.
14597 [[file:foo.org::*heading]]
14598 [[file:foo.org::#custom-id]]
14599 [[file:foo.org::target]]
14603 @subsection Generating a sitemap
14604 @cindex sitemap, of published pages
14606 The following properties may be used to control publishing of
14607 a map of files for a given project.
14609 @multitable @columnfractions 0.35 0.65
14610 @item @code{:auto-sitemap}
14611 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14612 or @code{org-publish-all}.
14614 @item @code{:sitemap-filename}
14615 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
14616 becomes @file{sitemap.html}).
14618 @item @code{:sitemap-title}
14619 @tab Title of sitemap page. Defaults to name of file.
14621 @item @code{:sitemap-function}
14622 @tab Plug-in function to use for generation of the sitemap.
14623 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14624 of links to all files in the project.
14626 @item @code{:sitemap-sort-folders}
14627 @tab Where folders should appear in the sitemap. Set this to @code{first}
14628 (default) or @code{last} to display folders first or last,
14629 respectively. Any other value will mix files and folders.
14631 @item @code{:sitemap-sort-files}
14632 @tab How the files are sorted in the site map. Set this to
14633 @code{alphabetically} (default), @code{chronologically} or
14634 @code{anti-chronologically}. @code{chronologically} sorts the files with
14635 older date first while @code{anti-chronologically} sorts the files with newer
14636 date first. @code{alphabetically} sorts the files alphabetically. The date of
14637 a file is retrieved with @code{org-publish-find-date}.
14639 @item @code{:sitemap-ignore-case}
14640 @tab Should sorting be case-sensitive? Default @code{nil}.
14642 @item @code{:sitemap-file-entry-format}
14643 @tab With this option one can tell how a sitemap's entry is formatted in the
14644 sitemap. This is a format string with some escape sequences: @code{%t} stands
14645 for the title of the file, @code{%a} stands for the author of the file and
14646 @code{%d} stands for the date of the file. The date is retrieved with the
14647 @code{org-publish-find-date} function and formatted with
14648 @code{org-publish-sitemap-date-format}. Default @code{%t}.
14650 @item @code{:sitemap-date-format}
14651 @tab Format string for the @code{format-time-string} function that tells how
14652 a sitemap entry's date is to be formatted. This property bypasses
14653 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14655 @item @code{:sitemap-sans-extension}
14656 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14657 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14658 Defaults to @code{nil}.
14662 @node Generating an index
14663 @subsection Generating an index
14664 @cindex index, in a publishing project
14666 Org mode can generate an index across the files of a publishing project.
14668 @multitable @columnfractions 0.25 0.75
14669 @item @code{:makeindex}
14670 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14671 publish it as @file{theindex.html}.
14674 The file will be created when first publishing a project with the
14675 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
14676 "theindex.inc"}. You can then build around this include statement by adding
14677 a title, style information, etc.
14679 @node Uploading files
14680 @section Uploading files
14684 For those people already utilizing third party sync tools such as
14685 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14686 @i{remote} publishing facilities of Org mode which rely heavily on
14687 Tramp. Tramp, while very useful and powerful, tends not to be
14688 so efficient for multiple file transfer and has been known to cause problems
14691 Specialized synchronization utilities offer several advantages. In addition
14692 to timestamp comparison, they also do content and permissions/attribute
14693 checks. For this reason you might prefer to publish your web to a local
14694 directory (possibly even @i{in place} with your Org files) and then use
14695 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14697 Since Unison (for example) can be configured as to which files to transfer to
14698 a certain remote destination, it can greatly simplify the project publishing
14699 definition. Simply keep all files in the correct location, process your Org
14700 files with @code{org-publish} and let the synchronization tool do the rest.
14701 You do not need, in this scenario, to include attachments such as @file{jpg},
14702 @file{css} or @file{gif} files in the project definition since the 3rd party
14705 Publishing to a local directory is also much faster than to a remote one, so
14706 that you can afford more easily to republish entire projects. If you set
14707 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14708 benefit of re-including any changed external files such as source example
14709 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
14710 Org is not smart enough to detect if included files have been modified.
14712 @node Sample configuration
14713 @section Sample configuration
14715 Below we provide two example configurations. The first one is a simple
14716 project publishing only a set of Org files. The second example is
14717 more complex, with a multi-component project.
14720 * Simple example:: One-component publishing
14721 * Complex example:: A multi-component publishing example
14724 @node Simple example
14725 @subsection Example: simple publishing configuration
14727 This example publishes a set of Org files to the @file{public_html}
14728 directory on the local machine.
14731 (setq org-publish-project-alist
14733 :base-directory "~/org/"
14734 :publishing-directory "~/public_html"
14735 :section-numbers nil
14737 :html-head "<link rel=\"stylesheet\"
14738 href=\"../other/mystyle.css\"
14739 type=\"text/css\"/>")))
14742 @node Complex example
14743 @subsection Example: complex publishing configuration
14745 This more complicated example publishes an entire website, including
14746 Org files converted to HTML, image files, Emacs Lisp source code, and
14747 style sheets. The publishing directory is remote and private files are
14750 To ensure that links are preserved, care should be taken to replicate
14751 your directory structure on the web server, and to use relative file
14752 paths. For example, if your Org files are kept in @file{~/org} and your
14753 publishable images in @file{~/images}, you would link to an image with
14756 file:../images/myimage.png
14759 On the web server, the relative path to the image should be the
14760 same. You can accomplish this by setting up an "images" folder in the
14761 right place on the web server, and publishing images to it.
14764 (setq org-publish-project-alist
14766 :base-directory "~/org/"
14767 :base-extension "org"
14768 :publishing-directory "/ssh:user@@host:~/html/notebook/"
14769 :publishing-function org-html-publish-to-html
14770 :exclude "PrivatePage.org" ;; regexp
14772 :section-numbers nil
14774 :html-head "<link rel=\"stylesheet\"
14775 href=\"../other/mystyle.css\" type=\"text/css\"/>"
14779 :base-directory "~/images/"
14780 :base-extension "jpg\\|gif\\|png"
14781 :publishing-directory "/ssh:user@@host:~/html/images/"
14782 :publishing-function org-publish-attachment)
14785 :base-directory "~/other/"
14786 :base-extension "css\\|el"
14787 :publishing-directory "/ssh:user@@host:~/html/other/"
14788 :publishing-function org-publish-attachment)
14789 ("website" :components ("orgfiles" "images" "other"))))
14792 @node Triggering publication
14793 @section Triggering publication
14795 Once properly configured, Org can publish with the following commands:
14798 @orgcmd{C-c C-e P x,org-publish}
14799 Prompt for a specific project and publish all files that belong to it.
14800 @orgcmd{C-c C-e P p,org-publish-current-project}
14801 Publish the project containing the current file.
14802 @orgcmd{C-c C-e P f,org-publish-current-file}
14803 Publish only the current file.
14804 @orgcmd{C-c C-e P a,org-publish-all}
14805 Publish every project.
14808 @vindex org-publish-use-timestamps-flag
14809 Org uses timestamps to track when a file has changed. The above functions
14810 normally only publish changed files. You can override this and force
14811 publishing of all files by giving a prefix argument to any of the commands
14812 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14813 This may be necessary in particular if files include other files via
14814 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14817 @node Working with source code
14818 @chapter Working with source code
14819 @cindex Schulte, Eric
14820 @cindex Davison, Dan
14821 @cindex source code, working with
14823 Source code can be included in Org mode documents using a @samp{src} block,
14827 #+BEGIN_SRC emacs-lisp
14828 (defun org-xor (a b)
14834 Org mode provides a number of features for working with live source code,
14835 including editing of code blocks in their native major-mode, evaluation of
14836 code blocks, converting code blocks into source files (known as @dfn{tangling}
14837 in literate programming), and exporting code blocks and their
14838 results in several formats. This functionality was contributed by Eric
14839 Schulte and Dan Davison, and was originally named Org-babel.
14841 The following sections describe Org mode's code block handling facilities.
14844 * Structure of code blocks:: Code block syntax described
14845 * Editing source code:: Language major-mode editing
14846 * Exporting code blocks:: Export contents and/or results
14847 * Extracting source code:: Create pure source code files
14848 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
14849 * Library of Babel:: Use and contribute to a library of useful code blocks
14850 * Languages:: List of supported code block languages
14851 * Header arguments:: Configure code block functionality
14852 * Results of evaluation:: How evaluation results are handled
14853 * Noweb reference syntax:: Literate programming in Org mode
14854 * Key bindings and useful functions:: Work quickly with code blocks
14855 * Batch execution:: Call functions from the command line
14859 @node Structure of code blocks
14860 @section Structure of code blocks
14861 @cindex code block, structure
14862 @cindex source code, block structure
14864 @cindex #+BEGIN_SRC
14866 Live code blocks can be specified with a @samp{src} block or
14867 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14868 @ref{Easy templates} system} The structure of a @samp{src} block is
14872 #+BEGIN_SRC <language> <switches> <header arguments>
14877 The @code{#+NAME:} line is optional, and can be used to name the code
14878 block. Live code blocks require that a language be specified on the
14879 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
14880 @cindex source code, inline
14882 Live code blocks can also be specified inline using
14885 src_<language>@{<body>@}
14891 src_<language>[<header arguments>]@{<body>@}
14895 @item <#+NAME: name>
14896 This line associates a name with the code block. This is similar to the
14897 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14898 files. Referencing the name of a code block makes it possible to evaluate
14899 the block from other places in the file, from other files, or from Org mode
14900 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
14901 and the behavior of Org mode when two or more blocks share the same name is
14905 The language of the code in the block (see @ref{Languages}).
14906 @cindex source code, language
14908 Optional switches control code block export (see the discussion of switches in
14909 @ref{Literal examples})
14910 @cindex source code, switches
14911 @item <header arguments>
14912 Optional header arguments control many aspects of evaluation, export and
14913 tangling of code blocks (see @ref{Header arguments}).
14914 Header arguments can also be set on a per-buffer or per-subtree
14915 basis using properties.
14916 @item source code, header arguments
14918 Source code in the specified language.
14922 @node Editing source code
14923 @section Editing source code
14924 @cindex code block, editing
14925 @cindex source code, editing
14927 @vindex org-edit-src-auto-save-idle-delay
14928 @vindex org-edit-src-turn-on-auto-save
14930 Use @kbd{C-c '} to edit the current code block. This brings up a language
14931 major-mode edit buffer containing the body of the code block. Manually
14932 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14933 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14934 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14935 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14936 Use @kbd{C-c '} again to exit.
14938 The @code{org-src-mode} minor mode will be active in the edit buffer. The
14939 following variables can be used to configure the behavior of the edit
14940 buffer. See also the customization group @code{org-edit-structure} for
14941 further configuration options.
14944 @item org-src-lang-modes
14945 If an Emacs major-mode named @code{<lang>-mode} exists, where
14946 @code{<lang>} is the language named in the header line of the code block,
14947 then the edit buffer will be placed in that major-mode. This variable
14948 can be used to map arbitrary language names to existing major modes.
14949 @item org-src-window-setup
14950 Controls the way Emacs windows are rearranged when the edit buffer is created.
14951 @item org-src-preserve-indentation
14952 @cindex indentation, in source blocks
14953 By default, the value is @code{nil}, which means that code blocks evaluated
14954 during export or tangled are indented according to context, possibly altering
14955 leading sequences of spaces and tab characters in the process. When
14956 non-@code{nil}, indentation is relative to left column, and therefore, not
14957 modified during export or tangling. This variable is especially useful for
14958 tangling languages such as Python, in which whitespace indentation in the
14959 output is critical.
14960 @item org-src-ask-before-returning-to-edit-buffer
14961 By default, Org will ask before returning to an open edit buffer. Set this
14962 variable to @code{nil} to switch without asking.
14965 To turn on native code fontification in the @emph{Org} buffer, configure the
14966 variable @code{org-src-fontify-natively}.
14969 @node Exporting code blocks
14970 @section Exporting code blocks
14971 @cindex code block, exporting
14972 @cindex source code, exporting
14974 It is possible to export the @emph{code} of code blocks, the @emph{results}
14975 of code block evaluation, @emph{both} the code and the results of code block
14976 evaluation, or @emph{none}. For most languages, the default exports code.
14977 However, for some languages (e.g., @code{ditaa}) the default exports the
14978 results of code block evaluation. For information on exporting code block
14979 bodies, see @ref{Literal examples}. For information on exporting
14980 parts of Org documents, see @ref{Exporting}.
14982 The @code{:exports} header argument can be used to specify export
14983 behavior (note that these arguments are only relevant for code blocks, not
14986 @subsubheading Header arguments:
14989 @cindex @code{:exports}, src header argument
14990 @item :exports code
14991 The default in most languages. The body of the code block is exported, as
14992 described in @ref{Literal examples}.
14993 @item :exports results
14994 The code block will be evaluated each time to buffer is exported, and the
14995 results will be placed in the Org mode buffer for export, either updating
14996 previous results of the code block located anywhere in the buffer or, if no
14997 previous results exist, placing the results immediately after the code block.
14998 The body of the code block will not be exported.
14999 @item :exports both
15000 Both the code block and its results will be exported.
15001 @item :exports none
15002 Neither the code block nor its results will be exported.
15005 It is possible to inhibit the evaluation of code blocks during export.
15006 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
15007 ensure that no code blocks are evaluated as part of the export process. This
15008 can be useful in situations where potentially untrusted Org mode files are
15009 exported in an automated fashion, for example when Org mode is used as the
15010 markup language for a wiki. It is also possible to set this variable to
15011 @code{inline-only}. In that case, only inline code blocks will be
15012 evaluated, in order to insert their results. Non-inline code blocks are
15013 assumed to have their results already inserted in the buffer by manual
15014 evaluation. This setting is useful to avoid expensive recalculations during
15015 export, not to provide security.
15017 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
15018 on export. However, code blocks in subtrees excluded from export
15019 (@pxref{Export settings}) may be evaluated on export.
15021 @node Extracting source code
15022 @section Extracting source code
15024 @cindex source code, extracting
15025 @cindex code block, extracting source code
15027 Creating pure source code files by extracting code from source blocks is
15028 referred to as ``tangling''---a term adopted from the literate programming
15029 community. During ``tangling'' of code blocks their bodies are expanded
15030 using @code{org-babel-expand-src-block} which can expand both variable and
15031 ``noweb'' style references (see @ref{Noweb reference syntax}).
15033 @subsubheading Header arguments
15036 @cindex @code{:tangle}, src header argument
15038 The default. The code block is not included in the tangled output.
15040 Include the code block in the tangled output. The output file name is the
15041 name of the org file with the extension @samp{.org} replaced by the extension
15042 for the block language.
15043 @item :tangle filename
15044 Include the code block in the tangled output to file @samp{filename}.
15048 @subsubheading Functions
15051 @item org-babel-tangle
15052 Tangle the current file. Bound to @kbd{C-c C-v t}.
15054 With prefix argument only tangle the current code block.
15055 @item org-babel-tangle-file
15056 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
15059 @subsubheading Hooks
15062 @item org-babel-post-tangle-hook
15063 This hook is run from within code files tangled by @code{org-babel-tangle}.
15064 Example applications could include post-processing, compilation or evaluation
15065 of tangled code files.
15068 @subsubheading Jumping between code and Org
15070 When tangling code from an Org-mode buffer to a source code file, you'll
15071 frequently find yourself viewing the file of tangled source code (e.g., many
15072 debuggers point to lines of the source code file). It is useful to be able
15073 to navigate from the tangled source to the Org-mode buffer from which the
15076 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
15077 code to Org-mode functionality. Two header arguments are required for
15078 jumping to work, first the @code{padline} (@ref{padline}) option must be set
15079 to true (the default setting), second the @code{comments} (@ref{comments})
15080 header argument must be set to @code{link}, which will insert comments into
15081 the source code buffer which point back to the original Org-mode file.
15083 @node Evaluating code blocks
15084 @section Evaluating code blocks
15085 @cindex code block, evaluating
15086 @cindex source code, evaluating
15089 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
15090 potential for that code to do harm. Org mode provides safeguards to ensure
15091 that code is only evaluated after explicit confirmation from the user. For
15092 information on these safeguards (and on how to disable them) see @ref{Code
15093 evaluation security}.} and the results of evaluation optionally placed in the
15094 Org mode buffer. The results of evaluation are placed following a line that
15095 begins by default with @code{#+RESULTS} and optionally a cache identifier
15096 and/or the name of the evaluated code block. The default value of
15097 @code{#+RESULTS} can be changed with the customizable variable
15098 @code{org-babel-results-keyword}.
15100 By default, the evaluation facility is only enabled for Lisp code blocks
15101 specified as @code{emacs-lisp}. See @ref{Languages} to enable other
15102 supported languages. See @ref{Structure of code blocks} for information on
15103 the syntax used to define a code block.
15106 There are a number of ways to evaluate code blocks. The simplest is to press
15107 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
15108 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
15109 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
15110 @code{org-babel-execute-src-block} function to evaluate the block and insert
15111 its results into the Org mode buffer.
15114 It is also possible to evaluate named code blocks from
15115 anywhere@footnote{Actually, the constructs call_<name>() and src_<lang>@{@}
15116 are not evaluated when they appear in a keyword line (i.e. lines starting
15117 with @code{#+KEYWORD:}, @pxref{In-buffer settings}).} in an Org mode buffer
15118 or an Org mode table. These named code blocks can be located in the current
15119 Org mode buffer or in the ``Library of Babel'' (@pxref{Library of Babel}).
15120 Named code blocks can be evaluated with a separate @code{#+CALL:} line or
15121 inline within a block of text. In both cases the result is wrapped according
15122 to the value of @code{org-babel-inline-result-wrap}, which by default is
15123 @code{"=%s="} for markup that produces verbatim text.
15125 The syntax of the @code{#+CALL:} line is
15128 #+CALL: <name>(<arguments>)
15129 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
15132 The syntax for inline evaluation of named code blocks is
15135 ... call_<name>(<arguments>) ...
15136 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
15141 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
15143 Arguments specified in this section will be passed to the code block. These
15144 arguments use standard function call syntax, rather than
15145 header argument syntax. For example, a @code{#+CALL:} line that passes the
15146 number four to a code block named @code{double}, which declares the header
15147 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
15148 @item <inside header arguments>
15149 Inside header arguments are passed through and applied to the named code
15150 block. These arguments use header argument syntax rather than standard
15151 function call syntax. Inside header arguments affect how the code block is
15152 evaluated. For example, @code{[:results output]} will collect the results of
15153 everything printed to @code{STDOUT} during execution of the code block.
15154 @item <end header arguments>
15155 End header arguments are applied to the calling instance and do not affect
15156 evaluation of the named code block. They affect how the results are
15157 incorporated into the Org mode buffer and how the call line is exported. For
15158 example, @code{:results html} will insert the results of the call line
15159 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
15161 For more examples of passing header arguments to @code{#+CALL:} lines see
15162 @ref{Header arguments in function calls}.
15165 @node Library of Babel
15166 @section Library of Babel
15167 @cindex babel, library of
15168 @cindex source code, library
15169 @cindex code block, library
15171 The ``Library of Babel'' consists of code blocks that can be called from any
15172 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
15173 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
15174 code blocks} for information on the syntax of remote code block evaluation).
15176 The central repository of code blocks in the ``Library of Babel'' is housed
15177 in an Org mode file located in the @samp{doc} directory of Org mode.
15179 Users can add code blocks they believe to be generally useful to their
15180 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
15181 then loaded into the library with @code{org-babel-lob-ingest}.
15184 Code blocks located in any Org mode file can be loaded into the ``Library of
15185 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
15190 @cindex babel, languages
15191 @cindex source code, languages
15192 @cindex code block, languages
15194 Code blocks in the following languages are supported.
15196 @multitable @columnfractions 0.25 0.25 0.25 0.25
15197 @headitem @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
15198 @item Asymptote @tab asymptote @tab Awk @tab awk
15199 @item C @tab C @tab C++ @tab C++
15200 @item Clojure @tab clojure @tab CSS @tab css
15201 @item D @tab d @tab ditaa @tab ditaa
15202 @item Graphviz @tab dot @tab Emacs Calc @tab calc
15203 @item Emacs Lisp @tab emacs-lisp @tab Fortran @tab fortran
15204 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
15205 @item Java @tab java @tab Javascript @tab js
15206 @item LaTeX @tab latex @tab Ledger @tab ledger
15207 @item Lisp @tab lisp @tab Lilypond @tab lilypond
15208 @item MATLAB @tab matlab @tab Mscgen @tab mscgen
15209 @item Objective Caml @tab ocaml @tab Octave @tab octave
15210 @item Org mode @tab org @tab Oz @tab oz
15211 @item Perl @tab perl @tab Plantuml @tab plantuml
15212 @item Processing.js @tab processing @tab Python @tab python
15213 @item R @tab R @tab Ruby @tab ruby
15214 @item Sass @tab sass @tab Scheme @tab scheme
15215 @item GNU Screen @tab screen @tab Sed @tab sed
15216 @item shell @tab sh @tab SQL @tab sql
15217 @item SQLite @tab sqlite @tab @tab
15220 Language-specific documentation is available for some languages. If
15221 available, it can be found at
15222 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
15224 The option @code{org-babel-load-languages} controls which languages are
15225 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
15226 variable can be set using the customization interface or by adding code like
15227 the following to your emacs configuration.
15229 The following disables @code{emacs-lisp} evaluation and enables evaluation of
15230 @code{R} code blocks.
15233 (org-babel-do-load-languages
15234 'org-babel-load-languages
15235 '((emacs-lisp . nil)
15239 It is also possible to enable support for a language by loading the related
15240 elisp file with @code{require}.
15242 The following adds support for evaluating @code{clojure} code blocks.
15245 (require 'ob-clojure)
15248 @node Header arguments
15249 @section Header arguments
15250 @cindex code block, header arguments
15251 @cindex source code, block header arguments
15253 Code block functionality can be configured with header arguments. This
15254 section provides an overview of the use of header arguments, and then
15255 describes each header argument in detail.
15258 * Using header arguments:: Different ways to set header arguments
15259 * Specific header arguments:: List of header arguments
15262 @node Using header arguments
15263 @subsection Using header arguments
15265 The values of header arguments can be set in several way. When the header
15266 arguments in each layer have been determined, they are combined in order from
15267 the first, least specific (having the lowest priority) up to the last, most
15268 specific (having the highest priority). A header argument with a higher
15269 priority replaces the same header argument specified at lower priority.
15271 * System-wide header arguments:: Set global default values
15272 * Language-specific header arguments:: Set default values by language
15273 * Header arguments in Org mode properties:: Set default values for a buffer or heading
15274 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
15275 * Code block specific header arguments:: The most common way to set values
15276 * Header arguments in function calls:: The most specific level
15280 @node System-wide header arguments
15281 @subsubheading System-wide header arguments
15282 @vindex org-babel-default-header-args
15283 System-wide values of header arguments can be specified by adapting the
15284 @code{org-babel-default-header-args} variable:
15286 @cindex @code{:session}, src header argument
15287 @cindex @code{:results}, src header argument
15288 @cindex @code{:exports}, src header argument
15289 @cindex @code{:cache}, src header argument
15290 @cindex @code{:noweb}, src header argument
15293 :results => "replace"
15299 For example, the following example could be used to set the default value of
15300 @code{:noweb} header arguments to @code{yes}. This would have the effect of
15301 expanding @code{:noweb} references by default when evaluating source code
15305 (setq org-babel-default-header-args
15306 (cons '(:noweb . "yes")
15307 (assq-delete-all :noweb org-babel-default-header-args)))
15310 @node Language-specific header arguments
15311 @subsubheading Language-specific header arguments
15312 Each language can define its own set of default header arguments in variable
15313 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
15314 of the language. See the language-specific documentation available online at
15315 @uref{http://orgmode.org/worg/org-contrib/babel}.
15317 @node Header arguments in Org mode properties
15318 @subsubheading Header arguments in Org mode properties
15320 Buffer-wide header arguments may be specified as properties through the use
15321 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
15322 @ref{Property syntax}).
15324 For example the following would set @code{session} to @code{*R*} (only for R
15325 code blocks), and @code{results} to @code{silent} for every code block in the
15326 buffer, ensuring that all execution took place in the same session, and no
15327 results would be inserted into the buffer.
15330 #+PROPERTY: header-args:R :session *R*
15331 #+PROPERTY: header-args :results silent
15334 Header arguments read from Org mode properties can also be set on a
15335 per-subtree basis using property drawers (see @ref{Property syntax}).
15336 @vindex org-use-property-inheritance
15337 When properties are used to set default header arguments, they are always
15338 looked up with inheritance, regardless of the value of
15339 @code{org-use-property-inheritance}. Properties are evaluated as seen by the
15340 outermost call or source block.@footnote{The deprecated syntax for default
15341 header argument properties, using the name of the header argument as a
15342 property name directly, evaluates the property as seen by the corresponding
15343 source block definition. This behavior has been kept for backwards
15346 In the following example the value of
15347 the @code{:cache} header argument will default to @code{yes} in all code
15348 blocks in the subtree rooted at the following heading:
15353 :header-args: :cache yes
15358 @vindex org-babel-default-header-args
15359 Properties defined in this way override the properties set in
15360 @code{org-babel-default-header-args} and are applied for all activated
15361 languages. It is convenient to use the @code{org-set-property} function
15362 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
15364 @node Language-specific header arguments in Org mode properties
15365 @subsubheading Language-specific header arguments in Org mode properties
15367 Language-specific header arguments are also read from properties
15368 @code{header-args:<lang>} where @code{<lang>} is the name of the language
15369 targeted. As an example
15374 :header-args:clojure: :session *clojure-1*
15375 :header-args:R: :session *R*
15379 :header-args:clojure: :session *clojure-2*
15383 would independently set a default session header argument for R and clojure
15384 for calls and source blocks under subtree ``Heading'' and change to a
15385 different clojure setting for evaluations under subtree ``Subheading'', while
15386 the R session is inherited from ``Heading'' and therefore unchanged.
15388 @node Code block specific header arguments
15389 @subsubheading Code block specific header arguments
15391 The most common way to assign values to header arguments is at the
15392 code block level. This can be done by listing a sequence of header
15393 arguments and their values as part of the @code{#+BEGIN_SRC} line.
15394 Properties set in this way override both the values of
15395 @code{org-babel-default-header-args} and header arguments specified as
15396 properties. In the following example, the @code{:results} header argument
15397 is set to @code{silent}, meaning the results of execution will not be
15398 inserted in the buffer, and the @code{:exports} header argument is set to
15399 @code{code}, meaning only the body of the code block will be
15400 preserved on export to HTML or @LaTeX{}.
15404 #+BEGIN_SRC haskell :results silent :exports code :var n=0
15406 fac n = n * fac (n-1)
15409 Similarly, it is possible to set header arguments for inline code blocks
15412 src_haskell[:exports both]@{fac 5@}
15415 Code block header arguments can span multiple lines using @code{#+HEADER:} or
15416 @code{#+HEADERS:} lines preceding a code block or nested between the
15417 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
15421 Multi-line header arguments on an un-named code block:
15424 #+HEADERS: :var data1=1
15425 #+BEGIN_SRC emacs-lisp :var data2=2
15426 (message "data1:%S, data2:%S" data1 data2)
15433 Multi-line header arguments on a named code block:
15436 #+NAME: named-block
15437 #+HEADER: :var data=2
15438 #+BEGIN_SRC emacs-lisp
15439 (message "data:%S" data)
15442 #+RESULTS: named-block
15446 @node Header arguments in function calls
15447 @subsubheading Header arguments in function calls
15449 At the most specific level, header arguments for ``Library of Babel'' or
15450 @code{#+CALL:} lines can be set as shown in the two examples below. For more
15451 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
15454 The following will apply the @code{:exports results} header argument to the
15455 evaluation of the @code{#+CALL:} line.
15458 #+CALL: factorial(n=5) :exports results
15461 The following will apply the @code{:session special} header argument to the
15462 evaluation of the @code{factorial} code block.
15465 #+CALL: factorial[:session special](n=5)
15468 @node Specific header arguments
15469 @subsection Specific header arguments
15470 Header arguments consist of an initial colon followed by the name of the
15471 argument in lowercase letters. The following header arguments are defined:
15474 * var:: Pass arguments to code blocks
15475 * results:: Specify the type of results and how they will
15476 be collected and handled
15477 * file:: Specify a path for file output
15478 * file-desc:: Specify a description for file results
15479 * file-ext:: Specify an extension for file output
15480 * output-dir:: Specify a directory to write file output to
15481 * dir:: Specify the default (possibly remote)
15482 directory for code block execution
15483 * exports:: Export code and/or results
15484 * tangle:: Toggle tangling and specify file name
15485 * mkdirp:: Toggle creation of parent directories of target
15486 files during tangling
15487 * comments:: Toggle insertion of comments in tangled
15489 * padline:: Control insertion of padding lines in tangled
15491 * no-expand:: Turn off variable assignment and noweb
15492 expansion during tangling
15493 * session:: Preserve the state of code evaluation
15494 * noweb:: Toggle expansion of noweb references
15495 * noweb-ref:: Specify block's noweb reference resolution target
15496 * noweb-sep:: String used to separate noweb references
15497 * cache:: Avoid re-evaluating unchanged code blocks
15498 * sep:: Delimiter for writing tabular results outside Org
15499 * hlines:: Handle horizontal lines in tables
15500 * colnames:: Handle column names in tables
15501 * rownames:: Handle row names in tables
15502 * shebang:: Make tangled files executable
15503 * tangle-mode:: Set permission of tangled files
15504 * eval:: Limit evaluation of specific code blocks
15505 * wrap:: Mark source block evaluation results
15506 * post:: Post processing of code block results
15507 * prologue:: Text to prepend to code block body
15508 * epilogue:: Text to append to code block body
15511 Additional header arguments are defined on a language-specific basis, see
15515 @subsubsection @code{:var}
15516 @cindex @code{:var}, src header argument
15517 The @code{:var} header argument is used to pass arguments to code blocks.
15518 The specifics of how arguments are included in a code block vary by language;
15519 these are addressed in the language-specific documentation. However, the
15520 syntax used to specify arguments is the same across all languages. In every
15521 case, variables require a default value when they are declared.
15523 The values passed to arguments can either be literal values, references, or
15524 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
15525 References include anything in the Org mode file that takes a @code{#+NAME:}
15526 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
15527 other code blocks and the results of other code blocks.
15529 Note: When a reference is made to another code block, the referenced block
15530 will be evaluated unless it has current cached results (see @ref{cache}).
15532 Argument values can be indexed in a manner similar to arrays (see @ref{var,
15533 Indexable variable values}).
15535 The following syntax is used to pass arguments to code blocks using the
15536 @code{:var} header argument.
15542 The argument, @code{assign}, can either be a literal value, such as a string
15543 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
15544 literal example, another code block (with or without arguments), or the
15545 results of evaluating another code block.
15547 Here are examples of passing values by reference:
15552 an Org mode table named with either a @code{#+NAME:} line
15555 #+NAME: example-table
15561 #+NAME: table-length
15562 #+BEGIN_SRC emacs-lisp :var table=example-table
15566 #+RESULTS: table-length
15571 a simple list named with a @code{#+NAME:} line (note that nesting is not
15572 carried through to the source code block)
15575 #+NAME: example-list
15581 #+BEGIN_SRC emacs-lisp :var x=example-list
15589 @item code block without arguments
15590 a code block name (from the example above), as assigned by @code{#+NAME:},
15591 optionally followed by parentheses
15594 #+BEGIN_SRC emacs-lisp :var length=table-length()
15602 @item code block with arguments
15603 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15604 optional arguments passed within the parentheses following the
15605 code block name using standard function call syntax
15609 #+BEGIN_SRC emacs-lisp :var input=8
15617 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15625 @item literal example
15626 a literal example block named with a @code{#+NAME:} line
15629 #+NAME: literal-example
15635 #+NAME: read-literal-example
15636 #+BEGIN_SRC emacs-lisp :var x=literal-example
15637 (concatenate 'string x " for you.")
15640 #+RESULTS: read-literal-example
15641 : A literal example
15642 : on two lines for you.
15648 @subsubheading Indexable variable values
15649 It is possible to reference portions of variable values by ``indexing'' into
15650 the variables. Indexes are 0 based with negative values counting back from
15651 the end. If an index is separated by @code{,}s then each subsequent section
15652 will index into the next deepest nesting or dimension of the value. Note
15653 that this indexing occurs @emph{before} other table related header arguments
15654 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
15655 following example assigns the last cell of the first row the table
15656 @code{example-table} to the variable @code{data}:
15659 #+NAME: example-table
15665 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15673 Ranges of variable values can be referenced using two integers separated by a
15674 @code{:}, in which case the entire inclusive range is referenced. For
15675 example the following assigns the middle three rows of @code{example-table}
15679 #+NAME: example-table
15686 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15696 Additionally, an empty index, or the single character @code{*}, are both
15697 interpreted to mean the entire range and as such are equivalent to
15698 @code{0:-1}, as shown in the following example in which the entire first
15699 column is referenced.
15702 #+NAME: example-table
15708 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15716 It is possible to index into the results of code blocks as well as tables.
15717 Any number of dimensions can be indexed. Dimensions are separated from one
15718 another by commas, as shown in the following example.
15722 #+BEGIN_SRC emacs-lisp
15723 '(((1 2 3) (4 5 6) (7 8 9))
15724 ((10 11 12) (13 14 15) (16 17 18))
15725 ((19 20 21) (22 23 24) (25 26 27)))
15728 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15736 @subsubheading Emacs Lisp evaluation of variables
15738 Emacs lisp code can be used to initialize variable values. When a variable
15739 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15740 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15741 the variable value. The following example demonstrates use of this
15742 evaluation to reliably pass the file-name of the Org mode buffer to a code
15743 block---note that evaluation of header arguments is guaranteed to take place
15744 in the original Org mode file, while there is no such guarantee for
15745 evaluation of the code block body.
15748 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15753 Note that values read from tables and lists will not be evaluated as
15754 Emacs Lisp, as shown in the following example.
15760 #+HEADERS: :var data=table[0,0]
15770 @subsubsection @code{:results}
15771 @cindex @code{:results}, src header argument
15773 There are four classes of @code{:results} header argument. Only one option
15774 per class may be supplied per code block.
15778 @b{collection} header arguments specify how the results should be collected
15779 from the code block
15781 @b{type} header arguments specify what type of result the code block will
15782 return---which has implications for how they will be processed before
15783 insertion into the Org mode buffer
15785 @b{format} header arguments specify what type of result the code block will
15786 return---which has implications for how they will be inserted into the
15789 @b{handling} header arguments specify how the results of evaluating the code
15790 block should be handled.
15793 @subsubheading Collection
15794 The following options are mutually exclusive, and specify how the results
15795 should be collected from the code block.
15799 This is the default. The result is the value of the last statement in the
15800 code block. This header argument places the evaluation in functional
15801 mode. Note that in some languages, e.g., Python, use of this result type
15802 requires that a @code{return} statement be included in the body of the source
15803 code block. E.g., @code{:results value}.
15804 @item @code{output}
15805 The result is the collection of everything printed to STDOUT during the
15806 execution of the code block. This header argument places the
15807 evaluation in scripting mode. E.g., @code{:results output}.
15810 @subsubheading Type
15812 The following options are mutually exclusive and specify what type of results
15813 the code block will return. By default, results are inserted as either a
15814 table or scalar depending on their value.
15817 @item @code{table}, @code{vector}
15818 The results should be interpreted as an Org mode table. If a single value is
15819 returned, it will be converted into a table with one row and one column.
15820 E.g., @code{:results value table}.
15822 The results should be interpreted as an Org mode list. If a single scalar
15823 value is returned it will be converted into a list with only one element.
15824 @item @code{scalar}, @code{verbatim}
15825 The results should be interpreted literally---they will not be
15826 converted into a table. The results will be inserted into the Org mode
15827 buffer as quoted text. E.g., @code{:results value verbatim}.
15829 The results will be interpreted as the path to a file, and will be inserted
15830 into the Org mode buffer as a file link. E.g., @code{:results value file}.
15833 @subsubheading Format
15835 The following options are mutually exclusive and specify what type of results
15836 the code block will return. By default, results are inserted according to the
15837 type as specified above.
15841 The results are interpreted as raw Org mode code and are inserted directly
15842 into the buffer. If the results look like a table they will be aligned as
15843 such by Org mode. E.g., @code{:results value raw}.
15845 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15846 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15847 in the block and/or if you export the file. E.g., @code{:results value org}.
15849 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
15850 block. E.g., @code{:results value html}.
15852 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
15853 E.g., @code{:results value latex}.
15855 Result are assumed to be parsable code and are enclosed in a code block.
15856 E.g., @code{:results value code}.
15858 The result is converted to pretty-printed code and is enclosed in a code
15859 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
15860 @code{:results value pp}.
15861 @item @code{drawer}
15862 The result is wrapped in a RESULTS drawer. This can be useful for
15863 inserting @code{raw} or @code{org} syntax results in such a way that their
15864 extent is known and they can be automatically removed or replaced.
15867 @subsubheading Handling
15868 The following results options indicate what happens with the
15869 results once they are collected.
15872 @item @code{silent}
15873 The results will be echoed in the minibuffer but will not be inserted into
15874 the Org mode buffer. E.g., @code{:results output silent}.
15875 @item @code{replace}
15876 The default value. Any existing results will be removed, and the new results
15877 will be inserted into the Org mode buffer in their place. E.g.,
15878 @code{:results output replace}.
15879 @item @code{append}
15880 If there are pre-existing results of the code block then the new results will
15881 be appended to the existing results. Otherwise the new results will be
15882 inserted as with @code{replace}.
15883 @item @code{prepend}
15884 If there are pre-existing results of the code block then the new results will
15885 be prepended to the existing results. Otherwise the new results will be
15886 inserted as with @code{replace}.
15890 @subsubsection @code{:file}
15891 @cindex @code{:file}, src header argument
15893 The header argument @code{:file} is used to specify an external file in which
15894 to save code block results. After code block evaluation an Org mode style
15895 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15896 into the Org mode buffer. Some languages including R, gnuplot, dot, and
15897 ditaa provide special handling of the @code{:file} header argument
15898 automatically wrapping the code block body in the boilerplate code required
15899 to save output to the specified file. This is often useful for saving
15900 graphical output of a code block to the specified file.
15902 The argument to @code{:file} should be either a string specifying the path to
15903 a file, or a list of two strings in which case the first element of the list
15904 should be the path to a file and the second a description for the link.
15907 @subsubsection @code{:file-desc}
15909 The value of the @code{:file-desc} header argument is used to provide a
15910 description for file code block results which are inserted as Org mode links
15911 (see @ref{Link format}). If the @code{:file-desc} header argument is given
15912 with no value the link path will be placed in both the ``link'' and the
15913 ``description'' portion of the Org mode link.
15916 @subsubsection @code{:file-ext}
15917 @cindex @code{:file-ext}, src header argument
15919 The value of the @code{:file-ext} header argument is used to provide an
15920 extension to write the file output to. It is combined with the
15921 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15922 header argument to generate a complete file name.
15924 This header arg will be overridden by @code{:file}, and thus has no effect
15925 when the latter is specified.
15928 @subsubsection @code{:output-dir}
15929 @cindex @code{:output-dir}, src header argument
15931 The value of the @code{:output-dir} header argument is used to provide a
15932 directory to write the file output to. It may specify an absolute directory
15933 (beginning with @code{/}) or a relative directory (without @code{/}). It can
15934 be combined with the @code{#+NAME:} of the source block and the value of the
15935 @ref{file-ext} header argument to generate a complete file name, or used
15936 along with a @ref{file} header arg.
15939 @subsubsection @code{:dir} and remote execution
15940 @cindex @code{:dir}, src header argument
15942 While the @code{:file} header argument can be used to specify the path to the
15943 output file, @code{:dir} specifies the default directory during code block
15944 execution. If it is absent, then the directory associated with the current
15945 buffer is used. In other words, supplying @code{:dir path} temporarily has
15946 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15947 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
15948 the value of the Emacs variable @code{default-directory}.
15950 When using @code{:dir}, you should supply a relative path for file output
15951 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15952 case that path will be interpreted relative to the default directory.
15954 In other words, if you want your plot to go into a folder called @file{Work}
15955 in your home directory, you could use
15958 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15959 matplot(matrix(rnorm(100), 10), type="l")
15963 @subsubheading Remote execution
15964 A directory on a remote machine can be specified using tramp file syntax, in
15965 which case the code will be evaluated on the remote machine. An example is
15968 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15969 plot(1:10, main=system("hostname", intern=TRUE))
15973 Text results will be returned to the local Org mode buffer as usual, and file
15974 output will be created on the remote machine with relative paths interpreted
15975 relative to the remote directory. An Org mode link to the remote file will be
15978 So, in the above example a plot will be created on the remote machine,
15979 and a link of the following form will be inserted in the org buffer:
15982 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15985 Most of this functionality follows immediately from the fact that @code{:dir}
15986 sets the value of the Emacs variable @code{default-directory}, thanks to
15987 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
15988 install tramp separately in order for these features to work correctly.
15990 @subsubheading Further points
15994 If @code{:dir} is used in conjunction with @code{:session}, although it will
15995 determine the starting directory for a new session as expected, no attempt is
15996 currently made to alter the directory associated with an existing session.
15998 @code{:dir} should typically not be used to create files during export with
15999 @code{:exports results} or @code{:exports both}. The reason is that, in order
16000 to retain portability of exported material between machines, during export
16001 links inserted into the buffer will @emph{not} be expanded against @code{default
16002 directory}. Therefore, if @code{default-directory} is altered using
16003 @code{:dir}, it is probable that the file will be created in a location to
16004 which the link does not point.
16008 @subsubsection @code{:exports}
16009 @cindex @code{:exports}, src header argument
16011 The @code{:exports} header argument specifies what should be included in HTML
16012 or @LaTeX{} exports of the Org mode file. Note that the @code{:exports}
16013 option is only relevant for code blocks, not inline code.
16017 The default. The body of code is included into the exported file. E.g.,
16018 @code{:exports code}.
16019 @item @code{results}
16020 The result of evaluating the code is included in the exported file. E.g.,
16021 @code{:exports results}.
16023 Both the code and results are included in the exported file. E.g.,
16024 @code{:exports both}.
16026 Nothing is included in the exported file. E.g., @code{:exports none}.
16030 @subsubsection @code{:tangle}
16031 @cindex @code{:tangle}, src header argument
16033 The @code{:tangle} header argument specifies whether or not the code
16034 block should be included in tangled extraction of source code files.
16037 @item @code{tangle}
16038 The code block is exported to a source code file named after the full path
16039 (including the directory) and file name (w/o extension) of the Org mode file.
16040 E.g., @code{:tangle yes}.
16042 The default. The code block is not exported to a source code file.
16043 E.g., @code{:tangle no}.
16045 Any other string passed to the @code{:tangle} header argument is interpreted
16046 as a path (directory and file name relative to the directory of the Org mode
16047 file) to which the block will be exported. E.g., @code{:tangle path}.
16051 @subsubsection @code{:mkdirp}
16052 @cindex @code{:mkdirp}, src header argument
16054 The @code{:mkdirp} header argument can be used to create parent directories
16055 of tangled files when missing. This can be set to @code{yes} to enable
16056 directory creation or to @code{no} to inhibit directory creation.
16059 @subsubsection @code{:comments}
16060 @cindex @code{:comments}, src header argument
16061 By default code blocks are tangled to source-code files without any insertion
16062 of comments beyond those which may already exist in the body of the code
16063 block. The @code{:comments} header argument can be set as follows to control
16064 the insertion of extra comments into the tangled code file.
16068 The default. No extra comments are inserted during tangling.
16070 The code block is wrapped in comments which contain pointers back to the
16071 original Org file from which the code was tangled.
16073 A synonym for ``link'' to maintain backwards compatibility.
16075 Include text from the Org mode file as a comment.
16076 The text is picked from the leading context of the tangled code and is
16077 limited by the nearest headline or source block as the case may be.
16079 Turns on both the ``link'' and ``org'' comment options.
16081 Turns on the ``link'' comment option, and additionally wraps expanded noweb
16082 references in the code block body in link comments.
16086 @subsubsection @code{:padline}
16087 @cindex @code{:padline}, src header argument
16088 Control in insertion of padding lines around code block bodies in tangled
16089 code files. The default value is @code{yes} which results in insertion of
16090 newlines before and after each tangled code block. The following arguments
16095 Insert newlines before and after each code block body in tangled code files.
16097 Do not insert any newline padding in tangled output.
16101 @subsubsection @code{:no-expand}
16102 @cindex @code{:no-expand}, src header argument
16104 By default, code blocks are expanded with @code{org-babel-expand-src-block}
16105 during tangling. This has the effect of assigning values to variables
16106 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
16107 references (see @ref{Noweb reference syntax}) with their targets. The
16108 @code{:no-expand} header argument can be used to turn off this behavior.
16109 Note: The @code{:no-expand} header argument has no impact on export,
16110 i.e. code blocks will irrespective of this header argument expanded for
16114 @subsubsection @code{:session}
16115 @cindex @code{:session}, src header argument
16117 The @code{:session} header argument starts a (possibly named) session for an
16118 interpreted language where the interpreter’s state is preserved. All code
16119 blocks sharing the same name are exectuted by the same interpreter process.
16120 By default, a session is not started.
16124 The default. Each block is evaluated in its own interpreter process, which
16125 is terminated after the evaluation.
16127 Any other string passed to the @code{:session} header argument will give the
16128 session a name. For example, @code{:session mysession}. If @code{:session}
16129 is given but no name string is specified, the session is named according to
16130 the language used in the block. All blocks with the same session name share
16131 the same session. Using different session names enables concurrent sessions
16132 (even for the same interpreted language, if the language supports multiple
16138 @subsubsection @code{:noweb}
16139 @cindex @code{:noweb}, src header argument
16141 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
16142 references (see @ref{Noweb reference syntax}) when the code block is
16143 evaluated, tangled, or exported. The @code{:noweb} header argument can have
16144 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
16145 @code{no-export} @code{strip-export}.
16149 The default. ``Noweb'' syntax references in the body of the code block will
16150 not be expanded before the code block is evaluated, tangled or exported.
16152 ``Noweb'' syntax references in the body of the code block will be
16153 expanded before the code block is evaluated, tangled or exported.
16154 @item @code{tangle}
16155 ``Noweb'' syntax references in the body of the code block will be expanded
16156 before the code block is tangled. However, ``noweb'' syntax references will
16157 not be expanded when the code block is evaluated or exported.
16158 @item @code{no-export}
16159 ``Noweb'' syntax references in the body of the code block will be expanded
16160 before the block is evaluated or tangled. However, ``noweb'' syntax
16161 references will not be expanded when the code block is exported.
16162 @item @code{strip-export}
16163 ``Noweb'' syntax references in the body of the code block will be expanded
16164 before the block is evaluated or tangled. However, ``noweb'' syntax
16165 references will be removed when the code block is exported.
16167 ``Noweb'' syntax references in the body of the code block will only be
16168 expanded before the block is evaluated.
16171 @subsubheading Noweb prefix lines
16172 Noweb insertions are now placed behind the line prefix of the
16173 @code{<<reference>>}.
16174 This behavior is illustrated in the following example. Because the
16175 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
16176 each line of the expanded noweb reference will be commented.
16188 -- multi-line body of example
16191 Note that noweb replacement text that does not contain any newlines will not
16192 be affected by this change, so it is still possible to use inline noweb
16196 @subsubsection @code{:noweb-ref}
16197 @cindex @code{:noweb-ref}, src header argument
16198 When expanding ``noweb'' style references, the bodies of all code block with
16199 @emph{either} a block name matching the reference name @emph{or} a
16200 @code{:noweb-ref} header argument matching the reference name will be
16201 concatenated together to form the replacement text.
16203 By setting this header argument at the subtree or file level, simple code
16204 block concatenation may be achieved. For example, when tangling the
16205 following Org mode file, the bodies of code blocks will be concatenated into
16206 the resulting pure code file@footnote{(The example needs property inheritance
16207 to be turned on for the @code{noweb-ref} property, see @ref{Property
16211 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
16214 * the mount point of the fullest disk
16216 :noweb-ref: fullest-disk
16219 ** query all mounted disks
16224 ** strip the header row
16229 ** sort by the percent full
16231 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
16234 ** extract the mount point
16236 |awk '@{print $2@}'
16240 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
16241 used to separate accumulate noweb references like those above. By default a
16245 @subsubsection @code{:noweb-sep}
16246 @cindex @code{:noweb-sep}, src header argument
16248 The @code{:noweb-sep} header argument holds the string used to separate
16249 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
16253 @subsubsection @code{:cache}
16254 @cindex @code{:cache}, src header argument
16256 The @code{:cache} header argument controls the use of in-buffer caching of
16257 the results of evaluating code blocks. It can be used to avoid re-evaluating
16258 unchanged code blocks. When the cache is active, a source block is not
16259 re-evaluated if a result for it is present in the buffer and neither the
16260 header arguments (including the value of @code{:var} references) nor the text
16261 of the block itself has changed since the result was computed. The feature
16262 helps avoid re-running long calculations. However, there are edge cases and
16263 you should not rely on the cache to behave reliably in all circumstances.
16265 The caching feature works best when a babel block is a pure function of its
16266 arguments (@pxref{var}). That is, the function always returns the same
16267 results when given the same arguments, and does not touch external resources
16268 (like the filesystem or the language’s RNG) in any way.@footnote{The
16269 documentation of the knitr reproducible research package for the R language
16270 has some good discussion of issues that may arise when using the cache in
16271 such a context. See @uref{http://yihui.name/knitr/demo/cache/}, especially
16272 the sections ``Even more stuff for cache?'' and ``Reproducibility with RNG''.
16273 (Obviously, you will have to abstract away from the knitr implementation
16274 details which the documentation also discusses.)}
16276 Note that the @code{:cache} header argument will attempt to cache results
16277 when the @code{:session} header argument is used, even though the results of
16278 the code block execution stored in the session may lead to unexpected
16281 Noweb references (@pxref{Noweb reference syntax}) are currently not expanded
16282 when calculating whether the text of the code block has changed. Perhaps in
16283 principle they ought to be, but this could introduce unexpected complexity.
16284 See @uref{http://thread.gmane.org/gmane.emacs.orgmode/79046}.
16286 The @code{:cache} header argument can have one of two values: @code{yes} or
16291 The default. No caching takes place, and the code block will be evaluated
16292 every time it is called.
16294 Every time the code block is run a SHA1 hash of the code and arguments
16295 passed to the block will be generated. This hash is packed into the
16296 @code{#+RESULTS:} line and will be checked on subsequent
16297 executions of the code block. If the code block has not
16298 changed since the last time it was evaluated, it will not be re-evaluated.
16301 Code block caches notice if the value of a variable argument
16302 to the code block has changed. If this is the case, the cache is
16303 invalidated and the code block is re-run. In the following example,
16304 @code{caller} will not be re-run unless the results of @code{random} have
16305 changed since it was last run.
16309 #+BEGIN_SRC R :cache yes
16313 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
16317 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
16321 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
16326 @subsubsection @code{:sep}
16327 @cindex @code{:sep}, src header argument
16329 The @code{:sep} header argument can be used to control the delimiter used
16330 when writing tabular results out to files external to Org mode. This is used
16331 either when opening tabular results of a code block by calling the
16332 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
16333 or when writing code block results to an external file (see @ref{file})
16336 By default, when @code{:sep} is not specified output tables are tab
16340 @subsubsection @code{:hlines}
16341 @cindex @code{:hlines}, src header argument
16343 Tables are frequently represented with one or more horizontal lines, or
16344 hlines. The @code{:hlines} argument to a code block accepts the
16345 values @code{yes} or @code{no}, with a default value of @code{no}.
16349 Strips horizontal lines from the input table. In most languages this is the
16350 desired effect because an @code{hline} symbol is interpreted as an unbound
16351 variable and raises an error. Setting @code{:hlines no} or relying on the
16352 default value yields the following results.
16363 #+BEGIN_SRC python :var tab=many-cols
16367 #+RESULTS: echo-table
16374 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
16385 #+BEGIN_SRC python :var tab=many-cols :hlines yes
16389 #+RESULTS: echo-table
16399 @subsubsection @code{:colnames}
16400 @cindex @code{:colnames}, src header argument
16402 The @code{:colnames} header argument accepts the values @code{yes},
16403 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
16404 Note that the behavior of the @code{:colnames} header argument may differ
16409 If an input table looks like it has column names
16410 (because its second row is an hline), then the column
16411 names will be removed from the table before
16412 processing, then reapplied to the results.
16421 #+NAME: echo-table-again
16422 #+BEGIN_SRC python :var tab=less-cols
16423 return [[val + '*' for val in row] for row in tab]
16426 #+RESULTS: echo-table-again
16433 Please note that column names are not removed before the table is indexed
16434 using variable indexing @xref{var, Indexable variable values}.
16437 No column name pre-processing takes place
16440 Column names are removed and reapplied as with @code{nil} even if the table
16441 does not ``look like'' it has column names (i.e., the second row is not an
16446 @subsubsection @code{:rownames}
16447 @cindex @code{:rownames}, src header argument
16449 The @code{:rownames} header argument can take on the values @code{yes} or
16450 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
16451 blocks ignore the @code{:rownames} header argument entirely given the ease
16452 with which tables with row names may be handled directly in Emacs Lisp.
16456 No row name pre-processing will take place.
16459 The first column of the table is removed from the table before processing,
16460 and is then reapplied to the results.
16463 #+NAME: with-rownames
16464 | one | 1 | 2 | 3 | 4 | 5 |
16465 | two | 6 | 7 | 8 | 9 | 10 |
16467 #+NAME: echo-table-once-again
16468 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
16469 return [[val + 10 for val in row] for row in tab]
16472 #+RESULTS: echo-table-once-again
16473 | one | 11 | 12 | 13 | 14 | 15 |
16474 | two | 16 | 17 | 18 | 19 | 20 |
16477 Please note that row names are not removed before the table is indexed using
16478 variable indexing @xref{var, Indexable variable values}.
16483 @subsubsection @code{:shebang}
16484 @cindex @code{:shebang}, src header argument
16486 Setting the @code{:shebang} header argument to a string value
16487 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
16488 first line of any tangled file holding the code block, and the file
16489 permissions of the tangled file are set to make it executable.
16493 @subsubsection @code{:tangle-mode}
16494 @cindex @code{:tangle-mode}, src header argument
16496 The @code{tangle-mode} header argument controls the permission set on tangled
16497 files. The value of this header argument will be passed to
16498 @code{set-file-modes}. For example, to set a tangled file as read only use
16499 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
16500 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
16501 (@ref{shebang}) header arguments will automatically be made executable unless
16502 the @code{tangle-mode} header argument is also used. The behavior is
16503 undefined if multiple code blocks with different values for the
16504 @code{tangle-mode} header argument are tangled to the same file.
16507 @subsubsection @code{:eval}
16508 @cindex @code{:eval}, src header argument
16509 The @code{:eval} header argument can be used to limit the evaluation of
16510 specific code blocks. The @code{:eval} header argument can be useful for
16511 protecting against the evaluation of dangerous code blocks or to ensure that
16512 evaluation will require a query regardless of the value of the
16513 @code{org-confirm-babel-evaluate} variable. The possible values of
16514 @code{:eval} and their effects are shown below.
16518 The code block will not be evaluated under any circumstances.
16520 Evaluation of the code block will require a query.
16521 @item never-export or no-export
16522 The code block will not be evaluated during export but may still be called
16525 Evaluation of the code block during export will require a query.
16528 If this header argument is not set then evaluation is determined by the value
16529 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
16533 @subsubsection @code{:wrap}
16534 @cindex @code{:wrap}, src header argument
16535 The @code{:wrap} header argument is used to mark the results of source block
16536 evaluation. The header argument can be passed a string that will be appended
16537 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
16538 results. If not string is specified then the results will be wrapped in a
16539 @code{#+BEGIN/END_RESULTS} block.
16542 @subsubsection @code{:post}
16543 @cindex @code{:post}, src header argument
16544 The @code{:post} header argument is used to post-process the results of a
16545 code block execution. When a post argument is given, the results of the code
16546 block will temporarily be bound to the @code{*this*} variable. This variable
16547 may then be included in header argument forms such as those used in @ref{var}
16548 header argument specifications allowing passing of results to other code
16549 blocks, or direct execution via Emacs Lisp. Additional header arguments may
16550 be passed to the @code{:post}-function.
16552 The following two examples illustrate the usage of the @code{:post} header
16553 argument. The first example shows how to attach a attribute-line via @code{:post}.
16557 #+begin_src sh :var data="" :var width="\\textwidth" :results output
16558 echo "#+ATTR_LATEX: :width $width"
16562 #+header: :file /tmp/it.png
16563 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
16573 #+ATTR_LATEX :width 5cm
16574 [[file:/tmp/it.png]]
16578 The second examples shows how to use @code{:post} together with the
16579 @code{:colnames} header argument.
16582 #+begin_src emacs-lisp :var tbl="" fmt="%.3f"
16583 (mapcar (lambda (row)
16584 (mapcar (lambda (cell)
16592 #+begin_src R :colnames yes :post round-tbl[:colnames yes](*this*)
16594 data.frame(foo=rnorm(1))
16604 @subsubsection @code{:prologue}
16605 @cindex @code{:prologue}, src header argument
16606 The value of the @code{prologue} header argument will be prepended to the
16607 code block body before execution. For example, @code{:prologue "reset"} may
16608 be used to reset a gnuplot session before execution of a particular code
16609 block, or the following configuration may be used to do this for all gnuplot
16610 code blocks. Also see @ref{epilogue}.
16613 (add-to-list 'org-babel-default-header-args:gnuplot
16614 '((:prologue . "reset")))
16618 @subsubsection @code{:epilogue}
16619 @cindex @code{:epilogue}, src header argument
16620 The value of the @code{epilogue} header argument will be appended to the code
16621 block body before execution. Also see @ref{prologue}.
16623 @node Results of evaluation
16624 @section Results of evaluation
16625 @cindex code block, results of evaluation
16626 @cindex source code, results of evaluation
16628 The way in which results are handled depends on whether a session is invoked,
16629 as well as on whether @code{:results value} or @code{:results output} is
16630 used. The following table shows the table possibilities. For a full listing
16631 of the possible results header arguments see @ref{results}.
16633 @multitable @columnfractions 0.26 0.33 0.41
16634 @item @tab @b{Non-session} @tab @b{Session}
16635 @item @code{:results value} @tab value of last expression @tab value of last expression
16636 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16639 Note: With @code{:results value}, the result in both @code{:session} and
16640 non-session is returned to Org mode as a table (a one- or two-dimensional
16641 vector of strings or numbers) when appropriate.
16643 @subsection Non-session
16644 @subsubsection @code{:results value}
16645 @cindex @code{:results}, src header argument
16646 This is the default. Internally, the value is obtained by wrapping the code
16647 in a function definition in the external language, and evaluating that
16648 function. Therefore, code should be written as if it were the body of such a
16649 function. In particular, note that Python does not automatically return a
16650 value from a function unless a @code{return} statement is present, and so a
16651 @samp{return} statement will usually be required in Python.
16653 This is the only one of the four evaluation contexts in which the code is
16654 automatically wrapped in a function definition.
16656 @subsubsection @code{:results output}
16657 @cindex @code{:results}, src header argument
16658 The code is passed to the interpreter as an external process, and the
16659 contents of the standard output stream are returned as text. (In certain
16660 languages this also contains the error output stream; this is an area for
16663 @subsection Session
16664 @subsubsection @code{:results value}
16665 @cindex @code{:results}, src header argument
16666 The code is passed to an interpreter running as an interactive Emacs inferior
16667 process. Only languages which provide tools for interactive evaluation of
16668 code have session support, so some language (e.g., C and ditaa) do not
16669 support the @code{:session} header argument, and in other languages (e.g.,
16670 Python and Haskell) which have limitations on the code which may be entered
16671 into interactive sessions, those limitations apply to the code in code blocks
16672 using the @code{:session} header argument as well.
16674 Unless the @code{:results output} option is supplied (see below) the result
16675 returned is the result of the last evaluation performed by the
16676 interpreter. (This is obtained in a language-specific manner: the value of
16677 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16680 @subsubsection @code{:results output}
16681 @cindex @code{:results}, src header argument
16682 The code is passed to the interpreter running as an interactive Emacs
16683 inferior process. The result returned is the concatenation of the sequence of
16684 (text) output from the interactive interpreter. Notice that this is not
16685 necessarily the same as what would be sent to @code{STDOUT} if the same code
16686 were passed to a non-interactive interpreter running as an external
16687 process. For example, compare the following two blocks:
16690 #+BEGIN_SRC python :results output
16701 In non-session mode, the ``2'' is not printed and does not appear.
16704 #+BEGIN_SRC python :results output :session
16716 But in @code{:session} mode, the interactive interpreter receives input ``2''
16717 and prints out its value, ``2''. (Indeed, the other print statements are
16720 @node Noweb reference syntax
16721 @section Noweb reference syntax
16722 @cindex code block, noweb reference
16723 @cindex syntax, noweb
16724 @cindex source code, noweb reference
16726 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16727 Programming system allows named blocks of code to be referenced by using the
16728 familiar Noweb syntax:
16731 <<code-block-name>>
16734 When a code block is tangled or evaluated, whether or not ``noweb''
16735 references are expanded depends upon the value of the @code{:noweb} header
16736 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
16737 evaluation. If @code{:noweb no}, the default, then the reference is not
16738 expanded before evaluation. See the @ref{noweb-ref} header argument for
16739 a more flexible way to resolve noweb references.
16741 It is possible to include the @emph{results} of a code block rather than the
16742 body. This is done by appending parenthesis to the code block name which may
16743 optionally contain arguments to the code block as shown below.
16746 <<code-block-name(optional arguments)>>
16749 Note: the default value, @code{:noweb no}, was chosen to ensure that
16750 correct code is not broken in a language, such as Ruby, where
16751 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
16752 syntactically valid in languages that you use, then please consider setting
16755 Note: if noweb tangling is slow in large Org mode files consider setting the
16756 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16757 This will result in faster noweb reference resolution at the expense of not
16758 correctly resolving inherited values of the @code{:noweb-ref} header
16761 @node Key bindings and useful functions
16762 @section Key bindings and useful functions
16763 @cindex code block, key bindings
16765 Many common Org mode key sequences are re-bound depending on
16768 Within a code block, the following key bindings
16771 @multitable @columnfractions 0.25 0.75
16773 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16775 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16777 @item @kbd{M-@key{up}} @tab @code{org-babel-load-in-session}
16779 @item @kbd{M-@key{down}} @tab @code{org-babel-switch-to-session}
16782 In an Org mode buffer, the following key bindings are active:
16784 @multitable @columnfractions 0.45 0.55
16786 @kindex C-c C-v C-p
16787 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16789 @kindex C-c C-v C-n
16790 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16792 @kindex C-c C-v C-e
16793 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16795 @kindex C-c C-v C-o
16796 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16798 @kindex C-c C-v C-v
16799 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16801 @kindex C-c C-v C-u
16802 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16804 @kindex C-c C-v C-g
16805 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16807 @kindex C-c C-v C-r
16808 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16810 @kindex C-c C-v C-b
16811 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16813 @kindex C-c C-v C-s
16814 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16816 @kindex C-c C-v C-d
16817 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16819 @kindex C-c C-v C-t
16820 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16822 @kindex C-c C-v C-f
16823 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16825 @kindex C-c C-v C-c
16826 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16828 @kindex C-c C-v C-j
16829 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16831 @kindex C-c C-v C-l
16832 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16834 @kindex C-c C-v C-i
16835 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16837 @kindex C-c C-v C-I
16838 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16840 @kindex C-c C-v C-z
16841 @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}
16843 @kindex C-c C-v C-a
16844 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16846 @kindex C-c C-v C-h
16847 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16849 @kindex C-c C-v C-x
16850 @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}
16853 @c When possible these key bindings were extended to work when the control key is
16854 @c kept pressed, resulting in the following additional key bindings.
16856 @c @multitable @columnfractions 0.25 0.75
16857 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16858 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16859 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16860 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16861 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16862 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16863 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16864 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16867 @node Batch execution
16868 @section Batch execution
16869 @cindex code block, batch execution
16870 @cindex source code, batch execution
16872 It is possible to call functions from the command line. This shell
16873 script calls @code{org-babel-tangle} on every one of its arguments.
16875 Be sure to adjust the paths to fit your system.
16879 # -*- mode: shell-script -*-
16881 # tangle files with org-mode
16886 # wrap each argument in the code required to call tangle on it
16888 FILES="$FILES \"$i\""
16893 (require 'org)(require 'ob)(require 'ob-tangle)
16894 (mapc (lambda (file)
16895 (find-file (expand-file-name file \"$DIR\"))
16897 (kill-buffer)) '($FILES)))" 2>&1 |grep -i tangled
16900 @node Miscellaneous
16901 @chapter Miscellaneous
16904 * Completion:: M-TAB knows what you need
16905 * Easy templates:: Quick insertion of structural elements
16906 * Speed keys:: Electric commands at the beginning of a headline
16907 * Code evaluation security:: Org mode files evaluate inline code
16908 * Customization:: Adapting Org to your taste
16909 * In-buffer settings:: Overview of the #+KEYWORDS
16910 * The very busy C-c C-c key:: When in doubt, press C-c C-c
16911 * Clean view:: Getting rid of leading stars in the outline
16912 * TTY keys:: Using Org on a tty
16913 * Interaction:: Other Emacs packages
16914 * org-crypt:: Encrypting Org files
16919 @section Completion
16920 @cindex completion, of @TeX{} symbols
16921 @cindex completion, of TODO keywords
16922 @cindex completion, of dictionary words
16923 @cindex completion, of option keywords
16924 @cindex completion, of tags
16925 @cindex completion, of property keys
16926 @cindex completion, of link abbreviations
16927 @cindex @TeX{} symbol completion
16928 @cindex TODO keywords completion
16929 @cindex dictionary word completion
16930 @cindex option keyword completion
16931 @cindex tag completion
16932 @cindex link abbreviations, completion of
16934 Emacs would not be Emacs without completion, and Org mode uses it whenever it
16935 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
16936 some of the completion prompts, you can specify your preference by setting at
16937 most one of the variables @code{org-completion-use-iswitchb}
16938 @code{org-completion-use-ido}.
16940 Org supports in-buffer completion. This type of completion does
16941 not make use of the minibuffer. You simply type a few letters into
16942 the buffer and use the key to complete text right there.
16945 @kindex M-@key{TAB}
16947 Complete word at point
16950 At the beginning of a headline, complete TODO keywords.
16952 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16954 After @samp{*}, complete headlines in the current buffer so that they
16955 can be used in search links like @samp{[[*find this headline]]}.
16957 After @samp{:} in a headline, complete tags. The list of tags is taken
16958 from the variable @code{org-tag-alist} (possibly set through the
16959 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16960 dynamically from all tags used in the current buffer.
16962 After @samp{:} and not in a headline, complete property keys. The list
16963 of keys is constructed dynamically from all keys used in the current
16966 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16968 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16969 @samp{OPTIONS} which set file-specific options for Org mode. When the
16970 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16971 will insert example settings for this keyword.
16973 In the line after @samp{#+STARTUP: }, complete startup keywords,
16974 i.e., valid keys for this line.
16976 Elsewhere, complete dictionary words using Ispell.
16980 @node Easy templates
16981 @section Easy templates
16982 @cindex template insertion
16983 @cindex insertion, of templates
16985 Org mode supports insertion of empty structural elements (like
16986 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16987 strokes. This is achieved through a native template expansion mechanism.
16988 Note that Emacs has several other template mechanisms which could be used in
16989 a similar way, for example @file{yasnippet}.
16991 To insert a structural element, type a @samp{<}, followed by a template
16992 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
16993 keystrokes are typed on a line by itself.
16995 The following template selectors are currently supported.
16997 @multitable @columnfractions 0.1 0.9
16998 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
16999 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
17000 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
17001 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
17002 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
17003 @item @kbd{l} @tab @code{#+BEGIN_EXPORT latex ... #+END_EXPORT}
17004 @item @kbd{L} @tab @code{#+LATEX:}
17005 @item @kbd{h} @tab @code{#+BEGIN_EXPORT html ... #+END_EXPORT}
17006 @item @kbd{H} @tab @code{#+HTML:}
17007 @item @kbd{a} @tab @code{#+BEGIN_EXPORT ascii ... #+END_EXPORT}
17008 @item @kbd{A} @tab @code{#+ASCII:}
17009 @item @kbd{i} @tab @code{#+INDEX:} line
17010 @item @kbd{I} @tab @code{#+INCLUDE:} line
17013 For example, on an empty line, typing "<e" and then pressing TAB, will expand
17014 into a complete EXAMPLE template.
17016 You can install additional templates by customizing the variable
17017 @code{org-structure-template-alist}. See the docstring of the variable for
17018 additional details.
17021 @section Speed keys
17023 @vindex org-use-speed-commands
17024 @vindex org-speed-commands-user
17026 Single keys can be made to execute commands when the cursor is at the
17027 beginning of a headline, i.e., before the first star. Configure the variable
17028 @code{org-use-speed-commands} to activate this feature. There is a
17029 pre-defined list of commands, and you can add more such commands using the
17030 variable @code{org-speed-commands-user}. Speed keys not only speed up
17031 navigation and other commands, but they also provide an alternative way to
17032 execute commands bound to keys that are not or not easily available on a TTY,
17033 or on a small mobile device with a limited keyboard.
17035 To see which commands are available, activate the feature and press @kbd{?}
17036 with the cursor at the beginning of a headline.
17038 @node Code evaluation security
17039 @section Code evaluation and security issues
17041 Org provides tools to work with code snippets, including evaluating them.
17043 Running code on your machine always comes with a security risk. Badly
17044 written or malicious code can be executed on purpose or by accident. Org has
17045 default settings which will only evaluate such code if you give explicit
17046 permission to do so, and as a casual user of these features you should leave
17047 these precautions intact.
17049 For people who regularly work with such code, the confirmation prompts can
17050 become annoying, and you might want to turn them off. This can be done, but
17051 you must be aware of the risks that are involved.
17053 Code evaluation can happen under the following circumstances:
17056 @item Source code blocks
17057 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
17058 C-c} in the block. The most important thing to realize here is that Org mode
17059 files which contain code snippets are, in a certain sense, like executable
17060 files. So you should accept them and load them into Emacs only from trusted
17061 sources---just like you would do with a program you install on your computer.
17063 Make sure you know what you are doing before customizing the variables
17064 which take off the default security brakes.
17066 @defopt org-confirm-babel-evaluate
17067 When t (the default), the user is asked before every code block evaluation.
17068 When @code{nil}, the user is not asked. When set to a function, it is called with
17069 two arguments (language and body of the code block) and should return t to
17070 ask and @code{nil} not to ask.
17073 For example, here is how to execute "ditaa" code (which is considered safe)
17077 (defun my-org-confirm-babel-evaluate (lang body)
17078 (not (string= lang "ditaa"))) ; don't ask for ditaa
17079 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
17082 @item Following @code{shell} and @code{elisp} links
17083 Org has two link types that can directly evaluate code (@pxref{External
17084 links}). These links can be problematic because the code to be evaluated is
17087 @defopt org-confirm-shell-link-function
17088 Function to queries user about shell link execution.
17090 @defopt org-confirm-elisp-link-function
17091 Functions to query user for Emacs Lisp link execution.
17094 @item Formulas in tables
17095 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
17096 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
17099 @node Customization
17100 @section Customization
17101 @cindex customization
17102 @cindex options, for customization
17103 @cindex variables, for customization
17105 There are more than 500 variables that can be used to customize
17106 Org. For the sake of compactness of the manual, I am not
17107 describing the variables here. A structured overview of customization
17108 variables is available with @kbd{M-x org-customize RET}. Or select
17109 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
17110 settings can also be activated on a per-file basis, by putting special
17111 lines into the buffer (@pxref{In-buffer settings}).
17113 @node In-buffer settings
17114 @section Summary of in-buffer settings
17115 @cindex in-buffer settings
17116 @cindex special keywords
17118 Org mode uses special lines in the buffer to define settings on a
17119 per-file basis. These lines start with a @samp{#+} followed by a
17120 keyword, a colon, and then individual words defining a setting. Several
17121 setting words can be in the same line, but you can also have multiple
17122 lines for the keyword. While these settings are described throughout
17123 the manual, here is a summary. After changing any of these lines in the
17124 buffer, press @kbd{C-c C-c} with the cursor still in the line to
17125 activate the changes immediately. Otherwise they become effective only
17126 when the file is visited again in a new Emacs session.
17128 @vindex org-archive-location
17130 @item #+ARCHIVE: %s_done::
17131 This line sets the archive location for the agenda file. It applies for
17132 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
17133 of the file. The first such line also applies to any entries before it.
17134 The corresponding variable is @code{org-archive-location}.
17136 This line sets the category for the agenda file. The category applies to the
17138 @item #+COLUMNS: %25ITEM ...
17139 @cindex property, COLUMNS
17140 Set the default format for columns view. This format applies when
17141 columns view is invoked in locations where no @code{COLUMNS} property
17143 @item #+CONSTANTS: name1=value1 ...
17144 @vindex org-table-formula-constants
17145 @vindex org-table-formula
17146 Set file-local values for constants to be used in table formulas. This
17147 line sets the local variable @code{org-table-formula-constants-local}.
17148 The global version of this variable is
17149 @code{org-table-formula-constants}.
17150 @item #+FILETAGS: :tag1:tag2:tag3:
17151 Set tags that can be inherited by any entry in the file, including the
17153 @item #+LINK: linkword replace
17154 @vindex org-link-abbrev-alist
17155 These lines (several are allowed) specify link abbreviations.
17156 @xref{Link abbreviations}. The corresponding variable is
17157 @code{org-link-abbrev-alist}.
17158 @item #+PRIORITIES: highest lowest default
17159 @vindex org-highest-priority
17160 @vindex org-lowest-priority
17161 @vindex org-default-priority
17162 This line sets the limits and the default for the priorities. All three
17163 must be either letters A--Z or numbers 0--9. The highest priority must
17164 have a lower ASCII number than the lowest priority.
17165 @item #+PROPERTY: Property_Name Value
17166 This line sets a default inheritance value for entries in the current
17167 buffer, most useful for specifying the allowed values of a property.
17168 @cindex #+SETUPFILE
17169 @item #+SETUPFILE: file
17170 This line defines a file that holds more in-buffer setup. Normally this is
17171 entirely ignored. Only when the buffer is parsed for option-setting lines
17172 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
17173 settings line, or when exporting), then the contents of this file are parsed
17174 as if they had been included in the buffer. In particular, the file can be
17175 any other Org mode file with internal setup. You can visit the file the
17176 cursor is in the line with @kbd{C-c '}.
17179 This line sets options to be used at startup of Org mode, when an
17180 Org file is being visited.
17182 The first set of options deals with the initial visibility of the outline
17183 tree. The corresponding variable for global default settings is
17184 @code{org-startup-folded}, with a default value @code{t}, which means
17186 @vindex org-startup-folded
17187 @cindex @code{overview}, STARTUP keyword
17188 @cindex @code{content}, STARTUP keyword
17189 @cindex @code{showall}, STARTUP keyword
17190 @cindex @code{showeverything}, STARTUP keyword
17192 overview @r{top-level headlines only}
17193 content @r{all headlines}
17194 showall @r{no folding of any entries}
17195 showeverything @r{show even drawer contents}
17198 @vindex org-startup-indented
17199 @cindex @code{indent}, STARTUP keyword
17200 @cindex @code{noindent}, STARTUP keyword
17201 Dynamic virtual indentation is controlled by the variable
17202 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
17204 indent @r{start with @code{org-indent-mode} turned on}
17205 noindent @r{start with @code{org-indent-mode} turned off}
17208 @vindex org-startup-align-all-tables
17209 Then there are options for aligning tables upon visiting a file. This
17210 is useful in files containing narrowed table columns. The corresponding
17211 variable is @code{org-startup-align-all-tables}, with a default value
17213 @cindex @code{align}, STARTUP keyword
17214 @cindex @code{noalign}, STARTUP keyword
17216 align @r{align all tables}
17217 noalign @r{don't align tables on startup}
17220 @vindex org-startup-with-inline-images
17221 When visiting a file, inline images can be automatically displayed. The
17222 corresponding variable is @code{org-startup-with-inline-images}, with a
17223 default value @code{nil} to avoid delays when visiting a file.
17224 @cindex @code{inlineimages}, STARTUP keyword
17225 @cindex @code{noinlineimages}, STARTUP keyword
17227 inlineimages @r{show inline images}
17228 noinlineimages @r{don't show inline images on startup}
17231 @vindex org-startup-with-latex-preview
17232 When visiting a file, @LaTeX{} fragments can be converted to images
17233 automatically. The variable @code{org-startup-with-latex-preview} which
17234 controls this behavior, is set to @code{nil} by default to avoid delays on
17236 @cindex @code{latexpreview}, STARTUP keyword
17237 @cindex @code{nolatexpreview}, STARTUP keyword
17239 latexpreview @r{preview @LaTeX{} fragments}
17240 nolatexpreview @r{don't preview @LaTeX{} fragments}
17243 @vindex org-log-done
17244 @vindex org-log-note-clock-out
17245 @vindex org-log-repeat
17246 Logging the closing and reopening of TODO items and clock intervals can be
17247 configured using these options (see variables @code{org-log-done},
17248 @code{org-log-note-clock-out} and @code{org-log-repeat})
17249 @cindex @code{logdone}, STARTUP keyword
17250 @cindex @code{lognotedone}, STARTUP keyword
17251 @cindex @code{nologdone}, STARTUP keyword
17252 @cindex @code{lognoteclock-out}, STARTUP keyword
17253 @cindex @code{nolognoteclock-out}, STARTUP keyword
17254 @cindex @code{logrepeat}, STARTUP keyword
17255 @cindex @code{lognoterepeat}, STARTUP keyword
17256 @cindex @code{nologrepeat}, STARTUP keyword
17257 @cindex @code{logreschedule}, STARTUP keyword
17258 @cindex @code{lognotereschedule}, STARTUP keyword
17259 @cindex @code{nologreschedule}, STARTUP keyword
17260 @cindex @code{logredeadline}, STARTUP keyword
17261 @cindex @code{lognoteredeadline}, STARTUP keyword
17262 @cindex @code{nologredeadline}, STARTUP keyword
17263 @cindex @code{logrefile}, STARTUP keyword
17264 @cindex @code{lognoterefile}, STARTUP keyword
17265 @cindex @code{nologrefile}, STARTUP keyword
17266 @cindex @code{logdrawer}, STARTUP keyword
17267 @cindex @code{nologdrawer}, STARTUP keyword
17268 @cindex @code{logstatesreversed}, STARTUP keyword
17269 @cindex @code{nologstatesreversed}, STARTUP keyword
17271 logdone @r{record a timestamp when an item is marked DONE}
17272 lognotedone @r{record timestamp and a note when DONE}
17273 nologdone @r{don't record when items are marked DONE}
17274 logrepeat @r{record a time when reinstating a repeating item}
17275 lognoterepeat @r{record a note when reinstating a repeating item}
17276 nologrepeat @r{do not record when reinstating repeating item}
17277 lognoteclock-out @r{record a note when clocking out}
17278 nolognoteclock-out @r{don't record a note when clocking out}
17279 logreschedule @r{record a timestamp when scheduling time changes}
17280 lognotereschedule @r{record a note when scheduling time changes}
17281 nologreschedule @r{do not record when a scheduling date changes}
17282 logredeadline @r{record a timestamp when deadline changes}
17283 lognoteredeadline @r{record a note when deadline changes}
17284 nologredeadline @r{do not record when a deadline date changes}
17285 logrefile @r{record a timestamp when refiling}
17286 lognoterefile @r{record a note when refiling}
17287 nologrefile @r{do not record when refiling}
17288 logdrawer @r{store log into drawer}
17289 nologdrawer @r{store log outside of drawer}
17290 logstatesreversed @r{reverse the order of states notes}
17291 nologstatesreversed @r{do not reverse the order of states notes}
17294 @vindex org-hide-leading-stars
17295 @vindex org-odd-levels-only
17296 Here are the options for hiding leading stars in outline headings, and for
17297 indenting outlines. The corresponding variables are
17298 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
17299 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
17300 @cindex @code{hidestars}, STARTUP keyword
17301 @cindex @code{showstars}, STARTUP keyword
17302 @cindex @code{odd}, STARTUP keyword
17303 @cindex @code{even}, STARTUP keyword
17305 hidestars @r{make all but one of the stars starting a headline invisible.}
17306 showstars @r{show all stars starting a headline}
17307 indent @r{virtual indentation according to outline level}
17308 noindent @r{no virtual indentation according to outline level}
17309 odd @r{allow only odd outline levels (1,3,...)}
17310 oddeven @r{allow all outline levels}
17313 @vindex org-put-time-stamp-overlays
17314 @vindex org-time-stamp-overlay-formats
17315 To turn on custom format overlays over timestamps (variables
17316 @code{org-put-time-stamp-overlays} and
17317 @code{org-time-stamp-overlay-formats}), use
17318 @cindex @code{customtime}, STARTUP keyword
17320 customtime @r{overlay custom time format}
17323 @vindex constants-unit-system
17324 The following options influence the table spreadsheet (variable
17325 @code{constants-unit-system}).
17326 @cindex @code{constcgs}, STARTUP keyword
17327 @cindex @code{constSI}, STARTUP keyword
17329 constcgs @r{@file{constants.el} should use the c-g-s unit system}
17330 constSI @r{@file{constants.el} should use the SI unit system}
17333 @vindex org-footnote-define-inline
17334 @vindex org-footnote-auto-label
17335 @vindex org-footnote-auto-adjust
17336 To influence footnote settings, use the following keywords. The
17337 corresponding variables are @code{org-footnote-define-inline},
17338 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
17339 @cindex @code{fninline}, STARTUP keyword
17340 @cindex @code{nofninline}, STARTUP keyword
17341 @cindex @code{fnlocal}, STARTUP keyword
17342 @cindex @code{fnprompt}, STARTUP keyword
17343 @cindex @code{fnauto}, STARTUP keyword
17344 @cindex @code{fnconfirm}, STARTUP keyword
17345 @cindex @code{fnplain}, STARTUP keyword
17346 @cindex @code{fnadjust}, STARTUP keyword
17347 @cindex @code{nofnadjust}, STARTUP keyword
17349 fninline @r{define footnotes inline}
17350 fnnoinline @r{define footnotes in separate section}
17351 fnlocal @r{define footnotes near first reference, but not inline}
17352 fnprompt @r{prompt for footnote labels}
17353 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
17354 fnconfirm @r{offer automatic label for editing or confirmation}
17355 fnplain @r{create @code{[1]}-like labels automatically}
17356 fnadjust @r{automatically renumber and sort footnotes}
17357 nofnadjust @r{do not renumber and sort automatically}
17360 @cindex org-hide-block-startup
17361 To hide blocks on startup, use these keywords. The corresponding variable is
17362 @code{org-hide-block-startup}.
17363 @cindex @code{hideblocks}, STARTUP keyword
17364 @cindex @code{nohideblocks}, STARTUP keyword
17366 hideblocks @r{Hide all begin/end blocks on startup}
17367 nohideblocks @r{Do not hide blocks on startup}
17370 @cindex org-pretty-entities
17371 The display of entities as UTF-8 characters is governed by the variable
17372 @code{org-pretty-entities} and the keywords
17373 @cindex @code{entitiespretty}, STARTUP keyword
17374 @cindex @code{entitiesplain}, STARTUP keyword
17376 entitiespretty @r{Show entities as UTF-8 characters where possible}
17377 entitiesplain @r{Leave entities plain}
17380 @item #+TAGS: TAG1(c1) TAG2(c2)
17381 @vindex org-tag-alist
17382 These lines (several such lines are allowed) specify the valid tags in
17383 this file, and (potentially) the corresponding @emph{fast tag selection}
17384 keys. The corresponding variable is @code{org-tag-alist}.
17387 This line contains the formulas for the table directly above the line.
17389 Table can have multiple lines containing @samp{#+TBLFM:}. Note
17390 that only the first line of @samp{#+TBLFM:} will be applied when
17391 you recalculate the table. For more details see @ref{Using
17392 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
17394 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
17395 @itemx #+OPTIONS:, #+BIND:,
17396 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
17397 These lines provide settings for exporting files. For more details see
17398 @ref{Export settings}.
17399 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
17400 @vindex org-todo-keywords
17401 These lines set the TODO keywords and their interpretation in the
17402 current file. The corresponding variable is @code{org-todo-keywords}.
17405 @node The very busy C-c C-c key
17406 @section The very busy C-c C-c key
17408 @cindex C-c C-c, overview
17410 The key @kbd{C-c C-c} has many purposes in Org, which are all
17411 mentioned scattered throughout this manual. One specific function of
17412 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
17413 other circumstances it means something like @emph{``Hey Org, look
17414 here and update according to what you see here''}. Here is a summary of
17415 what this means in different contexts.
17419 If there are highlights in the buffer from the creation of a sparse
17420 tree, or from clock display, remove these highlights.
17422 If the cursor is in one of the special @code{#+KEYWORD} lines, this
17423 triggers scanning the buffer for these lines and updating the
17426 If the cursor is inside a table, realign the table. This command
17427 works even if the automatic table editor has been turned off.
17429 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
17432 If the current buffer is a capture buffer, close the note and file it.
17433 With a prefix argument, file it, without further interaction, to the
17436 If the cursor is on a @code{<<<target>>>}, update radio targets and
17437 corresponding links in this buffer.
17439 If the cursor is in a property line or at the start or end of a property
17440 drawer, offer property commands.
17442 If the cursor is at a footnote reference, go to the corresponding
17443 definition, and @emph{vice versa}.
17445 If the cursor is on a statistics cookie, update it.
17447 If the cursor is in a plain list item with a checkbox, toggle the status
17450 If the cursor is on a numbered item in a plain list, renumber the
17453 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
17456 If the cursor is at a timestamp, fix the day name in the timestamp.
17460 @section A cleaner outline view
17461 @cindex hiding leading stars
17462 @cindex dynamic indentation
17463 @cindex odd-levels-only outlines
17464 @cindex clean outline view
17466 Some people find it noisy and distracting that the Org headlines start with a
17467 potentially large number of stars, and that text below the headlines is not
17468 indented. While this is no problem when writing a @emph{book-like} document
17469 where the outline headings are really section headings, in a more
17470 @emph{list-oriented} outline, indented structure is a lot cleaner:
17474 * Top level headline | * Top level headline
17475 ** Second level | * Second level
17476 *** 3rd level | * 3rd level
17477 some text | some text
17478 *** 3rd level | * 3rd level
17479 more text | more text
17480 * Another top level headline | * Another top level headline
17486 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
17487 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
17488 be achieved dynamically at display time using @code{org-indent-mode}. In
17489 this minor mode, all lines are prefixed for display with the necessary amount
17490 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
17491 property, such that @code{visual-line-mode} (or purely setting
17492 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
17493 }. Also headlines are prefixed with additional stars, so that the amount of
17494 indentation shifts by two@footnote{See the variable
17495 @code{org-indent-indentation-per-level}.} spaces per level. All headline
17496 stars but the last one are made invisible using the @code{org-hide}
17497 face@footnote{Turning on @code{org-indent-mode} sets
17498 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
17499 @code{nil}.}; see below under @samp{2.} for more information on how this
17500 works. You can turn on @code{org-indent-mode} for all files by customizing
17501 the variable @code{org-startup-indented}, or you can turn it on for
17502 individual files using
17508 If you want a similar effect in an earlier version of Emacs and/or Org, or if
17509 you want the indentation to be hard space characters so that the plain text
17510 file looks as similar as possible to the Emacs display, Org supports you in
17515 @emph{Indentation of text below headlines}@*
17516 You may indent text below each headline to make the left boundary line up
17517 with the headline, like
17521 more text, now indented
17524 @vindex org-adapt-indentation
17525 Org supports this with paragraph filling, line wrapping, and structure
17526 editing@footnote{See also the variable @code{org-adapt-indentation}.},
17527 preserving or adapting the indentation as appropriate.
17530 @vindex org-hide-leading-stars
17531 @emph{Hiding leading stars}@* You can modify the display in such a way that
17532 all leading stars become invisible. To do this in a global way, configure
17533 the variable @code{org-hide-leading-stars} or change this on a per-file basis
17537 #+STARTUP: hidestars
17538 #+STARTUP: showstars
17541 With hidden stars, the tree becomes:
17545 * Top level headline
17553 @vindex org-hide @r{(face)}
17554 The leading stars are not truly replaced by whitespace, they are only
17555 fontified with the face @code{org-hide} that uses the background color as
17556 font color. If you are not using either white or black background, you may
17557 have to customize this face to get the wanted effect. Another possibility is
17558 to set this font such that the extra stars are @i{almost} invisible, for
17559 example using the color @code{grey90} on a white background.
17562 @vindex org-odd-levels-only
17563 Things become cleaner still if you skip all the even levels and use only odd
17564 levels 1, 3, 5..., effectively adding two stars to go from one outline level
17565 to the next@footnote{When you need to specify a level for a property search
17566 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
17567 way we get the outline view shown at the beginning of this section. In order
17568 to make the structure editing and export commands handle this convention
17569 correctly, configure the variable @code{org-odd-levels-only}, or set this on
17570 a per-file basis with one of the following lines:
17577 You can convert an Org file from single-star-per-level to the
17578 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
17579 RET} in that file. The reverse operation is @kbd{M-x
17580 org-convert-to-oddeven-levels}.
17584 @section Using Org on a tty
17585 @cindex tty key bindings
17587 Because Org contains a large number of commands, by default many of
17588 Org's core commands are bound to keys that are generally not
17589 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
17590 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
17591 together with modifiers like @key{Meta} and/or @key{Shift}. To access
17592 these commands on a tty when special keys are unavailable, the following
17593 alternative bindings can be used. The tty bindings below will likely be
17594 more cumbersome; you may find for some of the bindings below that a
17595 customized workaround suits you better. For example, changing a timestamp
17596 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
17597 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
17599 @multitable @columnfractions 0.15 0.2 0.1 0.2
17600 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
17601 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
17602 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
17603 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
17604 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
17605 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
17606 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
17607 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
17608 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
17609 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
17610 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
17611 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
17612 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
17613 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
17614 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
17615 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
17616 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
17617 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
17618 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17623 @section Interaction with other packages
17624 @cindex packages, interaction with other
17625 Org lives in the world of GNU Emacs and interacts in various ways
17626 with other code out there.
17629 * Cooperation:: Packages Org cooperates with
17630 * Conflicts:: Packages that lead to conflicts
17634 @subsection Packages that Org cooperates with
17637 @cindex @file{calc.el}
17638 @cindex Gillespie, Dave
17639 @item @file{calc.el} by Dave Gillespie
17640 Org uses the Calc package for implementing spreadsheet
17641 functionality in its tables (@pxref{The spreadsheet}). Org
17642 checks for the availability of Calc by looking for the function
17643 @code{calc-eval} which will have been autoloaded during setup if Calc has
17644 been installed properly. As of Emacs 22, Calc is part of the Emacs
17645 distribution. Another possibility for interaction between the two
17646 packages is using Calc for embedded calculations. @xref{Embedded Mode,
17647 , Embedded Mode, calc, GNU Emacs Calc Manual}.
17648 @item @file{constants.el} by Carsten Dominik
17649 @cindex @file{constants.el}
17650 @cindex Dominik, Carsten
17651 @vindex org-table-formula-constants
17652 In a table formula (@pxref{The spreadsheet}), it is possible to use
17653 names for natural constants or units. Instead of defining your own
17654 constants in the variable @code{org-table-formula-constants}, install
17655 the @file{constants} package which defines a large number of constants
17656 and units, and lets you use unit prefixes like @samp{M} for
17657 @samp{Mega}, etc. You will need version 2.0 of this package, available
17658 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
17659 the function @code{constants-get}, which has to be autoloaded in your
17660 setup. See the installation instructions in the file
17661 @file{constants.el}.
17662 @item @file{cdlatex.el} by Carsten Dominik
17663 @cindex @file{cdlatex.el}
17664 @cindex Dominik, Carsten
17665 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17666 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
17667 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17668 @cindex @file{imenu.el}
17669 Imenu allows menu access to an index of items in a file. Org mode
17670 supports Imenu---all you need to do to get the index is the following:
17672 (add-hook 'org-mode-hook
17673 (lambda () (imenu-add-to-menubar "Imenu")))
17675 @vindex org-imenu-depth
17676 By default the index is two levels deep---you can modify the depth using
17677 the option @code{org-imenu-depth}.
17678 @item @file{remember.el} by John Wiegley
17679 @cindex @file{remember.el}
17680 @cindex Wiegley, John
17681 Org used to use this package for capture, but no longer does.
17682 @item @file{speedbar.el} by Eric M. Ludlam
17683 @cindex @file{speedbar.el}
17684 @cindex Ludlam, Eric M.
17685 Speedbar is a package that creates a special frame displaying files and
17686 index items in files. Org mode supports Speedbar and allows you to
17687 drill into Org files directly from the Speedbar. It also allows you to
17688 restrict the scope of agenda commands to a file or a subtree by using
17689 the command @kbd{<} in the Speedbar frame.
17690 @cindex @file{table.el}
17691 @item @file{table.el} by Takaaki Ota
17693 @cindex table editor, @file{table.el}
17694 @cindex @file{table.el}
17695 @cindex Ota, Takaaki
17697 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17698 and alignment can be created using the Emacs table package by Takaaki Ota
17699 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
17700 Org mode will recognize these tables and export them properly. Because of
17701 interference with other Org mode functionality, you unfortunately cannot edit
17702 these tables directly in the buffer. Instead, you need to use the command
17703 @kbd{C-c '} to edit them, similar to source code snippets.
17706 @orgcmd{C-c ',org-edit-special}
17707 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
17709 @orgcmd{C-c ~,org-table-create-with-table.el}
17710 Insert a @file{table.el} table. If there is already a table at point, this
17711 command converts it between the @file{table.el} format and the Org mode
17712 format. See the documentation string of the command
17713 @code{org-convert-table} for the restrictions under which this is
17716 @file{table.el} is part of Emacs since Emacs 22.
17717 @item @file{footnote.el} by Steven L. Baur
17718 @cindex @file{footnote.el}
17719 @cindex Baur, Steven L.
17720 Org mode recognizes numerical footnotes as provided by this package.
17721 However, Org mode also has its own footnote support (@pxref{Footnotes}),
17722 which makes using @file{footnote.el} unnecessary.
17726 @subsection Packages that lead to conflicts with Org mode
17730 @cindex @code{shift-selection-mode}
17731 @vindex org-support-shift-select
17732 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
17733 cursor motions combined with the shift key should start or enlarge regions.
17734 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17735 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17736 at such a location. By default, @kbd{S-@key{cursor}} commands outside
17737 special contexts don't do anything, but you can customize the variable
17738 @code{org-support-shift-select}. Org mode then tries to accommodate shift
17739 selection by (i) using it outside of the special contexts where special
17740 commands apply, and by (ii) extending an existing active region even if the
17741 cursor moves across a special context.
17743 @item @file{CUA.el} by Kim. F. Storm
17744 @cindex @file{CUA.el}
17745 @cindex Storm, Kim. F.
17746 @vindex org-replace-disputed-keys
17747 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
17748 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
17749 extend the region. In fact, Emacs 23 has this built-in in the form of
17750 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
17751 23, you probably don't want to use another package for this purpose.
17752 However, if you prefer to leave these keys to a different package while
17753 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
17754 When set, Org will move the following key bindings in Org files, and in the
17755 agenda buffer (but not during date selection).
17758 S-UP @result{} M-p S-DOWN @result{} M-n
17759 S-LEFT @result{} M-- S-RIGHT @result{} M-+
17760 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
17763 @vindex org-disputed-keys
17764 Yes, these are unfortunately more difficult to remember. If you want
17765 to have other replacement keys, look at the variable
17766 @code{org-disputed-keys}.
17768 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17769 @cindex @file{ecomplete.el}
17771 Ecomplete provides ``electric'' address completion in address header
17772 lines in message buffers. Sadly Orgtbl mode cuts ecompletes power
17773 supply: No completion happens when Orgtbl mode is enabled in message
17774 buffers while entering text in address header lines. If one wants to
17775 use ecomplete one should @emph{not} follow the advice to automagically
17776 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17777 instead---after filling in the message headers---turn on Orgtbl mode
17778 manually when needed in the messages body.
17780 @item @file{filladapt.el} by Kyle Jones
17781 @cindex @file{filladapt.el}
17783 Org mode tries to do the right thing when filling paragraphs, list items and
17784 other elements. Many users reported they had problems using both
17785 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17789 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17792 @item @file{yasnippet.el}
17793 @cindex @file{yasnippet.el}
17794 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17795 @code{"\t"}) overrules YASnippet's access to this key. The following code
17796 fixed this problem:
17799 (add-hook 'org-mode-hook
17801 (org-set-local 'yas/trigger-key [tab])
17802 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17805 The latest version of yasnippet doesn't play well with Org mode. If the
17806 above code does not fix the conflict, start by defining the following
17810 (defun yas/org-very-safe-expand ()
17811 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17814 Then, tell Org mode what to do with the new function:
17817 (add-hook 'org-mode-hook
17819 (make-variable-buffer-local 'yas/trigger-key)
17820 (setq yas/trigger-key [tab])
17821 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17822 (define-key yas/keymap [tab] 'yas/next-field)))
17825 @item @file{windmove.el} by Hovav Shacham
17826 @cindex @file{windmove.el}
17827 This package also uses the @kbd{S-<cursor>} keys, so everything written
17828 in the paragraph above about CUA mode also applies here. If you want make
17829 the windmove function active in locations where Org mode does not have
17830 special functionality on @kbd{S-@key{cursor}}, add this to your
17834 ;; Make windmove work in org-mode:
17835 (add-hook 'org-shiftup-final-hook 'windmove-up)
17836 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17837 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17838 (add-hook 'org-shiftright-final-hook 'windmove-right)
17841 @item @file{viper.el} by Michael Kifer
17842 @cindex @file{viper.el}
17844 Viper uses @kbd{C-c /} and therefore makes this key not access the
17845 corresponding Org mode command @code{org-sparse-tree}. You need to find
17846 another key for this command, or override the key in
17847 @code{viper-vi-global-user-map} with
17850 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17858 @section org-crypt.el
17859 @cindex @file{org-crypt.el}
17860 @cindex @code{org-decrypt-entry}
17862 Org-crypt will encrypt the text of an entry, but not the headline, or
17863 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17866 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17867 be encrypted when the file is saved. If you want to use a different tag just
17868 customize the @code{org-crypt-tag-matcher} setting.
17870 To use org-crypt it is suggested that you have the following in your
17874 (require 'org-crypt)
17875 (org-crypt-use-before-save-magic)
17876 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17878 (setq org-crypt-key nil)
17879 ;; GPG key to use for encryption
17880 ;; Either the Key ID or set to nil to use symmetric encryption.
17882 (setq auto-save-default nil)
17883 ;; Auto-saving does not cooperate with org-crypt.el: so you need
17884 ;; to turn it off if you plan to use org-crypt.el quite often.
17885 ;; Otherwise, you'll get an (annoying) message each time you
17888 ;; To turn it off only locally, you can insert this:
17890 ;; # -*- buffer-auto-save-file-name: nil; -*-
17893 Excluding the crypt tag from inheritance prevents already encrypted text
17894 being encrypted again.
17900 This appendix covers some areas where users can extend the functionality of
17904 * Hooks:: How to reach into Org's internals
17905 * Add-on packages:: Available extensions
17906 * Adding hyperlink types:: New custom link types
17907 * Adding export back-ends:: How to write new export back-ends
17908 * Context-sensitive commands:: How to add functionality to such commands
17909 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
17910 * Dynamic blocks:: Automatically filled blocks
17911 * Special agenda views:: Customized views
17912 * Speeding up your agendas:: Tips on how to speed up your agendas
17913 * Extracting agenda information:: Post-processing of agenda information
17914 * Using the property API:: Writing programs that use entry properties
17915 * Using the mapping API:: Mapping over all or selected entries
17922 Org has a large number of hook variables that can be used to add
17923 functionality. This appendix about hacking is going to illustrate the
17924 use of some of them. A complete list of all hooks with documentation is
17925 maintained by the Worg project and can be found at
17926 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17928 @node Add-on packages
17929 @section Add-on packages
17930 @cindex add-on packages
17932 A large number of add-on packages have been written by various authors.
17934 These packages are not part of Emacs, but they are distributed as contributed
17935 packages with the separate release available at @uref{http://orgmode.org}.
17936 See the @file{contrib/README} file in the source code directory for a list of
17937 contributed files. You may also find some more information on the Worg page:
17938 @uref{http://orgmode.org/worg/org-contrib/}.
17940 @node Adding hyperlink types
17941 @section Adding hyperlink types
17942 @cindex hyperlinks, adding new types
17944 Org has a large number of hyperlink types built-in
17945 (@pxref{Hyperlinks}). If you would like to add new link types, Org
17946 provides an interface for doing so. Let's look at an example file,
17947 @file{org-man.el}, that will add support for creating links like
17948 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17952 ;;; org-man.el - Support for links to manpages in Org
17956 (org-add-link-type "man" 'org-man-open)
17957 (add-hook 'org-store-link-functions 'org-man-store-link)
17959 (defcustom org-man-command 'man
17960 "The Emacs command to be used to display a man page."
17962 :type '(choice (const man) (const woman)))
17964 (defun org-man-open (path)
17965 "Visit the manpage on PATH.
17966 PATH should be a topic that can be thrown at the man command."
17967 (funcall org-man-command path))
17969 (defun org-man-store-link ()
17970 "Store a link to a manpage."
17971 (when (memq major-mode '(Man-mode woman-mode))
17972 ;; This is a man page, we do make this link
17973 (let* ((page (org-man-get-page-name))
17974 (link (concat "man:" page))
17975 (description (format "Manpage for %s" page)))
17976 (org-store-link-props
17979 :description description))))
17981 (defun org-man-get-page-name ()
17982 "Extract the page name from the buffer name."
17983 ;; This works for both `Man-mode' and `woman-mode'.
17984 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17985 (match-string 1 (buffer-name))
17986 (error "Cannot create link to this man page")))
17990 ;;; org-man.el ends here
17994 You would activate this new link type in @file{.emacs} with
18001 Let's go through the file and see what it does.
18004 It does @code{(require 'org)} to make sure that @file{org.el} has been
18007 The next line calls @code{org-add-link-type} to define a new link type
18008 with prefix @samp{man}. The call also contains the name of a function
18009 that will be called to follow such a link.
18011 @vindex org-store-link-functions
18012 The next line adds a function to @code{org-store-link-functions}, in
18013 order to allow the command @kbd{C-c l} to record a useful link in a
18014 buffer displaying a man page.
18017 The rest of the file defines the necessary variables and functions.
18018 First there is a customization variable that determines which Emacs
18019 command should be used to display man pages. There are two options,
18020 @code{man} and @code{woman}. Then the function to follow a link is
18021 defined. It gets the link path as an argument---in this case the link
18022 path is just a topic for the manual command. The function calls the
18023 value of @code{org-man-command} to display the man page.
18025 Finally the function @code{org-man-store-link} is defined. When you try
18026 to store a link with @kbd{C-c l}, this function will be called to
18027 try to make a link. The function must first decide if it is supposed to
18028 create the link for this buffer type; we do this by checking the value
18029 of the variable @code{major-mode}. If not, the function must exit and
18030 return the value @code{nil}. If yes, the link is created by getting the
18031 manual topic from the buffer name and prefixing it with the string
18032 @samp{man:}. Then it must call the command @code{org-store-link-props}
18033 and set the @code{:type} and @code{:link} properties. Optionally you
18034 can also set the @code{:description} property to provide a default for
18035 the link description when the link is later inserted into an Org
18036 buffer with @kbd{C-c C-l}.
18038 When it makes sense for your new link type, you may also define a function
18039 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
18040 support for inserting such a link with @kbd{C-c C-l}. Such a function should
18041 not accept any arguments, and return the full link with prefix.
18043 @node Adding export back-ends
18044 @section Adding export back-ends
18045 @cindex Export, writing back-ends
18047 Org 8.0 comes with a completely rewritten export engine which makes it easy
18048 to write new export back-ends, either from scratch, or by deriving them
18049 from existing ones.
18051 Your two entry points are respectively @code{org-export-define-backend} and
18052 @code{org-export-define-derived-backend}. To grok these functions, you
18053 should first have a look at @file{ox-latex.el} (for how to define a new
18054 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
18055 back-end from an existing one.
18057 When creating a new back-end from scratch, the basic idea is to set the name
18058 of the back-end (as a symbol) and an alist of elements and export functions.
18059 On top of this, you will need to set additional keywords like
18060 @code{:menu-entry} (to display the back-end in the export dispatcher), and
18061 @code{:options-alist} (to let the user set export options that are specific
18064 Deriving a new back-end is similar, except that you need to set
18065 @code{:translate-alist} to an alist of export functions that should be used
18066 instead of the parent back-end functions.
18068 For a complete reference documentation, see
18069 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
18070 Reference on Worg}.
18072 @node Context-sensitive commands
18073 @section Context-sensitive commands
18074 @cindex context-sensitive commands, hooks
18075 @cindex add-ons, context-sensitive commands
18076 @vindex org-ctrl-c-ctrl-c-hook
18078 Org has several commands that act differently depending on context. The most
18079 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
18080 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
18082 Add-ons can tap into this functionality by providing a function that detects
18083 special context for that add-on and executes functionality appropriate for
18084 the context. Here is an example from Dan Davison's @file{org-R.el} which
18085 allows you to evaluate commands based on the @file{R} programming language
18086 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
18087 described in @ref{Working with source code} and is now obsolete.}. For this
18088 package, special contexts are lines that start with @code{#+R:} or
18092 (defun org-R-apply-maybe ()
18093 "Detect if this is context for org-R and execute R commands."
18094 (if (save-excursion
18095 (beginning-of-line 1)
18096 (looking-at "#\\+RR?:"))
18097 (progn (call-interactively 'org-R-apply)
18098 t) ;; to signal that we took action
18099 nil)) ;; to signal that we did not
18101 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
18104 The function first checks if the cursor is in such a line. If that is the
18105 case, @code{org-R-apply} is called and the function returns @code{t} to
18106 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
18107 contexts. If the function finds it should do nothing locally, it returns
18108 @code{nil} so that other, similar functions can have a try.
18111 @node Tables in arbitrary syntax
18112 @section Tables and lists in arbitrary syntax
18113 @cindex tables, in other modes
18114 @cindex lists, in other modes
18115 @cindex Orgtbl mode
18117 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
18118 frequent feature request has been to make it work with native tables in
18119 specific languages, for example @LaTeX{}. However, this is extremely
18120 hard to do in a general way, would lead to a customization nightmare,
18121 and would take away much of the simplicity of the Orgtbl mode table
18124 This appendix describes a different approach. We keep the Orgtbl mode
18125 table in its native format (the @i{source table}), and use a custom
18126 function to @i{translate} the table to the correct syntax, and to
18127 @i{install} it in the right location (the @i{target table}). This puts
18128 the burden of writing conversion functions on the user, but it allows
18129 for a very flexible system.
18131 Bastien added the ability to do the same with lists, in Orgstruct mode. You
18132 can use Org's facilities to edit and structure lists by turning
18133 @code{orgstruct-mode} on, then locally exporting such lists in another format
18134 (HTML, @LaTeX{} or Texinfo.)
18138 * Radio tables:: Sending and receiving radio tables
18139 * A @LaTeX{} example:: Step by step, almost a tutorial
18140 * Translator functions:: Copy and modify
18141 * Radio lists:: Sending and receiving lists
18145 @subsection Radio tables
18146 @cindex radio tables
18148 To define the location of the target table, you first need to create two
18149 lines that are comments in the current mode, but contain magic words
18150 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will
18151 insert the translated table between these lines, replacing whatever was there
18152 before. For example in C mode where comments are between @code{/* ... */}:
18155 /* BEGIN RECEIVE ORGTBL table_name */
18156 /* END RECEIVE ORGTBL table_name */
18160 Just above the source table, we put a special line that tells
18161 Orgtbl mode how to translate this table and where to install it. For
18165 #+ORGTBL: SEND table_name translation_function arguments...
18169 @code{table_name} is the reference name for the table that is also used
18170 in the receiver lines. @code{translation_function} is the Lisp function
18171 that does the translation. Furthermore, the line can contain a list of
18172 arguments (alternating key and value) at the end. The arguments will be
18173 passed as a property list to the translation function for
18174 interpretation. A few standard parameters are already recognized and
18175 acted upon before the translation function is called:
18179 Skip the first N lines of the table. Hlines do count as separate lines for
18182 @item :skipcols (n1 n2 ...)
18183 List of columns that should be skipped. If the table has a column with
18184 calculation marks, that column is automatically discarded as well.
18185 Please note that the translator function sees the table @emph{after} the
18186 removal of these columns, the function never knows that there have been
18187 additional columns.
18191 The one problem remaining is how to keep the source table in the buffer
18192 without disturbing the normal workings of the file, for example during
18193 compilation of a C file or processing of a @LaTeX{} file. There are a
18194 number of different solutions:
18198 The table could be placed in a block comment if that is supported by the
18199 language. For example, in C mode you could wrap the table between
18200 @samp{/*} and @samp{*/} lines.
18202 Sometimes it is possible to put the table after some kind of @i{END}
18203 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
18206 You can just comment the table line-by-line whenever you want to process
18207 the file, and uncomment it whenever you need to edit the table. This
18208 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
18209 makes this comment-toggling very easy, in particular if you bind it to a
18213 @node A @LaTeX{} example
18214 @subsection A @LaTeX{} example of radio tables
18215 @cindex @LaTeX{}, and Orgtbl mode
18217 The best way to wrap the source table in @LaTeX{} is to use the
18218 @code{comment} environment provided by @file{comment.sty}. It has to be
18219 activated by placing @code{\usepackage@{comment@}} into the document
18220 header. Orgtbl mode can insert a radio table skeleton@footnote{By
18221 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
18222 variable @code{orgtbl-radio-table-templates} to install templates for other
18223 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
18224 be prompted for a table name, let's say we use @samp{salesfigures}. You
18225 will then get the following template:
18227 @cindex #+ORGTBL, SEND
18229 % BEGIN RECEIVE ORGTBL salesfigures
18230 % END RECEIVE ORGTBL salesfigures
18232 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18238 @vindex @LaTeX{}-verbatim-environments
18239 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
18240 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
18241 into the receiver location with name @code{salesfigures}. You may now
18242 fill in the table---feel free to use the spreadsheet features@footnote{If
18243 the @samp{#+TBLFM} line contains an odd number of dollar characters,
18244 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
18245 example you can fix this by adding an extra line inside the
18246 @code{comment} environment that is used to balance the dollar
18247 expressions. If you are using AUC@TeX{} with the font-latex library, a
18248 much better solution is to add the @code{comment} environment to the
18249 variable @code{LaTeX-verbatim-environments}.}:
18252 % BEGIN RECEIVE ORGTBL salesfigures
18253 % END RECEIVE ORGTBL salesfigures
18255 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18256 | Month | Days | Nr sold | per day |
18257 |-------+------+---------+---------|
18258 | Jan | 23 | 55 | 2.4 |
18259 | Feb | 21 | 16 | 0.8 |
18260 | March | 22 | 278 | 12.6 |
18261 #+TBLFM: $4=$3/$2;%.1f
18262 % $ (optional extra dollar to keep font-lock happy, see footnote)
18267 When you are done, press @kbd{C-c C-c} in the table to get the converted
18268 table inserted between the two marker lines.
18270 Now let's assume you want to make the table header by hand, because you
18271 want to control how columns are aligned, etc. In this case we make sure
18272 that the table translator skips the first 2 lines of the source
18273 table, and tell the command to work as a @i{splice}, i.e., to not produce
18274 header and footer commands of the target table:
18277 \begin@{tabular@}@{lrrr@}
18278 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
18279 % BEGIN RECEIVE ORGTBL salesfigures
18280 % END RECEIVE ORGTBL salesfigures
18284 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
18285 | Month | Days | Nr sold | per day |
18286 |-------+------+---------+---------|
18287 | Jan | 23 | 55 | 2.4 |
18288 | Feb | 21 | 16 | 0.8 |
18289 | March | 22 | 278 | 12.6 |
18290 #+TBLFM: $4=$3/$2;%.1f
18294 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
18295 Orgtbl mode. By default, it uses a @code{tabular} environment to typeset the
18296 table and marks horizontal lines with @code{\hline}. You can control the
18297 output through several parameters (see also @pxref{Translator functions}),
18298 including the following ones :
18301 @item :splice nil/t
18302 When non-@code{nil}, return only table body lines, don't wrap them into a tabular
18303 environment. Default is @code{nil}.
18306 A format to be used to wrap each field, it should contain @code{%s} for the
18307 original field value. For example, to wrap each field value in dollars,
18308 you could use @code{:fmt "$%s$"}. This may also be a property list with
18309 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
18310 A function of one argument can be used in place of the strings; the
18311 function must return a formatted string.
18314 Use this format to print numbers with exponentials. The format should have
18315 @code{%s} twice for inserting mantissa and exponent, for example
18316 @code{"%s\\times10^@{%s@}"}. This may also be a property list with column
18317 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
18318 4 "$%s\\cdot10^@{%s@}$")}. After @code{efmt} has been applied to a value,
18319 @code{fmt} will also be applied. Similar to @code{fmt}, functions of two
18320 arguments can be supplied instead of strings. By default, no special
18321 formatting is applied.
18324 @node Translator functions
18325 @subsection Translator functions
18326 @cindex HTML, and Orgtbl mode
18327 @cindex translator function
18329 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
18330 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
18331 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
18332 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}. These all use
18333 a generic translator, @code{orgtbl-to-generic}, which, in turn, can delegate
18334 translations to various export back-ends (@pxref{Export back-ends}).
18336 In particular, properties passed into the function (i.e., the ones set by the
18337 @samp{ORGTBL SEND} line) take precedence over translations defined in the
18338 function. So if you would like to use the @LaTeX{} translator, but wanted
18339 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
18340 could just overrule the default with
18343 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
18346 For a new language, you can use the generic function to write your own
18347 converter function. For example, if you have a language where a table is
18348 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
18349 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
18350 separator is a TAB, you could define your generic translator like this:
18353 (defun orgtbl-to-language (table params)
18354 "Convert the orgtbl-mode TABLE to language."
18357 (org-combine-plists
18358 '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
18363 Please check the documentation string of the function
18364 @code{orgtbl-to-generic} for a full list of parameters understood by
18365 that function, and remember that you can pass each of them into
18366 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
18367 using the generic function.
18369 Of course you can also write a completely new function doing complicated
18370 things the generic translator cannot do. A translator function takes
18371 two arguments. The first argument is the table, a list of lines, each
18372 line either the symbol @code{hline} or a list of fields. The second
18373 argument is the property list containing all parameters specified in the
18374 @samp{#+ORGTBL: SEND} line. The function must return a single string
18375 containing the formatted table. If you write a generally useful
18376 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
18377 others can benefit from your work.
18380 @subsection Radio lists
18381 @cindex radio lists
18382 @cindex org-list-insert-radio-list
18384 Sending and receiving radio lists works exactly the same way as sending and
18385 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
18386 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
18387 @code{org-list-insert-radio-list}.
18389 Here are the differences with radio tables:
18394 Orgstruct mode must be active.
18396 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
18398 @kbd{C-c C-c} will work when pressed on the first item of the list.
18401 Built-in translators functions are : @code{org-list-to-latex},
18402 @code{org-list-to-html} and @code{org-list-to-texinfo}. They all use the
18403 generic translator @code{org-list-to-generic}. Please check its
18404 documentation for a list of supported parameters, which can be used to
18405 control more accurately how the list should be rendered.
18407 Here is a @LaTeX{} example. Let's say that you have this in your
18411 % BEGIN RECEIVE ORGLST to-buy
18412 % END RECEIVE ORGLST to-buy
18414 #+ORGLST: SEND to-buy org-list-to-latex
18423 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
18424 @LaTeX{} list between the two marker lines.
18426 @node Dynamic blocks
18427 @section Dynamic blocks
18428 @cindex dynamic blocks
18430 Org documents can contain @emph{dynamic blocks}. These are
18431 specially marked regions that are updated by some user-written function.
18432 A good example for such a block is the clock table inserted by the
18433 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
18435 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
18436 to the block and can also specify parameters for the function producing
18437 the content of the block.
18439 @cindex #+BEGIN:dynamic block
18441 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
18446 Dynamic blocks are updated with the following commands
18449 @orgcmd{C-c C-x C-u,org-dblock-update}
18450 Update dynamic block at point.
18451 @orgkey{C-u C-c C-x C-u}
18452 Update all dynamic blocks in the current file.
18455 Updating a dynamic block means to remove all the text between BEGIN and
18456 END, parse the BEGIN line for parameters and then call the specific
18457 writer function for this block to insert the new content. If you want
18458 to use the original content in the writer function, you can use the
18459 extra parameter @code{:content}.
18461 For a block with name @code{myblock}, the writer function is
18462 @code{org-dblock-write:myblock} with as only parameter a property list
18463 with the parameters given in the begin line. Here is a trivial example
18464 of a block that keeps track of when the block update function was last
18468 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
18474 The corresponding block writer function could look like this:
18477 (defun org-dblock-write:block-update-time (params)
18478 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
18479 (insert "Last block update at: "
18480 (format-time-string fmt))))
18483 If you want to make sure that all dynamic blocks are always up-to-date,
18484 you could add the function @code{org-update-all-dblocks} to a hook, for
18485 example @code{before-save-hook}. @code{org-update-all-dblocks} is
18486 written in a way such that it does nothing in buffers that are not in
18489 You can narrow the current buffer to the current dynamic block (like any
18490 other block) with @code{org-narrow-to-block}.
18492 @node Special agenda views
18493 @section Special agenda views
18494 @cindex agenda views, user-defined
18496 @vindex org-agenda-skip-function
18497 @vindex org-agenda-skip-function-global
18498 Org provides a special hook that can be used to narrow down the selection
18499 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
18500 @code{agenda*} view is the same as @code{agenda} except that it only
18501 considers @emph{appointments}, i.e., scheduled and deadline items that have a
18502 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
18503 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
18504 specify a function that is used at each match to verify if the match should
18505 indeed be part of the agenda view, and if not, how much should be skipped.
18506 You can specify a global condition that will be applied to all agenda views,
18507 this condition would be stored in the variable
18508 @code{org-agenda-skip-function-global}. More commonly, such a definition is
18509 applied only to specific custom searches, using
18510 @code{org-agenda-skip-function}.
18512 Let's say you want to produce a list of projects that contain a WAITING
18513 tag anywhere in the project tree. Let's further assume that you have
18514 marked all tree headings that define a project with the TODO keyword
18515 PROJECT@. In this case you would run a TODO search for the keyword
18516 PROJECT, but skip the match unless there is a WAITING tag anywhere in
18517 the subtree belonging to the project line.
18519 To achieve this, you must write a function that searches the subtree for
18520 the tag. If the tag is found, the function must return @code{nil} to
18521 indicate that this match should not be skipped. If there is no such
18522 tag, return the location of the end of the subtree, to indicate that
18523 search should continue from there.
18526 (defun my-skip-unless-waiting ()
18527 "Skip trees that are not waiting"
18528 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
18529 (if (re-search-forward ":waiting:" subtree-end t)
18530 nil ; tag found, do not skip
18531 subtree-end))) ; tag not found, continue after end of subtree
18534 Now you may use this function in an agenda custom command, for example
18538 (org-add-agenda-custom-command
18539 '("b" todo "PROJECT"
18540 ((org-agenda-skip-function 'my-skip-unless-waiting)
18541 (org-agenda-overriding-header "Projects waiting for something: "))))
18544 @vindex org-agenda-overriding-header
18545 Note that this also binds @code{org-agenda-overriding-header} to get a
18546 meaningful header in the agenda view.
18548 @vindex org-odd-levels-only
18549 @vindex org-agenda-skip-function
18550 A general way to create custom searches is to base them on a search for
18551 entries with a certain level limit. If you want to study all entries with
18552 your custom search function, simply do a search for
18553 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
18554 level number corresponds to order in the hierarchy, not to the number of
18555 stars.}, and then use @code{org-agenda-skip-function} to select the entries
18556 you really want to have.
18558 You may also put a Lisp form into @code{org-agenda-skip-function}. In
18559 particular, you may use the functions @code{org-agenda-skip-entry-if}
18560 and @code{org-agenda-skip-subtree-if} in this form, for example:
18563 @item (org-agenda-skip-entry-if 'scheduled)
18564 Skip current entry if it has been scheduled.
18565 @item (org-agenda-skip-entry-if 'notscheduled)
18566 Skip current entry if it has not been scheduled.
18567 @item (org-agenda-skip-entry-if 'deadline)
18568 Skip current entry if it has a deadline.
18569 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
18570 Skip current entry if it has a deadline, or if it is scheduled.
18571 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
18572 Skip current entry if the TODO keyword is TODO or WAITING.
18573 @item (org-agenda-skip-entry-if 'todo 'done)
18574 Skip current entry if the TODO keyword marks a DONE state.
18575 @item (org-agenda-skip-entry-if 'timestamp)
18576 Skip current entry if it has any timestamp, may also be deadline or scheduled.
18577 @anchor{x-agenda-skip-entry-regexp}
18578 @item (org-agenda-skip-entry-if 'regexp "regular expression")
18579 Skip current entry if the regular expression matches in the entry.
18580 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
18581 Skip current entry unless the regular expression matches.
18582 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
18583 Same as above, but check and skip the entire subtree.
18586 Therefore we could also have written the search for WAITING projects
18587 like this, even without defining a special function:
18590 (org-add-agenda-custom-command
18591 '("b" todo "PROJECT"
18592 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
18593 'regexp ":waiting:"))
18594 (org-agenda-overriding-header "Projects waiting for something: "))))
18597 @node Speeding up your agendas
18598 @section Speeding up your agendas
18599 @cindex agenda views, optimization
18601 When your Org files grow in both number and size, agenda commands may start
18602 to become slow. Below are some tips on how to speed up the agenda commands.
18606 Reduce the number of Org agenda files: this will reduce the slowdown caused
18607 by accessing a hard drive.
18609 Reduce the number of DONE and archived headlines: this way the agenda does
18610 not need to skip them.
18612 @vindex org-agenda-dim-blocked-tasks
18613 Inhibit the dimming of blocked tasks:
18615 (setq org-agenda-dim-blocked-tasks nil)
18618 @vindex org-startup-folded
18619 @vindex org-agenda-inhibit-startup
18620 Inhibit agenda files startup options:
18622 (setq org-agenda-inhibit-startup nil)
18625 @vindex org-agenda-show-inherited-tags
18626 @vindex org-agenda-use-tag-inheritance
18627 Disable tag inheritance in agenda:
18629 (setq org-agenda-use-tag-inheritance nil)
18633 You can set these options for specific agenda views only. See the docstrings
18634 of these variables for details on why they affect the agenda generation, and
18635 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18636 page} for further explanations.
18638 @node Extracting agenda information
18639 @section Extracting agenda information
18640 @cindex agenda, pipe
18641 @cindex Scripts, for agenda processing
18643 @vindex org-agenda-custom-commands
18644 Org provides commands to access agenda information for the command
18645 line in Emacs batch mode. This extracted information can be sent
18646 directly to a printer, or it can be read by a program that does further
18647 processing of the data. The first of these commands is the function
18648 @code{org-batch-agenda}, that produces an agenda view and sends it as
18649 ASCII text to STDOUT@. The command takes a single string as parameter.
18650 If the string has length 1, it is used as a key to one of the commands
18651 you have configured in @code{org-agenda-custom-commands}, basically any
18652 key you can use after @kbd{C-c a}. For example, to directly print the
18653 current TODO list, you could use
18656 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18659 If the parameter is a string with 2 or more characters, it is used as a
18660 tags/TODO match string. For example, to print your local shopping list
18661 (all items with the tag @samp{shop}, but excluding the tag
18662 @samp{NewYork}), you could use
18665 emacs -batch -l ~/.emacs \
18666 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18670 You may also modify parameters on the fly like this:
18673 emacs -batch -l ~/.emacs \
18674 -eval '(org-batch-agenda "a" \
18675 org-agenda-span (quote month) \
18676 org-agenda-include-diary nil \
18677 org-agenda-files (quote ("~/org/project.org")))' \
18682 which will produce a 30-day agenda, fully restricted to the Org file
18683 @file{~/org/projects.org}, not even including the diary.
18685 If you want to process the agenda data in more sophisticated ways, you
18686 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18687 list of values for each agenda item. Each line in the output will
18688 contain a number of fields separated by commas. The fields in a line
18692 category @r{The category of the item}
18693 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
18694 type @r{The type of the agenda entry, can be}
18695 todo @r{selected in TODO match}
18696 tagsmatch @r{selected in tags match}
18697 diary @r{imported from diary}
18698 deadline @r{a deadline}
18699 scheduled @r{scheduled}
18700 timestamp @r{appointment, selected by timestamp}
18701 closed @r{entry was closed on date}
18702 upcoming-deadline @r{warning about nearing deadline}
18703 past-scheduled @r{forwarded scheduled item}
18704 block @r{entry has date block including date}
18705 todo @r{The TODO keyword, if any}
18706 tags @r{All tags including inherited ones, separated by colons}
18707 date @r{The relevant date, like 2007-2-14}
18708 time @r{The time, like 15:00-16:50}
18709 extra @r{String with extra planning info}
18710 priority-l @r{The priority letter if any was given}
18711 priority-n @r{The computed numerical priority}
18715 Time and date will only be given if a timestamp (or deadline/scheduled)
18716 led to the selection of the item.
18718 A CSV list like this is very easy to use in a post-processing script.
18719 For example, here is a Perl program that gets the TODO list from
18720 Emacs/Org and prints all the items, preceded by a checkbox:
18725 # define the Emacs command to run
18726 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18728 # run it and capture the output
18729 $agenda = qx@{$cmd 2>/dev/null@};
18731 # loop over all lines
18732 foreach $line (split(/\n/,$agenda)) @{
18733 # get the individual values
18734 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18735 $priority_l,$priority_n) = split(/,/,$line);
18736 # process and print
18737 print "[ ] $head\n";
18741 @node Using the property API
18742 @section Using the property API
18743 @cindex API, for properties
18744 @cindex properties, API
18746 Here is a description of the functions that can be used to work with
18749 @defun org-entry-properties &optional pom which
18750 Get all properties of the entry at point-or-marker POM.@*
18751 This includes the TODO keyword, the tags, time strings for deadline,
18752 scheduled, and clocking, and any additional properties defined in the
18753 entry. The return value is an alist. Keys may occur multiple times
18754 if the property key was used several times.@*
18755 POM may also be @code{nil}, in which case the current entry is used.
18756 If WHICH is @code{nil} or @code{all}, get all properties. If WHICH is
18757 @code{special} or @code{standard}, only get that subclass.
18759 @vindex org-use-property-inheritance
18760 @findex org-insert-property-drawer
18761 @defun org-entry-get pom property &optional inherit
18762 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
18763 this only looks at properties defined locally in the entry. If @code{INHERIT}
18764 is non-@code{nil} and the entry does not have the property, then also check
18765 higher levels of the hierarchy. If @code{INHERIT} is the symbol
18766 @code{selective}, use inheritance if and only if the setting of
18767 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18770 @defun org-entry-delete pom property
18771 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18774 @defun org-entry-put pom property value
18775 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18778 @defun org-buffer-property-keys &optional include-specials
18779 Get all property keys in the current buffer.
18782 @defun org-insert-property-drawer
18783 Insert a property drawer for the current entry.
18786 @defun org-entry-put-multivalued-property pom property &rest values
18787 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18788 @code{VALUES} should be a list of strings. They will be concatenated, with
18789 spaces as separators.
18792 @defun org-entry-get-multivalued-property pom property
18793 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18794 list of values and return the values as a list of strings.
18797 @defun org-entry-add-to-multivalued-property pom property value
18798 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18799 list of values and make sure that @code{VALUE} is in this list.
18802 @defun org-entry-remove-from-multivalued-property pom property value
18803 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18804 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18807 @defun org-entry-member-in-multivalued-property pom property value
18808 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18809 list of values and check if @code{VALUE} is in this list.
18812 @defopt org-property-allowed-value-functions
18813 Hook for functions supplying allowed values for a specific property.
18814 The functions must take a single argument, the name of the property, and
18815 return a flat list of allowed values. If @samp{:ETC} is one of
18816 the values, use the values as completion help, but allow also other values
18817 to be entered. The functions must return @code{nil} if they are not
18818 responsible for this property.
18821 @node Using the mapping API
18822 @section Using the mapping API
18823 @cindex API, for mapping
18824 @cindex mapping entries, API
18826 Org has sophisticated mapping capabilities to find all entries satisfying
18827 certain criteria. Internally, this functionality is used to produce agenda
18828 views, but there is also an API that can be used to execute arbitrary
18829 functions for each or selected entries. The main entry point for this API
18832 @defun org-map-entries func &optional match scope &rest skip
18833 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18835 @code{FUNC} is a function or a Lisp form. The function will be called
18836 without arguments, with the cursor positioned at the beginning of the
18837 headline. The return values of all calls to the function will be collected
18838 and returned as a list.
18840 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18841 @code{FUNC} does not need to preserve point. After evaluation, the cursor
18842 will be moved to the end of the line (presumably of the headline of the
18843 processed entry) and search continues from there. Under some circumstances,
18844 this may not produce the wanted results. For example, if you have removed
18845 (e.g., archived) the current (sub)tree it could mean that the next entry will
18846 be skipped entirely. In such cases, you can specify the position from where
18847 search should continue by making @code{FUNC} set the variable
18848 @code{org-map-continue-from} to the desired buffer position.
18850 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18851 view. Only headlines that are matched by this query will be considered
18852 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
18853 headlines will be visited by the iteration.
18855 @code{SCOPE} determines the scope of this command. It can be any of:
18858 nil @r{the current buffer, respecting the restriction if any}
18859 tree @r{the subtree started with the entry at point}
18860 region @r{The entries within the active region, if any}
18861 file @r{the current buffer, without restriction}
18863 @r{the current buffer, and any archives associated with it}
18864 agenda @r{all agenda files}
18865 agenda-with-archives
18866 @r{all agenda files with any archive files associated with them}
18868 @r{if this is a list, all files in the list will be scanned}
18871 The remaining args are treated as settings for the skipping facilities of
18872 the scanner. The following items can be given here:
18874 @vindex org-agenda-skip-function
18876 archive @r{skip trees with the archive tag}
18877 comment @r{skip trees with the COMMENT keyword}
18878 function or Lisp form
18879 @r{will be used as value for @code{org-agenda-skip-function},}
18880 @r{so whenever the function returns t, FUNC}
18881 @r{will not be called for that entry and search will}
18882 @r{continue from the point where the function leaves it}
18886 The function given to that mapping routine can really do anything you like.
18887 It can use the property API (@pxref{Using the property API}) to gather more
18888 information about the entry, or in order to change metadata in the entry.
18889 Here are a couple of functions that might be handy:
18891 @defun org-todo &optional arg
18892 Change the TODO state of the entry. See the docstring of the functions for
18893 the many possible values for the argument @code{ARG}.
18896 @defun org-priority &optional action
18897 Change the priority of the entry. See the docstring of this function for the
18898 possible values for @code{ACTION}.
18901 @defun org-toggle-tag tag &optional onoff
18902 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
18903 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18908 Promote the current entry.
18912 Demote the current entry.
18915 Here is a simple example that will turn all entries in the current file with
18916 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18917 Entries in comment trees and in archive trees will be ignored.
18921 '(org-todo "UPCOMING")
18922 "+TOMORROW" 'file 'archive 'comment)
18925 The following example counts the number of entries with TODO keyword
18926 @code{WAITING}, in all agenda files.
18929 (length (org-map-entries t "/+WAITING" 'agenda))
18933 @appendix MobileOrg
18937 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18938 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
18939 capture support for an Org mode system rooted on a ``real'' computer. It
18940 also allows you to record changes to existing entries. The
18941 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18942 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18943 and is now in the hands Sean Escriva. Android users should check out
18944 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18945 by Matt Jones. The two implementations are not identical but offer similar
18948 This appendix describes the support Org has for creating agenda views in a
18949 format that can be displayed by @i{MobileOrg}, and for integrating notes
18950 captured and changes made by @i{MobileOrg} into the main system.
18952 For changing tags and TODO states in MobileOrg, you should have set up the
18953 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18954 cover all important tags and TODO keywords, even if individual files use only
18955 part of these. MobileOrg will also offer you states and tags set up with
18956 in-buffer settings, but it will understand the logistics of TODO state
18957 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18958 (@pxref{Setting tags}) only for those set in these variables.
18961 * Setting up the staging area:: Where to interact with the mobile device
18962 * Pushing to MobileOrg:: Uploading Org files and agendas
18963 * Pulling from MobileOrg:: Integrating captured and flagged items
18966 @node Setting up the staging area
18967 @section Setting up the staging area
18969 MobileOrg needs to interact with Emacs through a directory on a server. If
18970 you are using a public server, you should consider encrypting the files that
18971 are uploaded to the server. This can be done with Org mode 7.02 and with
18972 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18973 installation on your system. To turn on encryption, set a password in
18974 @i{MobileOrg} and, on the Emacs side, configure the variable
18975 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18976 password in your Emacs setup, you might also want to configure
18977 @code{org-mobile-encryption-password}. Please read the docstring of that
18978 variable. Note that encryption will apply only to the contents of the
18979 @file{.org} files. The file names themselves will remain visible.}.
18981 The easiest way to create that directory is to use a free
18982 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18983 Dropbox, or if your version of MobileOrg does not support it, you can use a
18984 webdav server. For more information, check out the documentation of MobileOrg and also this
18985 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18986 When MobileOrg first connects to your Dropbox, it will create a directory
18987 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
18991 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18994 Org mode has commands to put files for @i{MobileOrg} into that directory,
18995 and to read captured notes from there.
18997 @node Pushing to MobileOrg
18998 @section Pushing to MobileOrg
19000 This operation copies all files currently listed in @code{org-mobile-files}
19001 to the directory @code{org-mobile-directory}. By default this list contains
19002 all agenda files (as listed in @code{org-agenda-files}), but additional files
19003 can be included by customizing @code{org-mobile-files}. File names will be
19004 staged with paths relative to @code{org-directory}, so all files should be
19005 inside this directory@footnote{Symbolic links in @code{org-directory} need to
19006 have the same name as their targets.}.
19008 The push operation also creates a special Org file @file{agendas.org} with
19009 all custom agenda view defined by the user@footnote{While creating the
19010 agendas, Org mode will force ID properties on all referenced entries, so that
19011 these entries can be uniquely identified if @i{MobileOrg} flags them for
19012 further action. If you do not want to get these properties in so many
19013 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
19014 to @code{nil}. Org mode will then rely on outline paths, in the hope that
19015 these will be unique enough.}.
19017 Finally, Org writes the file @file{index.org}, containing links to all other
19018 files. @i{MobileOrg} first reads this file from the server, and then
19019 downloads all agendas and Org files listed in it. To speed up the download,
19020 MobileOrg will only read files whose checksums@footnote{Checksums are stored
19021 automatically in the file @file{checksums.dat}} have changed.
19023 @node Pulling from MobileOrg
19024 @section Pulling from MobileOrg
19026 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
19027 files for viewing. It also appends captured entries and pointers to flagged
19028 and changed entries to the file @file{mobileorg.org} on the server. Org has
19029 a @emph{pull} operation that integrates this information into an inbox file
19030 and operates on the pointers to flagged entries. Here is how it works:
19034 Org moves all entries found in
19035 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
19036 operation.} and appends them to the file pointed to by the variable
19037 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
19038 will be a top-level entry in the inbox file.
19040 After moving the entries, Org will attempt to implement the changes made in
19041 @i{MobileOrg}. Some changes are applied directly and without user
19042 interaction. Examples are all changes to tags, TODO state, headline and body
19043 text that can be cleanly applied. Entries that have been flagged for further
19044 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
19045 again. When there is a problem finding an entry or applying the change, the
19046 pointer entry will remain in the inbox and will be marked with an error
19047 message. You need to later resolve these issues by hand.
19049 Org will then generate an agenda view with all flagged entries. The user
19050 should then go through these entries and do whatever actions are necessary.
19051 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
19052 will be displayed in the echo area when the cursor is on the corresponding
19058 Pressing @kbd{?} in that special agenda will display the full flagging note in
19059 another window and also push it onto the kill ring. So you could use @kbd{?
19060 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
19061 Pressing @kbd{?} twice in succession will offer to remove the
19062 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
19063 in a property). In this way you indicate that the intended processing for
19064 this flagged entry is finished.
19069 If you are not able to process all flagged entries directly, you can always
19070 return to this agenda view@footnote{Note, however, that there is a subtle
19071 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
19072 is guaranteed to search all files that have been addressed by the last pull.
19073 This might include a file that is not currently in your list of agenda files.
19074 If you later use @kbd{C-c a ?} to regenerate the view, only the current
19075 agenda files will be searched.} using @kbd{C-c a ?}.
19077 @node History and acknowledgments
19078 @appendix History and acknowledgments
19079 @cindex acknowledgments
19083 @section From Carsten
19085 Org was born in 2003, out of frustration over the user interface of the Emacs
19086 Outline mode. I was trying to organize my notes and projects, and using
19087 Emacs seemed to be the natural way to go. However, having to remember eleven
19088 different commands with two or three keys per command, only to hide and show
19089 parts of the outline tree, that seemed entirely unacceptable to me. Also,
19090 when using outlines to take notes, I constantly wanted to restructure the
19091 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
19092 cycling} and @emph{structure editing} were originally implemented in the
19093 package @file{outline-magic.el}, but quickly moved to the more general
19094 @file{org.el}. As this environment became comfortable for project planning,
19095 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
19096 @emph{table support}. These areas highlighted the two main goals that Org
19097 still has today: to be a new, outline-based, plain text mode with innovative
19098 and intuitive editing features, and to incorporate project planning
19099 functionality directly into a notes file.
19101 Since the first release, literally thousands of emails to me or to
19102 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
19103 reports, feedback, new ideas, and sometimes patches and add-on code.
19104 Many thanks to everyone who has helped to improve this package. I am
19105 trying to keep here a list of the people who had significant influence
19106 in shaping one or more aspects of Org. The list may not be
19107 complete, if I have forgotten someone, please accept my apologies and
19110 Before I get to this list, a few special mentions are in order:
19113 @item Bastien Guerry
19114 Bastien has written a large number of extensions to Org (most of them
19115 integrated into the core by now), including the @LaTeX{} exporter and the
19116 plain list parser. His support during the early days was central to the
19117 success of this project. Bastien also invented Worg, helped establishing the
19118 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
19119 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
19120 I desparately needed a break.
19121 @item Eric Schulte and Dan Davison
19122 Eric and Dan are jointly responsible for the Org-babel system, which turns
19123 Org into a multi-language environment for evaluating code and doing literate
19124 programming and reproducible research. This has become one of Org's killer
19125 features that define what Org is today.
19127 John has contributed a number of great ideas and patches directly to Org,
19128 including the attachment system (@file{org-attach.el}), integration with
19129 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
19130 items, habit tracking (@file{org-habits.el}), and encryption
19131 (@file{org-crypt.el}). Also, the capture system is really an extended copy
19132 of his great @file{remember.el}.
19133 @item Sebastian Rose
19134 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
19135 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
19136 higher level. He also wrote @file{org-info.js}, a Java script for displaying
19137 web pages derived from Org using an Info-like or a folding interface with
19138 single-key navigation.
19141 @noindent See below for the full list of contributions! Again, please
19142 let me know what I am missing here!
19144 @section From Bastien
19146 I (Bastien) have been maintaining Org between 2011 and 2013. This appendix
19147 would not be complete without adding a few more acknowledgements and thanks.
19149 I am first grateful to Carsten for his trust while handing me over the
19150 maintainership of Org. His unremitting support is what really helped me
19151 getting more confident over time, with both the community and the code.
19153 When I took over maintainership, I knew I would have to make Org more
19154 collaborative than ever, as I would have to rely on people that are more
19155 knowledgeable than I am on many parts of the code. Here is a list of the
19156 persons I could rely on, they should really be considered co-maintainers,
19157 either of the code or the community:
19161 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
19162 from worrying about possible bugs here and let me focus on other parts.
19164 @item Nicolas Goaziou
19165 Nicolas is maintaining the consistency of the deepest parts of Org. His work
19166 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
19167 the doors for many new ideas and features. He rewrote many of the old
19168 exporters to use the new export engine, and helped with documenting this
19169 major change. More importantly (if that's possible), he has been more than
19170 reliable during all the work done for Org 8.0, and always very reactive on
19174 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
19175 into a flexible and conceptually clean process. He patiently coped with the
19176 many hiccups that such a change can create for users.
19179 The Org mode mailing list would not be such a nice place without Nick, who
19180 patiently helped users so many times. It is impossible to overestimate such
19181 a great help, and the list would not be so active without him.
19184 I received support from so many users that it is clearly impossible to be
19185 fair when shortlisting a few of them, but Org's history would not be
19186 complete if the ones above were not mentioned in this manual.
19188 @section List of contributions
19193 @i{Russel Adams} came up with the idea for drawers.
19195 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
19196 feedback on many features and several patches.
19198 @i{Luis Anaya} wrote @file{ox-man.el}.
19200 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
19202 @i{Michael Brand} helped by reporting many bugs and testing many features.
19203 He also implemented the distinction between empty fields and 0-value fields
19204 in Org's spreadsheets.
19206 @i{Christophe Bataillon} created the great unicorn logo that we use on the
19209 @i{Alex Bochannek} provided a patch for rounding timestamps.
19211 @i{Jan Böcker} wrote @file{org-docview.el}.
19213 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
19215 @i{Tom Breton} wrote @file{org-choose.el}.
19217 @i{Charles Cave}'s suggestion sparked the implementation of templates
19218 for Remember, which are now templates for capture.
19220 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
19223 @i{Gregory Chernov} patched support for Lisp forms into table
19224 calculations and improved XEmacs compatibility, in particular by porting
19225 @file{nouline.el} to XEmacs.
19227 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
19228 make Org pupular through her blog.
19230 @i{Toby S. Cubitt} contributed to the code for clock formats.
19232 @i{Baoqiu Cui} contributed the first DocBook exporter. In Org 8.0, we go a
19233 different route: you can now export to Texinfo and export the @file{.texi}
19234 file to DocBook using @code{makeinfo}.
19236 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
19237 came up with the idea of properties, and that there should be an API for
19240 @i{Nick Dokos} tracked down several nasty bugs.
19242 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
19243 inspired some of the early development, including HTML export. He also
19244 asked for a way to narrow wide table columns.
19246 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
19247 several years now. He also sponsored the hosting costs until Rackspace
19248 started to host us for free.
19250 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
19251 the Org-Babel documentation into the manual.
19253 @i{Christian Egli} converted the documentation into Texinfo format, inspired
19254 the agenda, patched CSS formatting into the HTML exporter, and wrote
19255 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
19256 @file{ox-taskjuggler.el} for Org 8.0.
19258 @i{David Emery} provided a patch for custom CSS support in exported
19261 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
19263 @i{Nic Ferrier} contributed mailcap and XOXO support.
19265 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
19267 @i{John Foerch} figured out how to make incremental search show context
19268 around a match in a hidden outline tree.
19270 @i{Raimar Finken} wrote @file{org-git-line.el}.
19272 @i{Mikael Fornius} works as a mailing list moderator.
19274 @i{Austin Frank} works as a mailing list moderator.
19276 @i{Eric Fraga} drove the development of BEAMER export with ideas and
19279 @i{Barry Gidden} did proofreading the manual in preparation for the book
19280 publication through Network Theory Ltd.
19282 @i{Niels Giesen} had the idea to automatically archive DONE trees.
19284 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
19285 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
19286 in implementing a clean framework for Org exporters.
19288 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
19290 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
19293 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
19294 task state change logging, and the clocktable. His clear explanations have
19295 been critical when we started to adopt the Git version control system.
19297 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
19300 @i{Phil Jackson} wrote @file{org-irc.el}.
19302 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
19303 folded entries, and column view for properties.
19305 @i{Matt Jones} wrote @i{MobileOrg Android}.
19307 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
19309 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
19311 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
19312 provided frequent feedback and some patches.
19314 @i{Matt Lundin} has proposed last-row references for table formulas and named
19315 invisible anchors. He has also worked a lot on the FAQ.
19317 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
19318 and is a prolific contributor on the mailing list with competent replies,
19319 small fixes and patches.
19321 @i{Jason F. McBrayer} suggested agenda export to CSV format.
19323 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
19325 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
19328 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
19331 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
19333 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
19334 and being able to quickly restrict the agenda to a subtree.
19336 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
19338 @i{Greg Newman} refreshed the unicorn logo into its current form.
19340 @i{Tim O'Callaghan} suggested in-file links, search options for general
19341 file links, and TAGS.
19343 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
19344 version of the reference card.
19346 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
19349 @i{Oliver Oppitz} suggested multi-state TODO items.
19351 @i{Scott Otterson} sparked the introduction of descriptive text for
19352 links, among other things.
19354 @i{Pete Phillips} helped during the development of the TAGS feature, and
19355 provided frequent feedback.
19357 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
19360 @i{Martin Pohlack} provided the code snippet to bundle character insertion
19361 into bundles of 20 for undo.
19363 @i{Rackspace.com} is hosting our website for free. Thank you Rackspace!
19365 @i{T.V. Raman} reported bugs and suggested improvements.
19367 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
19370 @i{Paul Rivier} provided the basic implementation of named footnotes. He
19371 also acted as mailing list moderator for some time.
19373 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
19375 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
19376 conflict with @file{allout.el}.
19378 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
19381 @i{Philip Rooke} created the Org reference card, provided lots
19382 of feedback, developed and applied standards to the Org documentation.
19384 @i{Christian Schlauer} proposed angular brackets around links, among
19387 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
19388 enjoy folding in non-org buffers by using Org headlines in comments.
19390 @i{Paul Sexton} wrote @file{org-ctags.el}.
19392 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
19393 @file{organizer-mode.el}.
19395 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
19396 examples, and remote highlighting for referenced code lines.
19398 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
19399 now packaged into Org's @file{contrib} directory.
19401 @i{Daniel Sinder} came up with the idea of internal archiving by locking
19404 @i{Dale Smith} proposed link abbreviations.
19406 @i{James TD Smith} has contributed a large number of patches for useful
19407 tweaks and features.
19409 @i{Adam Spiers} asked for global linking commands, inspired the link
19410 extension system, added support for mairix, and proposed the mapping API.
19412 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
19413 @LaTeX{}, UTF-8, Latin-1 and ASCII.
19415 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
19416 with links transformation to Org syntax.
19418 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
19419 chapter about publishing.
19421 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
19423 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
19424 enabled source code highlighting in Gnus.
19426 @i{Stefan Vollmar} organized a video-recorded talk at the
19427 Max-Planck-Institute for Neurology. He also inspired the creation of a
19428 concept index for HTML export.
19430 @i{Jürgen Vollmer} contributed code generating the table of contents
19433 @i{Samuel Wales} has provided important feedback and bug reports.
19435 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
19438 @i{David Wainberg} suggested archiving, and improvements to the linking
19441 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
19444 @i{Roland Winkler} requested additional key bindings to make Org
19447 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
19448 and contributed various ideas and code snippets.
19452 @node GNU Free Documentation License
19453 @appendix GNU Free Documentation License
19454 @include doclicense.texi
19458 @unnumbered Concept index
19463 @unnumbered Key index
19467 @node Command and Function Index
19468 @unnumbered Command and function index
19472 @node Variable Index
19473 @unnumbered Variable index
19475 This is not a complete index of variables and faces, only the ones that are
19476 mentioned in the manual. For a more complete list, use @kbd{M-x
19477 org-customize @key{RET}} and then click yourself through the tree.
19483 @c Local variables:
19485 @c indent-tabs-mode: nil
19486 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
19487 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
19491 @c LocalWords: webdavhost pre