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.
304 @node Top, Introduction, (dir), (dir)
311 * Introduction:: Getting started
312 * Document structure:: A tree works like your brain
313 * Tables:: Pure magic for quick formatting
314 * Hyperlinks:: Notes in context
315 * TODO items:: Every tree branch can be a TODO item
316 * Tags:: Tagging headlines and matching sets of tags
317 * Properties and columns:: Storing information about an entry
318 * Dates and times:: Making items useful for planning
319 * Capture - Refile - Archive:: The ins and outs for projects
320 * Agenda views:: Collecting information into views
321 * Markup:: Prepare text for rich export
322 * Exporting:: Sharing and publishing notes
323 * Publishing:: Create a web site of linked Org files
324 * Working with source code:: Export, evaluate, and tangle code blocks
325 * Miscellaneous:: All the rest which did not fit elsewhere
326 * Hacking:: How to hack your way around
327 * MobileOrg:: Viewing and capture on a mobile device
328 * History and acknowledgments:: How Org came into being
329 * GNU Free Documentation License:: The license for this documentation.
330 * Main Index:: An index of Org's concepts and features
331 * Key Index:: Key bindings and where they are described
332 * Command and Function Index:: Command names and some internal functions
333 * Variable Index:: Variables mentioned in the manual
336 --- The Detailed Node Listing ---
340 * Summary:: Brief summary of what Org does
341 * Installation:: Installing Org
342 * Activation:: How to activate Org for certain buffers
343 * Feedback:: Bug reports, ideas, patches etc.
344 * Conventions:: Typesetting conventions in the manual
348 * Outlines:: Org is based on Outline mode
349 * Headlines:: How to typeset Org tree headlines
350 * Visibility cycling:: Show and hide, much simplified
351 * Motion:: Jumping to other headlines
352 * Structure editing:: Changing sequence and level of headlines
353 * Sparse trees:: Matches embedded in context
354 * Plain lists:: Additional structure within an entry
355 * Drawers:: Tucking stuff away
356 * Blocks:: Folding blocks
357 * Footnotes:: How footnotes are defined in Org's syntax
358 * Orgstruct mode:: Structure editing outside Org
359 * Org syntax:: Formal description of Org's syntax
363 * Global and local cycling:: Cycling through various visibility states
364 * Initial visibility:: Setting the initial visibility state
365 * Catching invisible edits:: Preventing mistakes when editing invisible parts
369 * Built-in table editor:: Simple tables
370 * Column width and alignment:: Overrule the automatic settings
371 * Column groups:: Grouping to trigger vertical lines
372 * Orgtbl mode:: The table editor as minor mode
373 * The spreadsheet:: The table editor has spreadsheet capabilities
374 * Org-Plot:: Plotting from org tables
378 * References:: How to refer to another field or range
379 * Formula syntax for Calc:: Using Calc to compute stuff
380 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
381 * Durations and time values:: How to compute durations and time values
382 * Field and range formulas:: Formula for specific (ranges of) fields
383 * Column formulas:: Formulas valid for an entire column
384 * Lookup functions:: Lookup functions for searching tables
385 * Editing and debugging formulas:: Fixing formulas
386 * Updating the table:: Recomputing all dependent fields
387 * Advanced features:: Field and column names, parameters and automatic recalc
391 * Link format:: How links in Org are formatted
392 * Internal links:: Links to other places in the current file
393 * External links:: URL-like links to the world
394 * Handling links:: Creating, inserting and following
395 * Using links outside Org:: Linking from my C source code?
396 * Link abbreviations:: Shortcuts for writing complex links
397 * Search options:: Linking to a specific location
398 * Custom searches:: When the default search is not enough
402 * Radio targets:: Make targets trigger links in plain text
406 * TODO basics:: Marking and displaying TODO entries
407 * TODO extensions:: Workflow and assignments
408 * Progress logging:: Dates and notes for progress
409 * Priorities:: Some things are more important than others
410 * Breaking down tasks:: Splitting a task into manageable pieces
411 * Checkboxes:: Tick-off lists
413 Extended use of TODO keywords
415 * Workflow states:: From TODO to DONE in steps
416 * TODO types:: I do this, Fred does the rest
417 * Multiple sets in one file:: Mixing it all, and still finding your way
418 * Fast access to TODO states:: Single letter selection of a state
419 * Per-file keywords:: Different files, different requirements
420 * Faces for TODO keywords:: Highlighting states
421 * TODO dependencies:: When one task needs to wait for others
425 * Closing items:: When was this entry marked DONE?
426 * Tracking TODO state changes:: When did the status change?
427 * Tracking your habits:: How consistent have you been?
431 * Tag inheritance:: Tags use the tree structure of the outline
432 * Setting tags:: How to assign tags to a headline
433 * Tag hierarchy:: Create a hierarchy of tags
434 * Tag searches:: Searching for combinations of tags
436 Properties and columns
438 * Property syntax:: How properties are spelled out
439 * Special properties:: Access to other Org mode features
440 * Property searches:: Matching property values
441 * Property inheritance:: Passing values down the tree
442 * Column view:: Tabular viewing and editing
443 * Property API:: Properties for Lisp programmers
447 * Defining columns:: The COLUMNS format property
448 * Using column view:: How to create and use column view
449 * Capturing column view:: A dynamic block for column view
453 * Scope of column definitions:: Where defined, where valid?
454 * Column attributes:: Appearance and content of a column
458 * Timestamps:: Assigning a time to a tree entry
459 * Creating timestamps:: Commands which insert timestamps
460 * Deadlines and scheduling:: Planning your work
461 * Clocking work time:: Tracking how long you spend on a task
462 * Effort estimates:: Planning work effort in advance
463 * Timers:: Notes with a running timer
467 * The date/time prompt:: How Org mode helps you entering date and time
468 * Custom time format:: Making dates look different
470 Deadlines and scheduling
472 * Inserting deadline/schedule:: Planning items
473 * Repeated tasks:: Items that show up again and again
477 * Clocking commands:: Starting and stopping a clock
478 * The clock table:: Detailed reports
479 * Resolving idle time:: Resolving time when you've been idle
481 Capture - Refile - Archive
483 * Capture:: Capturing new stuff
484 * Attachments:: Add files to tasks
485 * RSS feeds:: Getting input from RSS feeds
486 * Protocols:: External (e.g., Browser) access to Emacs and Org
487 * Refile and copy:: Moving/copying a tree from one place to another
488 * Archiving:: What to do with finished projects
492 * Setting up capture:: Where notes will be stored
493 * Using capture:: Commands to invoke and terminate capture
494 * Capture templates:: Define the outline of different note types
498 * Template elements:: What is needed for a complete template entry
499 * Template expansion:: Filling in information about time and context
500 * Templates in contexts:: Only show a template in a specific context
504 * Moving subtrees:: Moving a tree to an archive file
505 * Internal archiving:: Switch off a tree but keep it in the file
509 * Agenda files:: Files being searched for agenda information
510 * Agenda dispatcher:: Keyboard access to agenda views
511 * Built-in agenda views:: What is available out of the box?
512 * Presentation and sorting:: How agenda items are prepared for display
513 * Agenda commands:: Remote editing of Org trees
514 * Custom agenda views:: Defining special searches and views
515 * Exporting agenda views:: Writing a view to a file
516 * Agenda column view:: Using column view for collected entries
518 The built-in agenda views
520 * Weekly/daily agenda:: The calendar page with current tasks
521 * Global TODO list:: All unfinished action items
522 * Matching tags and properties:: Structured information with fine-tuned search
523 * Timeline:: Time-sorted view for single file
524 * Search view:: Find entries by searching for text
525 * Stuck projects:: Find projects you need to review
527 Presentation and sorting
529 * Categories:: Not all tasks are equal
530 * Time-of-day specifications:: How the agenda knows the time
531 * Sorting agenda items:: The order of things
532 * Filtering/limiting agenda items:: Dynamically narrow the agenda
536 * Storing searches:: Type once, use often
537 * Block agenda:: All the stuff you need in a single buffer
538 * Setting options:: Changing the rules
540 Markup for rich export
542 * Paragraphs:: The basic unit of text
543 * Emphasis and monospace:: Bold, italic, etc.
544 * Horizontal rules:: Make a line
545 * Images and tables:: Images, tables and caption mechanism
546 * Literal examples:: Source code examples with special formatting
547 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
551 * Special symbols:: Greek letters and other symbols
552 * Subscripts and superscripts:: Simple syntax for raising/lowering text
553 * @LaTeX{} fragments:: Complex formulas made easy
554 * Previewing @LaTeX{} fragments:: What will this snippet look like?
555 * CDLaTeX mode:: Speed up entering of formulas
559 * The export dispatcher:: The main exporter interface
560 * Export settings:: Generic export settings
561 * Table of contents:: The if and where of the table of contents
562 * Include files:: Include additional files into a document
563 * Macro replacement:: Use macros to create templates
564 * Comment lines:: What will not be exported
565 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
566 * Beamer export:: Exporting as a Beamer presentation
567 * HTML export:: Exporting to HTML
568 * @LaTeX{} export:: Exporting to @LaTeX{}, and processing to PDF
569 * Markdown export:: Exporting to Markdown
570 * OpenDocument Text export:: Exporting to OpenDocument Text
571 * Org export:: Exporting to Org
572 * Texinfo export:: Exporting to Texinfo
573 * iCalendar export:: Exporting to iCalendar
574 * Other built-in back-ends:: Exporting to a man page
575 * Export in foreign buffers:: Author tables and lists in Org syntax
576 * Advanced configuration:: Fine-tuning the export output
580 * Beamer export commands:: How to export Beamer documents.
581 * Beamer specific export settings:: Export settings for Beamer export.
582 * Sectioning Frames and Blocks in Beamer:: Blocks and sections in Beamer.
583 * Beamer specific syntax:: Syntax specific to Beamer.
584 * Editing support:: Helper functions for Org Beamer export.
585 * A Beamer Example:: An complete Beamer example.
589 * HTML Export commands:: How to invoke HTML export
590 * HTML Specific export settings:: Export settings for HTML export
591 * HTML doctypes:: Org can export to various (X)HTML flavors
592 * HTML preamble and postamble:: How to insert a preamble and a postamble
593 * Quoting HTML tags:: Using direct HTML in Org mode
594 * Links in HTML export:: How links will be interpreted and formatted
595 * Tables in HTML export:: How to modify the formatting of tables
596 * Images in HTML export:: How to insert figures into HTML output
597 * Math formatting in HTML export:: Beautiful math also on the web
598 * Text areas in HTML export:: An alternative way to show an example
599 * CSS support:: Changing the appearance of the output
600 * JavaScript support:: Info and Folding in a web browser
604 * @LaTeX{} export commands:: How to export to @LaTeX{} and PDF
605 * @LaTeX{} specific export settings:: Export settings for @LaTeX{}
606 * @LaTeX{} header and sectioning:: Setting up the export file structure
607 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
608 * Tables in @LaTeX{} export:: Specific attributes for tables
609 * Images in @LaTeX{} export:: Specific attributes for images
610 * Plain lists in @LaTeX{} export:: Specific attributes for plain lists
611 * Source blocks in @LaTeX{} export:: Specific attributes for source blocks
612 * Example blocks in @LaTeX{} export:: Specific attributes for example blocks
613 * Special blocks in @LaTeX{} export:: Specific attributes for special blocks
614 * Horizontal rules in @LaTeX{} export:: Specific attributes for horizontal rules
616 OpenDocument Text export
618 * Pre-requisites for ODT export:: What packages ODT exporter relies on
619 * ODT export commands:: How to invoke ODT export
620 * ODT specific export settings:: Export settings for ODT
621 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
622 * Applying custom styles:: How to apply custom styles to the output
623 * Links in ODT export:: How links will be interpreted and formatted
624 * Tables in ODT export:: How Tables are exported
625 * Images in ODT export:: How to insert images
626 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
627 * Labels and captions in ODT export:: How captions are rendered
628 * Literal examples in ODT export:: How source and example blocks are formatted
629 * Advanced topics in ODT export:: Read this if you are a power user
631 Math formatting in ODT export
633 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
634 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
636 Advanced topics in ODT export
638 * Configuring a document converter:: How to register a document converter
639 * Working with OpenDocument style files:: Explore the internals
640 * Creating one-off styles:: How to produce custom highlighting etc
641 * Customizing tables in ODT export:: How to define and use Table templates
642 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
646 * Texinfo export commands:: How to invoke Texinfo export
647 * Texinfo specific export settings:: Export settings for Texinfo
648 * Texinfo file header:: Generating the begining of a Texinfo file
649 * Texinfo title and copyright page:: Creating title and copyright pages
650 * Texinfo @samp{Top} node:: Installing a manual in Info Top node
651 * Headings and sectioning structure:: Building document structure
652 * Indices:: Creating indices
653 * Quoting Texinfo code:: Incorporating literal Texinfo code
654 * Plain lists in Texinfo export:: Specific attributes for plain lists
655 * Tables in Texinfo export:: Specific attributes for tables
656 * Images in Texinfo export:: Specific attributes for images
657 * Special blocks in Texinfo export:: Specific attributes for special blocks
658 * A Texinfo example:: Illustrating Org to Texinfo process
662 * Configuration:: Defining projects
663 * Uploading files:: How to get files up on the server
664 * Sample configuration:: Example projects
665 * Triggering publication:: Publication commands
669 * Project alist:: The central configuration variable
670 * Sources and destinations:: From here to there
671 * Selecting files:: What files are part of the project?
672 * Publishing action:: Setting the function doing the publishing
673 * Publishing options:: Tweaking HTML/@LaTeX{} export
674 * Publishing links:: Which links keep working after publishing?
675 * Sitemap:: Generating a list of all pages
676 * Generating an index:: An index that reaches across pages
680 * Simple example:: One-component publishing
681 * Complex example:: A multi-component publishing example
683 Working with source code
685 * Structure of code blocks:: Code block syntax described
686 * Editing source code:: Language major-mode editing
687 * Exporting code blocks:: Export contents and/or results
688 * Extracting source code:: Create pure source code files
689 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
690 * Library of Babel:: Use and contribute to a library of useful code blocks
691 * Languages:: List of supported code block languages
692 * Header arguments:: Configure code block functionality
693 * Results of evaluation:: How evaluation results are handled
694 * Noweb reference syntax:: Literate programming in Org mode
695 * Key bindings and useful functions:: Work quickly with code blocks
696 * Batch execution:: Call functions from the command line
700 * Using header arguments:: Different ways to set header arguments
701 * Specific header arguments:: List of header arguments
703 Using header arguments
705 * System-wide header arguments:: Set global default values
706 * Language-specific header arguments:: Set default values by language
707 * Header arguments in Org mode properties:: Set default values for a buffer or heading
708 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
709 * Code block specific header arguments:: The most common way to set values
710 * Header arguments in function calls:: The most specific level
712 Specific header arguments
714 * var:: Pass arguments to code blocks
715 * results:: Specify the type of results and how they will
716 be collected and handled
717 * file:: Specify a path for file output
718 * file-desc:: Specify a description for file results
719 * file-ext:: Specify an extension for file output
720 * output-dir:: Specify a directory to write file output to
721 * dir:: Specify the default (possibly remote)
722 directory for code block execution
723 * exports:: Export code and/or results
724 * tangle:: Toggle tangling and specify file name
725 * mkdirp:: Toggle creation of parent directories of target
726 files during tangling
727 * comments:: Toggle insertion of comments in tangled
729 * padline:: Control insertion of padding lines in tangled
731 * no-expand:: Turn off variable assignment and noweb
732 expansion during tangling
733 * session:: Preserve the state of code evaluation
734 * noweb:: Toggle expansion of noweb references
735 * noweb-ref:: Specify block's noweb reference resolution target
736 * noweb-sep:: String used to separate noweb references
737 * cache:: Avoid re-evaluating unchanged code blocks
738 * sep:: Delimiter for writing tabular results outside Org
739 * hlines:: Handle horizontal lines in tables
740 * colnames:: Handle column names in tables
741 * rownames:: Handle row names in tables
742 * shebang:: Make tangled files executable
743 * tangle-mode:: Set permission of tangled files
744 * eval:: Limit evaluation of specific code blocks
745 * wrap:: Mark source block evaluation results
746 * post:: Post processing of code block results
747 * prologue:: Text to prepend to code block body
748 * epilogue:: Text to append to code block body
752 * Completion:: M-TAB knows what you need
753 * Easy templates:: Quick insertion of structural elements
754 * Speed keys:: Electric commands at the beginning of a headline
755 * Code evaluation security:: Org mode files evaluate inline code
756 * Customization:: Adapting Org to your taste
757 * In-buffer settings:: Overview of the #+KEYWORDS
758 * The very busy C-c C-c key:: When in doubt, press C-c C-c
759 * Clean view:: Getting rid of leading stars in the outline
760 * TTY keys:: Using Org on a tty
761 * Interaction:: Other Emacs packages
762 * org-crypt:: Encrypting Org files
764 Interaction with other packages
766 * Cooperation:: Packages Org cooperates with
767 * Conflicts:: Packages that lead to conflicts
771 * Hooks:: How to reach into Org's internals
772 * Add-on packages:: Available extensions
773 * Adding hyperlink types:: New custom link types
774 * Adding export back-ends:: How to write new export back-ends
775 * Context-sensitive commands:: How to add functionality to such commands
776 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
777 * Dynamic blocks:: Automatically filled blocks
778 * Special agenda views:: Customized views
779 * Speeding up your agendas:: Tips on how to speed up your agendas
780 * Extracting agenda information:: Post-processing of agenda information
781 * Using the property API:: Writing programs that use entry properties
782 * Using the mapping API:: Mapping over all or selected entries
784 Tables and lists in arbitrary syntax
786 * Radio tables:: Sending and receiving radio tables
787 * A @LaTeX{} example:: Step by step, almost a tutorial
788 * Translator functions:: Copy and modify
789 * Radio lists:: Sending and receiving lists
793 * Setting up the staging area:: Where to interact with the mobile device
794 * Pushing to MobileOrg:: Uploading Org files and agendas
795 * Pulling from MobileOrg:: Integrating captured and flagged items
801 @chapter Introduction
805 * Summary:: Brief summary of what Org does
806 * Installation:: Installing Org
807 * Activation:: How to activate Org for certain buffers
808 * Feedback:: Bug reports, ideas, patches etc.
809 * Conventions:: Typesetting conventions in the manual
816 Org is a mode for keeping notes, maintaining TODO lists, and project planning
817 with a fast and effective plain-text system. It also is an authoring system
818 with unique support for literate programming and reproducible research.
820 Org is implemented on top of Outline mode, which makes it possible to keep
821 the content of large files well structured. Visibility cycling and structure
822 editing help to work with the tree. Tables are easily created with a
823 built-in table editor. Plain text URL-like links connect to websites,
824 emails, Usenet messages, BBDB entries, and any files related to the projects.
826 Org develops organizational tasks around notes files that contain lists or
827 information about projects as plain text. Project planning and task
828 management makes use of metadata which is part of an outline node. Based on
829 this data, specific entries can be extracted in queries and create dynamic
830 @i{agenda views} that also integrate the Emacs calendar and diary. Org can
831 be used to implement many different project planning schemes, such as David
834 Org files can serve as a single source authoring system with export to many
835 different formats such as HTML, @LaTeX{}, Open Document, and Markdown. New
836 export backends can be derived from existing ones, or defined from scratch.
838 Org files can include source code blocks, which makes Org uniquely suited for
839 authoring technical documents with code examples. Org source code blocks are
840 fully functional; they can be evaluated in place and their results can be
841 captured in the file. This makes it possible to create a single file
842 reproducible research compendium.
844 Org keeps simple things simple. When first fired up, it should feel like a
845 straightforward, easy to use outliner. Complexity is not imposed, but a
846 large amount of functionality is available when needed. Org is a toolbox.
847 Many users actually run only a (very personal) fraction of Org's capabilities, and
848 know that there is more whenever they need it.
850 All of this is achieved with strictly plain text files, the most portable and
851 future-proof file format. Org runs in Emacs. Emacs is one of the most
852 widely ported programs, so that Org mode is available on every major
856 There is a website for Org which provides links to the newest
857 version of Org, as well as additional information, frequently asked
858 questions (FAQ), links to tutorials, etc. This page is located at
859 @uref{http://orgmode.org}.
860 @cindex print edition
862 An earlier version (7.3) of this manual is available as a
863 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
869 @section Installation
872 Org is part of recent distributions of GNU Emacs, so you normally don't need
873 to install it. If, for one reason or another, you want to install Org on top
874 of this pre-packaged version, there are three ways to do it:
877 @item By using Emacs package system.
878 @item By downloading Org as an archive.
879 @item By using Org's git repository.
882 We @b{strongly recommend} to stick to a single installation method.
884 @subsubheading Using Emacs packaging system
886 Recent Emacs distributions include a packaging system which lets you install
887 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
889 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
890 been visited, i.e., where no Org built-in function have been loaded.
891 Otherwise autoload Org functions will mess up the installation.
893 Then, to make sure your Org configuration is taken into account, initialize
894 the package system with @code{(package-initialize)} in your @file{.emacs}
895 before setting any Org option. If you want to use Org's package repository,
896 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
898 @subsubheading Downloading Org as an archive
900 You can download Org latest release from @uref{http://orgmode.org/, Org's
901 website}. In this case, make sure you set the load-path correctly in your
905 (add-to-list 'load-path "~/path/to/orgdir/lisp")
908 The downloaded archive contains contributed libraries that are not included
909 in Emacs. If you want to use them, add the @file{contrib} directory to your
913 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
916 Optionally, you can compile the files and/or install them in your system.
917 Run @code{make help} to list compilation and installation options.
919 @subsubheading Using Org's git repository
921 You can clone Org's repository and install Org like this:
925 $ git clone git://orgmode.org/org-mode.git
929 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
930 version in @file{org-version.el} and Org's autoloads in
931 @file{org-loaddefs.el}.
933 Remember to add the correct load-path as described in the method above.
935 You can also compile with @code{make}, generate the documentation with
936 @code{make doc}, create a local configuration with @code{make config} and
937 install Org with @code{make install}. Please run @code{make help} to get
938 the list of compilation/installation options.
940 For more detailed explanations on Org's build system, please check the Org
941 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
949 @cindex global key bindings
950 @cindex key bindings, global
953 @findex org-store-link
956 Org mode buffers need font-lock to be turned on: this is the default in
957 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
958 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
960 There are compatibility issues between Org mode and some other Elisp
961 packages, please take the time to check the list (@pxref{Conflicts}).
963 The four Org commands @command{org-store-link}, @command{org-capture},
964 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
965 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
966 suggested bindings for these keys, please modify the keys to your own
969 (global-set-key "\C-cl" 'org-store-link)
970 (global-set-key "\C-ca" 'org-agenda)
971 (global-set-key "\C-cc" 'org-capture)
972 (global-set-key "\C-cb" 'org-iswitchb)
975 @cindex Org mode, turning on
976 Files with the @file{.org} extension use Org mode by default. To turn on Org
977 mode in a file that does not have the extension @file{.org}, make the first
978 line of a file look like this:
981 MY PROJECTS -*- mode: org; -*-
984 @vindex org-insert-mode-line-in-empty-file
985 @noindent which will select Org mode for this buffer no matter what
986 the file's name is. See also the variable
987 @code{org-insert-mode-line-in-empty-file}.
989 Many commands in Org work on the region if the region is @i{active}. To make
990 use of this, you need to have @code{transient-mark-mode} turned on, which is
991 the default. If you do not like @code{transient-mark-mode}, you can create
992 an 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}.
1087 Do whatever you have to do to hit the error. Don't forget to
1088 document the steps you take.
1090 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1091 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1092 attach it to your bug report.
1096 @section Typesetting conventions used in this manual
1098 @subsubheading TODO keywords, tags, properties, etc.
1100 Org mainly uses three types of keywords: TODO keywords, tags and property
1101 names. In this manual we use the following conventions:
1106 TODO keywords are written with all capitals, even if they are
1110 User-defined tags are written in lowercase; built-in tags with special
1111 meaning are written with all capitals.
1114 User-defined properties are capitalized; built-in properties with
1115 special meaning are written with all capitals.
1118 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1119 and @i{environment keywords} (like @code{#+BEGIN_EXPORT html} to start
1120 a @code{HTML} environment). They are written in uppercase in the manual to
1121 enhance its readability, but you can use lowercase in your Org
1122 files@footnote{Easy templates insert lowercase keywords and Babel dynamically
1123 inserts @code{#+results}.}.
1125 @subsubheading Key bindings and commands
1131 The manual suggests a few global key bindings, in particular @kbd{C-c a} for
1132 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}. These are only
1133 suggestions, but the rest of the manual assumes that these key bindings are in
1134 place in order to list commands by key access.
1136 Also, the manual lists both the keys and the corresponding commands for
1137 accessing a functionality. Org mode often uses the same key for different
1138 functions, depending on context. The command that is bound to such keys has
1139 a generic name, like @code{org-metaright}. In the manual we will, wherever
1140 possible, give the function that is internally called by the generic command.
1141 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1142 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1143 will be listed to call @code{org-table-move-column-right}. If you prefer,
1144 you can compile the manual without the command names by unsetting the flag
1145 @code{cmdnames} in @file{org.texi}.
1147 @node Document structure
1148 @chapter Document structure
1149 @cindex document structure
1150 @cindex structure of document
1152 Org is based on Outline mode and provides flexible commands to
1153 edit the structure of the document.
1156 * Outlines:: Org is based on Outline mode
1157 * Headlines:: How to typeset Org tree headlines
1158 * Visibility cycling:: Show and hide, much simplified
1159 * Motion:: Jumping to other headlines
1160 * Structure editing:: Changing sequence and level of headlines
1161 * Sparse trees:: Matches embedded in context
1162 * Plain lists:: Additional structure within an entry
1163 * Drawers:: Tucking stuff away
1164 * Blocks:: Folding blocks
1165 * Footnotes:: How footnotes are defined in Org's syntax
1166 * Orgstruct mode:: Structure editing outside Org
1167 * Org syntax:: Formal description of Org's syntax
1173 @cindex Outline mode
1175 Org is implemented on top of Outline mode. Outlines allow a
1176 document to be organized in a hierarchical structure, which (at least
1177 for me) is the best representation of notes and thoughts. An overview
1178 of this structure is achieved by folding (hiding) large parts of the
1179 document to show only the general document structure and the parts
1180 currently being worked on. Org greatly simplifies the use of
1181 outlines by compressing the entire show/hide functionality into a single
1182 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1187 @cindex outline tree
1188 @vindex org-special-ctrl-a/e
1189 @vindex org-special-ctrl-k
1190 @vindex org-ctrl-k-protect-subtree
1192 Headlines define the structure of an outline tree. The headlines in Org
1193 start with one or more stars, on the left margin@footnote{See the variables
1194 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1195 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1196 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1197 headings indented less than 30 stars.}. For example:
1200 * Top level headline
1207 * Another top level headline
1210 @vindex org-footnote-section
1211 @noindent Note that a headline named after @code{org-footnote-section},
1212 which defaults to @samp{Footnotes}, is considered as special. A subtree with
1213 this headline will be silently ignored by exporting functions.
1215 Some people find the many stars too noisy and would prefer an
1216 outline that has whitespace followed by a single star as headline
1217 starters. @ref{Clean view}, describes a setup to realize this.
1219 @vindex org-cycle-separator-lines
1220 An empty line after the end of a subtree is considered part of it and
1221 will be hidden when the subtree is folded. However, if you leave at
1222 least two empty lines, one empty line will remain visible after folding
1223 the subtree, in order to structure the collapsed view. See the
1224 variable @code{org-cycle-separator-lines} to modify this behavior.
1226 @node Visibility cycling
1227 @section Visibility cycling
1228 @cindex cycling, visibility
1229 @cindex visibility cycling
1230 @cindex trees, visibility
1231 @cindex show hidden text
1235 * Global and local cycling:: Cycling through various visibility states
1236 * Initial visibility:: Setting the initial visibility state
1237 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1240 @node Global and local cycling
1241 @subsection Global and local cycling
1243 Outlines make it possible to hide parts of the text in the buffer.
1244 Org uses just two commands, bound to @key{TAB} and
1245 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1247 @cindex subtree visibility states
1248 @cindex subtree cycling
1249 @cindex folded, subtree visibility state
1250 @cindex children, subtree visibility state
1251 @cindex subtree, subtree visibility state
1253 @orgcmd{@key{TAB},org-cycle}
1254 @emph{Subtree cycling}: Rotate current subtree among the states
1257 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1258 '-----------------------------------'
1261 @vindex org-cycle-emulate-tab
1262 @vindex org-cycle-global-at-bob
1263 The cursor must be on a headline for this to work@footnote{see, however,
1264 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1265 beginning of the buffer and the first line is not a headline, then
1266 @key{TAB} actually runs global cycling (see below)@footnote{see the
1267 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1268 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1270 @cindex global visibility states
1271 @cindex global cycling
1272 @cindex overview, global visibility state
1273 @cindex contents, global visibility state
1274 @cindex show all, global visibility state
1275 @orgcmd{S-@key{TAB},org-global-cycle}
1276 @itemx C-u @key{TAB}
1277 @emph{Global cycling}: Rotate the entire buffer among the states
1280 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1281 '--------------------------------------'
1284 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1285 CONTENTS view up to headlines of level N will be shown. Note that inside
1286 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1288 @cindex set startup visibility, command
1289 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1290 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1291 @cindex show all, command
1292 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1293 Show all, including drawers.
1294 @cindex revealing context
1295 @orgcmd{C-c C-r,org-reveal}
1296 Reveal context around point, showing the current entry, the following heading
1297 and the hierarchy above. Useful for working near a location that has been
1298 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1299 (@pxref{Agenda commands}). With a prefix argument show, on each
1300 level, all sibling headings. With a double prefix argument, also show the
1301 entire subtree of the parent.
1302 @cindex show branches, command
1303 @orgcmd{C-c C-k,show-branches}
1304 Expose all the headings of the subtree, CONTENT view for just one subtree.
1305 @cindex show children, command
1306 @orgcmd{C-c @key{TAB},show-children}
1307 Expose all direct children of the subtree. With a numeric prefix argument N,
1308 expose all children down to level N@.
1309 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1310 Show the current subtree in an indirect buffer@footnote{The indirect buffer
1311 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
1312 buffer, but will be narrowed to the current tree. Editing the indirect
1313 buffer will also change the original buffer, but without affecting visibility
1314 in that buffer.}. With a numeric prefix argument N, go up to level N and
1315 then take that tree. If N is negative then go up that many levels. With a
1316 @kbd{C-u} prefix, do not remove the previously used indirect buffer.
1317 @orgcmd{C-c C-x v,org-copy-visible}
1318 Copy the @i{visible} text in the region into the kill ring.
1321 @node Initial visibility
1322 @subsection Initial visibility
1324 @cindex visibility, initialize
1325 @vindex org-startup-folded
1326 @vindex org-agenda-inhibit-startup
1327 @cindex @code{overview}, STARTUP keyword
1328 @cindex @code{content}, STARTUP keyword
1329 @cindex @code{showall}, STARTUP keyword
1330 @cindex @code{showeverything}, STARTUP keyword
1332 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1333 i.e., only the top level headlines are visible@footnote{When
1334 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1335 visibility state when first opening a file for the agenda (@pxref{Speeding up
1336 your agendas}).}. This can be configured through the variable
1337 @code{org-startup-folded}, or on a per-file basis by adding one of the
1338 following lines anywhere in the buffer:
1344 #+STARTUP: showeverything
1347 The startup visibility options are ignored when the file is open for the
1348 first time during the agenda generation: if you want the agenda to honor
1349 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1351 @cindex property, VISIBILITY
1353 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1354 and columns}) will get their visibility adapted accordingly. Allowed values
1355 for this property are @code{folded}, @code{children}, @code{content}, and
1359 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1360 Switch back to the startup visibility of the buffer, i.e., whatever is
1361 requested by startup options and @samp{VISIBILITY} properties in individual
1365 @node Catching invisible edits
1366 @subsection Catching invisible edits
1368 @vindex org-catch-invisible-edits
1369 @cindex edits, catching invisible
1370 Sometimes you may inadvertently edit an invisible part of the buffer and be
1371 confused on what has been edited and how to undo the mistake. Setting
1372 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
1373 docstring of this option on how Org should catch invisible edits and process
1378 @cindex motion, between headlines
1379 @cindex jumping, to headlines
1380 @cindex headline navigation
1381 The following commands jump to other headlines in the buffer.
1384 @orgcmd{C-c C-n,outline-next-visible-heading}
1386 @orgcmd{C-c C-p,outline-previous-visible-heading}
1388 @orgcmd{C-c C-f,org-forward-same-level}
1389 Next heading same level.
1390 @orgcmd{C-c C-b,org-backward-same-level}
1391 Previous heading same level.
1392 @orgcmd{C-c C-u,outline-up-heading}
1393 Backward to higher level heading.
1394 @orgcmd{C-c C-j,org-goto}
1395 Jump to a different place without changing the current outline
1396 visibility. Shows the document structure in a temporary buffer, where
1397 you can use the following keys to find your destination:
1398 @vindex org-goto-auto-isearch
1400 @key{TAB} @r{Cycle visibility.}
1401 @key{down} / @key{up} @r{Next/previous visible headline.}
1402 @key{RET} @r{Select this location.}
1403 @kbd{/} @r{Do a Sparse-tree search}
1404 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1405 n / p @r{Next/previous visible headline.}
1406 f / b @r{Next/previous headline same level.}
1408 0-9 @r{Digit argument.}
1411 @vindex org-goto-interface
1413 See also the option @code{org-goto-interface}.
1416 @node Structure editing
1417 @section Structure editing
1418 @cindex structure editing
1419 @cindex headline, promotion and demotion
1420 @cindex promotion, of subtrees
1421 @cindex demotion, of subtrees
1422 @cindex subtree, cut and paste
1423 @cindex pasting, of subtrees
1424 @cindex cutting, of subtrees
1425 @cindex copying, of subtrees
1426 @cindex sorting, of subtrees
1427 @cindex subtrees, cut and paste
1430 @orgcmd{M-@key{RET},org-insert-heading}
1431 @vindex org-M-RET-may-split-line
1432 Insert a new heading/item with the same level as the one at point.
1434 If the cursor is in a plain list item, a new item is created (@pxref{Plain
1435 lists}). To prevent this behavior in lists, call the command with one prefix
1436 argument. When this command is used in the middle of a line, the line is
1437 split and the rest of the line becomes the new item or headline. If you do
1438 not want the line to be split, customize @code{org-M-RET-may-split-line}.
1440 If the command is used at the @emph{beginning} of a line, and if there is a
1441 heading or an item at point, the new heading/item is created @emph{before}
1442 the current line. If the command is used at the @emph{end} of a folded
1443 subtree (i.e., behind the ellipses at the end of a headline), then a headline
1444 will be inserted after the end of the subtree.
1446 Calling this command with @kbd{C-u C-u} will unconditionally respect the
1447 headline's content and create a new item at the end of the parent subtree.
1449 If point is at the beginning of a normal line, turn this line into a heading.
1450 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1451 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1452 current heading, the new heading is placed after the body instead of before
1453 it. This command works from anywhere in the entry.
1454 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1455 @vindex org-treat-insert-todo-heading-as-state-change
1456 Insert new TODO entry with same level as current heading. See also the
1457 variable @code{org-treat-insert-todo-heading-as-state-change}.
1458 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1459 Insert new TODO entry with same level as current heading. Like
1460 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1462 @orgcmd{@key{TAB},org-cycle}
1463 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1464 become a child of the previous one. The next @key{TAB} makes it a parent,
1465 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1466 to the initial level.
1467 @orgcmd{M-@key{left},org-do-promote}
1468 Promote current heading by one level.
1469 @orgcmd{M-@key{right},org-do-demote}
1470 Demote current heading by one level.
1471 @orgcmd{M-S-@key{left},org-promote-subtree}
1472 Promote the current subtree by one level.
1473 @orgcmd{M-S-@key{right},org-demote-subtree}
1474 Demote the current subtree by one level.
1475 @orgcmd{M-S-@key{up},org-move-subtree-up}
1476 Move subtree up (swap with previous subtree of same
1478 @orgcmd{M-S-@key{down},org-move-subtree-down}
1479 Move subtree down (swap with next subtree of same level).
1480 @orgcmd{M-h,org-mark-element}
1481 Mark the element at point. Hitting repeatedly will mark subsequent elements
1482 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1483 hitting @key{M-h} immediately again will mark the next one.
1484 @orgcmd{C-c @@,org-mark-subtree}
1485 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1486 of the same level than the marked subtree.
1487 @orgcmd{C-c C-x C-w,org-cut-subtree}
1488 Kill subtree, i.e., remove it from buffer but save in kill ring.
1489 With a numeric prefix argument N, kill N sequential subtrees.
1490 @orgcmd{C-c C-x M-w,org-copy-subtree}
1491 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1492 sequential subtrees.
1493 @orgcmd{C-c C-x C-y,org-paste-subtree}
1494 Yank subtree from kill ring. This does modify the level of the subtree to
1495 make sure the tree fits in nicely at the yank position. The yank level can
1496 also be specified with a numeric prefix argument, or by yanking after a
1497 headline marker like @samp{****}.
1498 @orgcmd{C-y,org-yank}
1499 @vindex org-yank-adjusted-subtrees
1500 @vindex org-yank-folded-subtrees
1501 Depending on the options @code{org-yank-adjusted-subtrees} and
1502 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1503 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1504 C-x C-y}. With the default settings, no level adjustment will take place,
1505 but the yanked tree will be folded unless doing so would swallow text
1506 previously visible. Any prefix argument to this command will force a normal
1507 @code{yank} to be executed, with the prefix passed along. A good way to
1508 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1509 yank, it will yank previous kill items plainly, without adjustment and
1511 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1512 Clone a subtree by making a number of sibling copies of it. You will be
1513 prompted for the number of copies to make, and you can also specify if any
1514 timestamps in the entry should be shifted. This can be useful, for example,
1515 to create a number of tasks related to a series of lectures to prepare. For
1516 more details, see the docstring of the command
1517 @code{org-clone-subtree-with-time-shift}.
1518 @orgcmd{C-c C-w,org-refile}
1519 Refile entry or region to a different location. @xref{Refile and copy}.
1520 @orgcmd{C-c ^,org-sort}
1521 Sort same-level entries. When there is an active region, all entries in the
1522 region will be sorted. Otherwise the children of the current headline are
1523 sorted. The command prompts for the sorting method, which can be
1524 alphabetically, numerically, by time (first timestamp with active preferred,
1525 creation time, scheduled time, deadline time), by priority, by TODO keyword
1526 (in the sequence the keywords have been defined in the setup) or by the value
1527 of a property. Reverse sorting is possible as well. You can also supply
1528 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1529 sorting will be case-sensitive.
1530 @orgcmd{C-x n s,org-narrow-to-subtree}
1531 Narrow buffer to current subtree.
1532 @orgcmd{C-x n b,org-narrow-to-block}
1533 Narrow buffer to current block.
1534 @orgcmd{C-x n w,widen}
1535 Widen buffer to remove narrowing.
1536 @orgcmd{C-c *,org-toggle-heading}
1537 Turn a normal line or plain list item into a headline (so that it becomes a
1538 subheading at its location). Also turn a headline into a normal line by
1539 removing the stars. If there is an active region, turn all lines in the
1540 region into headlines. If the first line in the region was an item, turn
1541 only the item lines into headlines. Finally, if the first line is a
1542 headline, remove the stars from all headlines in the region.
1545 @cindex region, active
1546 @cindex active region
1547 @cindex transient mark mode
1548 When there is an active region (Transient Mark mode), promotion and
1549 demotion work on all headlines in the region. To select a region of
1550 headlines, it is best to place both point and mark at the beginning of a
1551 line, mark at the beginning of the first headline, and point at the line
1552 just after the last headline to change. Note that when the cursor is
1553 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1558 @section Sparse trees
1559 @cindex sparse trees
1560 @cindex trees, sparse
1561 @cindex folding, sparse trees
1562 @cindex occur, command
1564 @vindex org-show-context-detail
1565 An important feature of Org mode is the ability to construct @emph{sparse
1566 trees} for selected information in an outline tree, so that the entire
1567 document is folded as much as possible, but the selected information is made
1568 visible along with the headline structure above it@footnote{See also the
1569 variable @code{org-show-context-detail} to decide how much context is shown
1570 around each match.}. Just try it out and you will see immediately how it
1573 Org mode contains several commands for creating such trees, all these
1574 commands can be accessed through a dispatcher:
1577 @orgcmd{C-c /,org-sparse-tree}
1578 This prompts for an extra key to select a sparse-tree creating command.
1579 @orgcmd{C-c / r,org-occur}
1580 @vindex org-remove-highlights-with-change
1581 Prompts for a regexp and shows a sparse tree with all matches. If
1582 the match is in a headline, the headline is made visible. If the match is in
1583 the body of an entry, headline and body are made visible. In order to
1584 provide minimal context, also the full hierarchy of headlines above the match
1585 is shown, as well as the headline following the match. Each match is also
1586 highlighted; the highlights disappear when the buffer is changed by an
1587 editing command@footnote{This depends on the option
1588 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1589 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1590 so several calls to this command can be stacked.
1591 @orgcmdkkc{M-g n,M-g M-n,next-error}
1592 Jump to the next sparse tree match in this buffer.
1593 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1594 Jump to the previous sparse tree match in this buffer.
1598 @vindex org-agenda-custom-commands
1599 For frequently used sparse trees of specific search strings, you can
1600 use the option @code{org-agenda-custom-commands} to define fast
1601 keyboard access to specific sparse trees. These commands will then be
1602 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1606 (setq org-agenda-custom-commands
1607 '(("f" occur-tree "FIXME")))
1610 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1611 a sparse tree matching the string @samp{FIXME}.
1613 The other sparse tree commands select headings based on TODO keywords,
1614 tags, or properties and will be discussed later in this manual.
1617 @cindex printing sparse trees
1618 @cindex visible text, printing
1619 To print a sparse tree, you can use the Emacs command
1620 @code{ps-print-buffer-with-faces} which does not print invisible parts of the
1621 document. Or you can use @kbd{C-c C-e C-v} to export only the visible part
1622 of the document and print the resulting file.
1625 @section Plain lists
1627 @cindex lists, plain
1628 @cindex lists, ordered
1629 @cindex ordered lists
1631 Within an entry of the outline tree, hand-formatted lists can provide
1632 additional structure. They also provide a way to create lists of checkboxes
1633 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1634 (@pxref{Exporting}) can parse and format them.
1636 Org knows ordered lists, unordered lists, and description lists.
1639 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1640 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1641 they will be seen as top-level headlines. Also, when you are hiding leading
1642 stars to get a clean outline view, plain list items starting with a star may
1643 be hard to distinguish from true headlines. In short: even though @samp{*}
1644 is supported, it may be better to not use it for plain list items.} as
1647 @vindex org-plain-list-ordered-item-terminator
1648 @vindex org-list-allow-alphabetical
1649 @emph{Ordered} list items start with a numeral followed by either a period or
1650 a right parenthesis@footnote{You can filter out any of them by configuring
1651 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1652 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1653 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1654 confusion with normal text, those are limited to one character only. Beyond
1655 that limit, bullets will automatically fallback to numbers.}. If you want a
1656 list to start with a different value (e.g., 20), start the text of the item
1657 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1658 must be put @emph{before} the checkbox. If you have activated alphabetical
1659 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1660 be used in any item of the list in order to enforce a particular numbering.
1662 @emph{Description} list items are unordered list items, and contain the
1663 separator @samp{ :: } to distinguish the description @emph{term} from the
1667 Items belonging to the same list must have the same indentation on the first
1668 line. In particular, if an ordered list reaches number @samp{10.}, then the
1669 2--digit numbers must be written left-aligned with the other numbers in the
1670 list. An item ends before the next line that is less or equally indented
1671 than its bullet/number.
1673 @vindex org-list-empty-line-terminates-plain-lists
1674 A list ends whenever every item has ended, which means before any line less
1675 or equally indented than items at top level. It also ends before two blank
1676 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1677 In that case, all items are closed. Here is an example:
1681 ** Lord of the Rings
1682 My favorite scenes are (in this order)
1683 1. The attack of the Rohirrim
1684 2. Eowyn's fight with the witch king
1685 + this was already my favorite scene in the book
1686 + I really like Miranda Otto.
1687 3. Peter Jackson being shot by Legolas
1689 He makes a really funny face when it happens.
1690 But in the end, no individual scenes matter but the film as a whole.
1691 Important actors in this film are:
1692 - @b{Elijah Wood} :: He plays Frodo
1693 - @b{Sean Astin} :: He plays Sam, Frodo's friend. I still remember
1694 him very well from his role as Mikey Walsh in @i{The Goonies}.
1698 Org supports these lists by tuning filling and wrapping commands to deal with
1699 them correctly, and by exporting them properly (@pxref{Exporting}). Since
1700 indentation is what governs the structure of these lists, many structural
1701 constructs like @code{#+BEGIN_...} blocks can be indented to signal that they
1702 belong to a particular item.
1704 @vindex org-list-demote-modify-bullet
1705 @vindex org-list-indent-offset
1706 If you find that using a different bullet for a sub-list (than that used for
1707 the current list-level) improves readability, customize the variable
1708 @code{org-list-demote-modify-bullet}. To get a greater difference of
1709 indentation between items and their sub-items, customize
1710 @code{org-list-indent-offset}.
1712 @vindex org-list-automatic-rules
1713 The following commands act on items when the cursor is in the first line of
1714 an item (the line with the bullet or number). Some of them imply the
1715 application of automatic rules to keep list structure intact. If some of
1716 these actions get in your way, configure @code{org-list-automatic-rules}
1717 to disable them individually.
1720 @orgcmd{@key{TAB},org-cycle}
1721 @cindex cycling, in plain lists
1722 @vindex org-cycle-include-plain-lists
1723 Items can be folded just like headline levels. Normally this works only if
1724 the cursor is on a plain list item. For more details, see the variable
1725 @code{org-cycle-include-plain-lists}. If this variable is set to
1726 @code{integrate}, plain list items will be treated like low-level
1727 headlines. The level of an item is then given by the indentation of the
1728 bullet/number. Items are always subordinate to real headlines, however; the
1729 hierarchies remain completely separated. In a new item with no text yet, the
1730 first @key{TAB} demotes the item to become a child of the previous
1731 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1732 and eventually get it back to its initial position.
1733 @orgcmd{M-@key{RET},org-insert-heading}
1734 @vindex org-M-RET-may-split-line
1735 @vindex org-list-automatic-rules
1736 Insert new item at current level. With a prefix argument, force a new
1737 heading (@pxref{Structure editing}). If this command is used in the middle
1738 of an item, that item is @emph{split} in two, and the second part becomes the
1739 new item@footnote{If you do not want the item to be split, customize the
1740 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1741 @emph{before item's body}, the new item is created @emph{before} the current
1746 @kindex M-S-@key{RET}
1748 Insert a new item with a checkbox (@pxref{Checkboxes}).
1749 @kindex S-@key{down}
1752 @cindex shift-selection-mode
1753 @vindex org-support-shift-select
1754 @vindex org-list-use-circular-motion
1755 Jump to the previous/next item in the current list@footnote{If you want to
1756 cycle around items that way, you may customize
1757 @code{org-list-use-circular-motion}.}, but only if
1758 @code{org-support-shift-select} is off. If not, you can still use paragraph
1759 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1762 @kindex M-@key{down}
1765 Move the item including subitems up/down@footnote{See
1766 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1767 previous/next item of same indentation). If the list is ordered, renumbering
1769 @kindex M-@key{left}
1770 @kindex M-@key{right}
1773 Decrease/increase the indentation of an item, leaving children alone.
1774 @kindex M-S-@key{left}
1775 @kindex M-S-@key{right}
1776 @item M-S-@key{left}
1777 @itemx M-S-@key{right}
1778 Decrease/increase the indentation of the item, including subitems.
1779 Initially, the item tree is selected based on current indentation. When
1780 these commands are executed several times in direct succession, the initially
1781 selected region is used, even if the new indentation would imply a different
1782 hierarchy. To use the new hierarchy, break the command chain with a cursor
1785 As a special case, using this command on the very first item of a list will
1786 move the whole list. This behavior can be disabled by configuring
1787 @code{org-list-automatic-rules}. The global indentation of a list has no
1788 influence on the text @emph{after} the list.
1791 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1792 state of the checkbox. In any case, verify bullets and indentation
1793 consistency in the whole list.
1795 @vindex org-plain-list-ordered-item-terminator
1797 Cycle the entire list level through the different itemize/enumerate bullets
1798 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1799 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1800 and its indentation. With a numeric prefix argument N, select the Nth bullet
1801 from this list. If there is an active region when calling this, selected
1802 text will be changed into an item. With a prefix argument, all lines will be
1803 converted to list items. If the first line already was a list item, any item
1804 marker will be removed from the list. Finally, even without an active
1805 region, a normal line will be converted into a list item.
1808 Turn a plain list item into a headline (so that it becomes a subheading at
1809 its location). @xref{Structure editing}, for a detailed explanation.
1812 Turn the whole plain list into a subtree of the current heading. Checkboxes
1813 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1815 @kindex S-@key{left}
1816 @kindex S-@key{right}
1818 @vindex org-support-shift-select
1819 This command also cycles bullet styles when the cursor in on the bullet or
1820 anywhere in an item line, details depending on
1821 @code{org-support-shift-select}.
1823 @cindex sorting, of plain list
1825 Sort the plain list. You will be prompted for the sorting method:
1826 numerically, alphabetically, by time, by checked status for check lists,
1827 or by a custom function.
1833 @cindex visibility cycling, drawers
1835 @cindex org-insert-drawer
1837 Sometimes you want to keep information associated with an entry, but you
1838 normally don't want to see it. For this, Org mode has @emph{drawers}. They
1839 can contain anything but a headline and another drawer. Drawers look like
1843 ** This is a headline
1844 Still outside the drawer
1846 This is inside the drawer.
1851 You can interactively insert drawers at point by calling
1852 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1853 region, this command will put the region inside the drawer. With a prefix
1854 argument, this command calls @code{org-insert-property-drawer} and add a
1855 property drawer right below the current headline. Completion over drawer
1856 keywords is also possible using @key{M-TAB}.
1858 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1859 show the entry, but keep the drawer collapsed to a single line. In order to
1860 look inside the drawer, you need to move the cursor to the drawer line and
1861 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1862 storing properties (@pxref{Properties and columns}), and you can also arrange
1863 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1864 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1865 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1871 Add a time-stamped note to the LOGBOOK drawer.
1874 @vindex org-export-with-drawers
1875 @vindex org-export-with-properties
1876 You can select the name of the drawers which should be exported with
1877 @code{org-export-with-drawers}. In that case, drawer contents will appear in
1878 export output. Property drawers are not affected by this variable: configure
1879 @code{org-export-with-properties} instead.
1884 @vindex org-hide-block-startup
1885 @cindex blocks, folding
1886 Org mode uses begin...end blocks for various purposes from including source
1887 code examples (@pxref{Literal examples}) to capturing time logging
1888 information (@pxref{Clocking work time}). These blocks can be folded and
1889 unfolded by pressing TAB in the begin line. You can also get all blocks
1890 folded at startup by configuring the option @code{org-hide-block-startup}
1891 or on a per-file basis by using
1893 @cindex @code{hideblocks}, STARTUP keyword
1894 @cindex @code{nohideblocks}, STARTUP keyword
1896 #+STARTUP: hideblocks
1897 #+STARTUP: nohideblocks
1904 Org mode supports the creation of footnotes.
1906 A footnote is started by a footnote marker in square brackets in column 0, no
1907 indentation allowed. It ends at the next footnote definition, headline, or
1908 after two consecutive empty lines. The footnote reference is simply the
1909 marker in square brackets, inside text. Markers always start with
1910 @code{fn:}. For example:
1913 The Org homepage[fn:1] now looks a lot better than it used to.
1915 [fn:1] The link is: http://orgmode.org
1918 Org mode extends the number-based syntax to @emph{named} footnotes and
1919 optional inline definition. Here are the valid references:
1923 A named footnote reference, where @code{name} is a unique label word, or, for
1924 simplicity of automatic creation, a number.
1925 @item [fn::This is the inline definition of this footnote]
1926 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1928 @item [fn:name:a definition]
1929 An inline definition of a footnote, which also specifies a name for the note.
1930 Since Org allows multiple references to the same note, you can then use
1931 @code{[fn:name]} to create additional references.
1934 @vindex org-footnote-auto-label
1935 Footnote labels can be created automatically, or you can create names yourself.
1936 This is handled by the variable @code{org-footnote-auto-label} and its
1937 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1940 @noindent The following command handles footnotes:
1945 The footnote action command.
1947 When the cursor is on a footnote reference, jump to the definition. When it
1948 is at a definition, jump to the (first) reference.
1950 @vindex org-footnote-define-inline
1951 @vindex org-footnote-section
1952 @vindex org-footnote-auto-adjust
1953 Otherwise, create a new footnote. Depending on the option
1954 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1955 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1956 definition will be placed right into the text as part of the reference, or
1957 separately into the location determined by the option
1958 @code{org-footnote-section}.
1960 When this command is called with a prefix argument, a menu of additional
1963 s @r{Sort the footnote definitions by reference sequence. During editing,}
1964 @r{Org makes no effort to sort footnote definitions into a particular}
1965 @r{sequence. If you want them sorted, use this command, which will}
1966 @r{also move entries according to @code{org-footnote-section}. Automatic}
1967 @r{sorting after each insertion/deletion can be configured using the}
1968 @r{option @code{org-footnote-auto-adjust}.}
1969 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1970 @r{after each insertion/deletion can be configured using the option}
1971 @r{@code{org-footnote-auto-adjust}.}
1972 S @r{Short for first @code{r}, then @code{s} action.}
1973 n @r{Normalize the footnotes by collecting all definitions (including}
1974 @r{inline definitions) into a special section, and then numbering them}
1975 @r{in sequence. The references will then also be numbers.}
1976 d @r{Delete the footnote at point, and all definitions of and references}
1979 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1980 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1981 renumbering and sorting footnotes can be automatic after each insertion or
1986 If the cursor is on a footnote reference, jump to the definition. If it is a
1987 the definition, jump back to the reference. When called at a footnote
1988 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1992 @item C-c C-o @r{or} mouse-1/2
1993 Footnote labels are also links to the corresponding definition/reference, and
1994 you can use the usual commands to follow these links.
1996 @vindex org-edit-footnote-reference
2000 Edit the footnote definition corresponding to the reference at point in
2001 a seperate window. The window can be closed by pressing @kbd{C-c '}.
2005 @node Orgstruct mode
2006 @section The Orgstruct minor mode
2007 @cindex Orgstruct mode
2008 @cindex minor mode for structure editing
2010 If you like the intuitive way the Org mode structure editing and list
2011 formatting works, you might want to use these commands in other modes like
2012 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2013 this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2014 turn it on by default, for example in Message mode, with one of:
2017 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2018 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2021 When this mode is active and the cursor is on a line that looks to Org like a
2022 headline or the first line of a list item, most structure editing commands
2023 will work, even if the same keys normally have different functionality in the
2024 major mode you are using. If the cursor is not in one of those special
2025 lines, Orgstruct mode lurks silently in the shadows.
2027 When you use @code{orgstruct++-mode}, Org will also export indentation and
2028 autofill settings into that mode, and detect item context after the first
2031 @vindex orgstruct-heading-prefix-regexp
2032 You can also use Org structure editing to fold and unfold headlines in
2033 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2034 the regular expression must match the local prefix to use before Org's
2035 headlines. For example, if you set this variable to @code{";; "} in Emacs
2036 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2037 commented lines. Some commands like @code{org-demote} are disabled when the
2038 prefix is set, but folding/unfolding will work correctly.
2044 A reference document providing a formal description of Org's syntax is
2045 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2046 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2047 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2048 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2049 file falls into one of the categories above.
2051 To explore the abstract structure of an Org buffer, run this in a buffer:
2054 M-: (org-element-parse-buffer) RET
2057 It will output a list containing the buffer's content represented as an
2058 abstract structure. The export engine relies on the information stored in
2059 this list. Most interactive commands (e.g., for structure editing) also
2060 rely on the syntactic meaning of the surrounding context.
2062 @cindex syntax checker
2064 You can check syntax in your documents using @code{org-lint} command.
2069 @cindex editing tables
2071 Org comes with a fast and intuitive table editor. Spreadsheet-like
2072 calculations are supported using the Emacs @file{calc} package
2073 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2076 * Built-in table editor:: Simple tables
2077 * Column width and alignment:: Overrule the automatic settings
2078 * Column groups:: Grouping to trigger vertical lines
2079 * Orgtbl mode:: The table editor as minor mode
2080 * The spreadsheet:: The table editor has spreadsheet capabilities
2081 * Org-Plot:: Plotting from org tables
2084 @node Built-in table editor
2085 @section The built-in table editor
2086 @cindex table editor, built-in
2088 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2089 the first non-whitespace character is considered part of a table. @samp{|}
2090 is also the column separator@footnote{To insert a vertical bar into a table
2091 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2092 might look like this:
2095 | Name | Phone | Age |
2096 |-------+-------+-----|
2097 | Peter | 1234 | 17 |
2098 | Anna | 4321 | 25 |
2101 A table is re-aligned automatically each time you press @key{TAB} or
2102 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2103 the next field (@key{RET} to the next row) and creates new table rows
2104 at the end of the table or before horizontal lines. The indentation
2105 of the table is set by the first line. Any line starting with
2106 @samp{|-} is considered as a horizontal separator line and will be
2107 expanded on the next re-align to span the whole table width. So, to
2108 create the above table, you would only type
2115 @noindent and then press @key{TAB} to align the table and start filling in
2116 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2117 @kbd{C-c @key{RET}}.
2119 @vindex org-enable-table-editor
2120 @vindex org-table-auto-blank-field
2121 When typing text into a field, Org treats @key{DEL},
2122 @key{Backspace}, and all character keys in a special way, so that
2123 inserting and deleting avoids shifting other fields. Also, when
2124 typing @emph{immediately after the cursor was moved into a new field
2125 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2126 field is automatically made blank. If this behavior is too
2127 unpredictable for you, configure the options
2128 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2131 @tsubheading{Creation and conversion}
2132 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2133 Convert the active region to a table. If every line contains at least one
2134 TAB character, the function assumes that the material is tab separated.
2135 If every line contains a comma, comma-separated values (CSV) are assumed.
2136 If not, lines are split at whitespace into fields. You can use a prefix
2137 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2138 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2139 match the separator, and a numeric argument N indicates that at least N
2140 consecutive spaces, or alternatively a TAB will be the separator.
2142 If there is no active region, this command creates an empty Org
2143 table. But it is easier just to start typing, like
2144 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2146 @tsubheading{Re-aligning and field motion}
2147 @orgcmd{C-c C-c,org-table-align}
2148 Re-align the table and don't move to another field.
2150 @orgcmd{C-c SPC,org-table-blank-field}
2151 Blank the field at point.
2153 @orgcmd{<TAB>,org-table-next-field}
2154 Re-align the table, move to the next field. Creates a new row if
2157 @orgcmd{S-@key{TAB},org-table-previous-field}
2158 Re-align, move to previous field.
2160 @orgcmd{@key{RET},org-table-next-row}
2161 Re-align the table and move down to next row. Creates a new row if
2162 necessary. At the beginning or end of a line, @key{RET} still does
2163 NEWLINE, so it can be used to split a table.
2165 @orgcmd{M-a,org-table-beginning-of-field}
2166 Move to beginning of the current table field, or on to the previous field.
2167 @orgcmd{M-e,org-table-end-of-field}
2168 Move to end of the current table field, or on to the next field.
2170 @tsubheading{Column and row editing}
2171 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2172 Move the current column left/right.
2174 @orgcmd{M-S-@key{left},org-table-delete-column}
2175 Kill the current column.
2177 @orgcmd{M-S-@key{right},org-table-insert-column}
2178 Insert a new column to the left of the cursor position.
2180 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2181 Move the current row up/down.
2183 @orgcmd{M-S-@key{up},org-table-kill-row}
2184 Kill the current row or horizontal line.
2186 @orgcmd{M-S-@key{down},org-table-insert-row}
2187 Insert a new row above the current row. With a prefix argument, the line is
2188 created below the current one.
2190 @orgcmd{C-c -,org-table-insert-hline}
2191 Insert a horizontal line below current row. With a prefix argument, the line
2192 is created above the current line.
2194 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2195 Insert a horizontal line below current row, and move the cursor into the row
2198 @orgcmd{C-c ^,org-table-sort-lines}
2199 Sort the table lines in the region. The position of point indicates the
2200 column to be used for sorting, and the range of lines is the range
2201 between the nearest horizontal separator lines, or the entire table. If
2202 point is before the first column, you will be prompted for the sorting
2203 column. If there is an active region, the mark specifies the first line
2204 and the sorting column, while point should be in the last line to be
2205 included into the sorting. The command prompts for the sorting type
2206 (alphabetically, numerically, or by time). You can sort in normal or
2207 reverse order. You can also supply your own key extraction and comparison
2208 functions. When called with a prefix argument, alphabetic sorting will be
2211 @tsubheading{Regions}
2212 @orgcmd{C-c C-x M-w,org-table-copy-region}
2213 Copy a rectangular region from a table to a special clipboard. Point and
2214 mark determine edge fields of the rectangle. If there is no active region,
2215 copy just the current field. The process ignores horizontal separator lines.
2217 @orgcmd{C-c C-x C-w,org-table-cut-region}
2218 Copy a rectangular region from a table to a special clipboard, and
2219 blank all fields in the rectangle. So this is the ``cut'' operation.
2221 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2222 Paste a rectangular region into a table.
2223 The upper left corner ends up in the current field. All involved fields
2224 will be overwritten. If the rectangle does not fit into the present table,
2225 the table is enlarged as needed. The process ignores horizontal separator
2228 @orgcmd{M-@key{RET},org-table-wrap-region}
2229 Split the current field at the cursor position and move the rest to the line
2230 below. If there is an active region, and both point and mark are in the same
2231 column, the text in the column is wrapped to minimum width for the given
2232 number of lines. A numeric prefix argument may be used to change the number
2233 of desired lines. If there is no region, but you specify a prefix argument,
2234 the current field is made blank, and the content is appended to the field
2237 @tsubheading{Calculations}
2238 @cindex formula, in tables
2239 @cindex calculations, in tables
2240 @cindex region, active
2241 @cindex active region
2242 @cindex transient mark mode
2243 @orgcmd{C-c +,org-table-sum}
2244 Sum the numbers in the current column, or in the rectangle defined by
2245 the active region. The result is shown in the echo area and can
2246 be inserted with @kbd{C-y}.
2248 @orgcmd{S-@key{RET},org-table-copy-down}
2249 @vindex org-table-copy-increment
2250 When current field is empty, copy from first non-empty field above. When not
2251 empty, copy current field down to next row and move cursor along with it.
2252 Depending on the option @code{org-table-copy-increment}, integer field
2253 values will be incremented during copy. Integers that are too large will not
2254 be incremented. Also, a @code{0} prefix argument temporarily disables the
2255 increment. This key is also used by shift-selection and related modes
2256 (@pxref{Conflicts}).
2258 @tsubheading{Miscellaneous}
2259 @orgcmd{C-c `,org-table-edit-field}
2260 Edit the current field in a separate window. This is useful for fields that
2261 are not fully visible (@pxref{Column width and alignment}). When called with
2262 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2263 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2264 window follow the cursor through the table and always show the current
2265 field. The follow mode exits automatically when the cursor leaves the table,
2266 or when you repeat this command with @kbd{C-u C-u C-c `}.
2268 @item M-x org-table-import RET
2269 Import a file as a table. The table should be TAB or whitespace
2270 separated. Use, for example, to import a spreadsheet table or data
2271 from a database, because these programs generally can write
2272 TAB-separated text files. This command works by inserting the file into
2273 the buffer and then converting the region to a table. Any prefix
2274 argument is passed on to the converter, which uses it to determine the
2276 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2277 Tables can also be imported by pasting tabular text into the Org
2278 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2279 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2281 @item M-x org-table-export RET
2282 @findex org-table-export
2283 @vindex org-table-export-default-format
2284 Export the table, by default as a TAB-separated file. Use for data
2285 exchange with, for example, spreadsheet or database programs. The format
2286 used to export the file can be configured in the option
2287 @code{org-table-export-default-format}. You may also use properties
2288 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2289 name and the format for table export in a subtree. Org supports quite
2290 general formats for exported tables. The exporter format is the same as the
2291 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2292 detailed description.
2295 If you don't like the automatic table editor because it gets in your
2296 way on lines which you would like to start with @samp{|}, you can turn
2300 (setq org-enable-table-editor nil)
2303 @noindent Then the only table command that still works is
2304 @kbd{C-c C-c} to do a manual re-align.
2306 @node Column width and alignment
2307 @section Column width and alignment
2308 @cindex narrow columns in tables
2309 @cindex alignment in tables
2311 The width of columns is automatically determined by the table editor. And
2312 also the alignment of a column is determined automatically from the fraction
2313 of number-like versus non-number fields in the column.
2315 Sometimes a single field or a few fields need to carry more text, leading to
2316 inconveniently wide columns. Or maybe you want to make a table with several
2317 columns having a fixed width, regardless of content. To set the width of
2318 a column, one field anywhere in the column may contain just the string
2319 @samp{<N>} where @samp{N} is an integer specifying the width of the column in
2320 characters. The next re-align will then set the width of this column to this
2325 |---+------------------------------| |---+--------|
2327 | 1 | one | | 1 | one |
2328 | 2 | two | ----\ | 2 | two |
2329 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2330 | 4 | four | | 4 | four |
2331 |---+------------------------------| |---+--------|
2336 Fields that are wider become clipped and end in the string @samp{=>}.
2337 Note that the full text is still in the buffer but is hidden.
2338 To see the full text, hold the mouse over the field---a tool-tip window
2339 will show the full content. To edit such a field, use the command
2340 @kbd{C-c `} (that is @kbd{C-c} followed by the grave accent). This will
2341 open a new window with the full field. Edit it and finish with @kbd{C-c
2344 @vindex org-startup-align-all-tables
2345 When visiting a file containing a table with narrowed columns, the
2346 necessary character hiding has not yet happened, and the table needs to
2347 be aligned before it looks nice. Setting the option
2348 @code{org-startup-align-all-tables} will realign all tables in a file
2349 upon visiting, but also slow down startup. You can also set this option
2350 on a per-file basis with:
2357 If you would like to overrule the automatic alignment of number-rich columns
2358 to the right and of string-rich column to the left, you can use @samp{<r>},
2359 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2360 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2361 also combine alignment and field width like this: @samp{<r10>}.
2363 Lines which only contain these formatting cookies will be removed
2364 automatically when exporting the document.
2367 @section Column groups
2368 @cindex grouping columns in tables
2370 When Org exports tables, it does so by default without vertical
2371 lines because that is visually more satisfying in general. Occasionally
2372 however, vertical lines can be useful to structure a table into groups
2373 of columns, much like horizontal lines can do for groups of rows. In
2374 order to specify column groups, you can use a special row where the
2375 first field contains only @samp{/}. The further fields can either
2376 contain @samp{<} to indicate that this column should start a group,
2377 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2378 and @samp{>}) to make a column
2379 a group of its own. Boundaries between column groups will upon export be
2380 marked with vertical lines. Here is an example:
2383 | N | N^2 | N^3 | N^4 | ~sqrt(n)~ | ~sqrt[4](N)~ |
2384 |---+-----+-----+-----+-----------+--------------|
2385 | / | < | | > | < | > |
2386 | 1 | 1 | 1 | 1 | 1 | 1 |
2387 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2388 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2389 |---+-----+-----+-----+-----------+--------------|
2390 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2393 It is also sufficient to just insert the column group starters after
2394 every vertical line you would like to have:
2397 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2398 |----+-----+-----+-----+---------+------------|
2403 @section The Orgtbl minor mode
2405 @cindex minor mode for tables
2407 If you like the intuitive way the Org table editor works, you
2408 might also want to use it in other modes like Text mode or Mail mode.
2409 The minor mode Orgtbl mode makes this possible. You can always toggle
2410 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2411 example in Message mode, use
2414 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2417 Furthermore, with some special setup, it is possible to maintain tables
2418 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2419 construct @LaTeX{} tables with the underlying ease and power of
2420 Orgtbl mode, including spreadsheet capabilities. For details, see
2421 @ref{Tables in arbitrary syntax}.
2423 @node The spreadsheet
2424 @section The spreadsheet
2425 @cindex calculations, in tables
2426 @cindex spreadsheet capabilities
2427 @cindex @file{calc} package
2429 The table editor makes use of the Emacs @file{calc} package to implement
2430 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2431 derive fields from other fields. While fully featured, Org's implementation
2432 is not identical to other spreadsheets. For example, Org knows the concept
2433 of a @emph{column formula} that will be applied to all non-header fields in a
2434 column without having to copy the formula to each relevant field. There is
2435 also a formula debugger, and a formula editor with features for highlighting
2436 fields in the table corresponding to the references at the point in the
2437 formula, moving these references by arrow keys
2440 * References:: How to refer to another field or range
2441 * Formula syntax for Calc:: Using Calc to compute stuff
2442 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2443 * Durations and time values:: How to compute durations and time values
2444 * Field and range formulas:: Formula for specific (ranges of) fields
2445 * Column formulas:: Formulas valid for an entire column
2446 * Lookup functions:: Lookup functions for searching tables
2447 * Editing and debugging formulas:: Fixing formulas
2448 * Updating the table:: Recomputing all dependent fields
2449 * Advanced features:: Field and column names, parameters and automatic recalc
2453 @subsection References
2456 To compute fields in the table from other fields, formulas must
2457 reference other fields or ranges. In Org, fields can be referenced
2458 by name, by absolute coordinates, and by relative coordinates. To find
2459 out what the coordinates of a field are, press @kbd{C-c ?} in that
2460 field, or press @kbd{C-c @}} to toggle the display of a grid.
2462 @subsubheading Field references
2463 @cindex field references
2464 @cindex references, to fields
2466 Formulas can reference the value of another field in two ways. Like in
2467 any other spreadsheet, you may reference fields with a letter/number
2468 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2469 @vindex org-table-use-standard-references
2470 However, Org prefers@footnote{Org will understand references typed by the
2471 user as @samp{B4}, but it will not use this syntax when offering a formula
2472 for editing. You can customize this behavior using the option
2473 @code{org-table-use-standard-references}.} to use another, more general
2474 representation that looks like this:
2476 @@@var{row}$@var{column}
2479 Column specifications can be absolute like @code{$1},
2480 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2481 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2482 @code{$<} and @code{$>} are immutable references to the first and last
2483 column, respectively, and you can use @code{$>>>} to indicate the third
2484 column from the right.
2486 The row specification only counts data lines and ignores horizontal separator
2487 lines (hlines). Like with columns, you can use absolute row numbers
2488 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2489 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2490 immutable references the first and last@footnote{For backward compatibility
2491 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2492 a stable way to the 5th and 12th field in the last row of the table.
2493 However, this syntax is deprecated, it should not be used for new documents.
2494 Use @code{@@>$} instead.} row in the table, respectively. You may also
2495 specify the row relative to one of the hlines: @code{@@I} refers to the first
2496 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2497 line above the current line, @code{@@+I} to the first such line below the
2498 current line. You can also write @code{@@III+2} which is the second data line
2499 after the third hline in the table.
2501 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2502 i.e., to the row/column for the field being computed. Also, if you omit
2503 either the column or the row part of the reference, the current row/column is
2506 Org's references with @emph{unsigned} numbers are fixed references
2507 in the sense that if you use the same reference in the formula for two
2508 different fields, the same field will be referenced each time.
2509 Org's references with @emph{signed} numbers are floating
2510 references because the same reference operator can reference different
2511 fields depending on the field being calculated by the formula.
2513 Here are a few examples:
2516 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2517 $5 @r{column 5 in the current row (same as @code{E&})}
2518 @@2 @r{current column, row 2}
2519 @@-1$-3 @r{the field one row up, three columns to the left}
2520 @@-I$2 @r{field just under hline above current row, column 2}
2521 @@>$5 @r{field in the last row, in column 5}
2524 @subsubheading Range references
2525 @cindex range references
2526 @cindex references, to ranges
2528 You may reference a rectangular range of fields by specifying two field
2529 references connected by two dots @samp{..}. If both fields are in the
2530 current row, you may simply use @samp{$2..$7}, but if at least one field
2531 is in a different row, you need to use the general @code{@@row$column}
2532 format at least for the first field (i.e the reference must start with
2533 @samp{@@} in order to be interpreted correctly). Examples:
2536 $1..$3 @r{first three fields in the current row}
2537 $P..$Q @r{range, using column names (see under Advanced)}
2538 $<<<..$>> @r{start in third column, continue to the last but one}
2539 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2540 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2541 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2544 @noindent Range references return a vector of values that can be fed
2545 into Calc vector functions. Empty fields in ranges are normally suppressed,
2546 so that the vector contains only the non-empty fields. For other options
2547 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2550 @subsubheading Field coordinates in formulas
2551 @cindex field coordinates
2552 @cindex coordinates, of field
2553 @cindex row, of field coordinates
2554 @cindex column, of field coordinates
2556 One of the very first actions during evaluation of Calc formulas and Lisp
2557 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2558 row or column number of the field where the current result will go to. The
2559 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2560 @code{org-table-current-column}. Examples:
2563 @item if(@@# % 2, $#, string(""))
2564 Insert column number on odd rows, set field to empty on even rows.
2565 @item $2 = '(identity remote(FOO, @@@@#$1))
2566 Copy text or values of each row of column 1 of the table named @code{FOO}
2567 into column 2 of the current table.
2568 @item @@3 = 2 * remote(FOO, @@1$$#)
2569 Insert the doubled value of each column of row 1 of the table named
2570 @code{FOO} into row 3 of the current table.
2573 @noindent For the second/third example, the table named @code{FOO} must have
2574 at least as many rows/columns as the current table. Note that this is
2575 inefficient@footnote{The computation time scales as O(N^2) because the table
2576 named @code{FOO} is parsed for each field to be read.} for large number of
2579 @subsubheading Named references
2580 @cindex named references
2581 @cindex references, named
2582 @cindex name, of column or field
2583 @cindex constants, in calculations
2586 @vindex org-table-formula-constants
2587 @samp{$name} is interpreted as the name of a column, parameter or
2588 constant. Constants are defined globally through the option
2589 @code{org-table-formula-constants}, and locally (for the file) through a
2593 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2597 @vindex constants-unit-system
2598 @pindex constants.el
2599 Also properties (@pxref{Properties and columns}) can be used as
2600 constants in table formulas: for a property @samp{:Xyz:} use the name
2601 @samp{$PROP_Xyz}, and the property will be searched in the current
2602 outline entry and in the hierarchy above it. If you have the
2603 @file{constants.el} package, it will also be used to resolve constants,
2604 including natural constants like @samp{$h} for Planck's constant, and
2605 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2606 supply the values of constants in two different unit systems, @code{SI}
2607 and @code{cgs}. Which one is used depends on the value of the variable
2608 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2609 @code{constSI} and @code{constcgs} to set this value for the current
2610 buffer.}. Column names and parameters can be specified in special table
2611 lines. These are described below, see @ref{Advanced features}. All
2612 names must start with a letter, and further consist of letters and
2615 @subsubheading Remote references
2616 @cindex remote references
2617 @cindex references, remote
2618 @cindex references, to a different table
2619 @cindex name, of column or field
2620 @cindex constants, in calculations
2621 @cindex #+NAME, for table
2623 You may also reference constants, fields and ranges from a different table,
2624 either in the current file or even in a different file. The syntax is
2627 remote(NAME-OR-ID,REF)
2631 where NAME can be the name of a table in the current file as set by a
2632 @code{#+NAME: Name} line before the table. It can also be the ID of an
2633 entry, even in a different file, and the reference then refers to the first
2634 table in that entry. REF is an absolute field or range reference as
2635 described above for example @code{@@3$3} or @code{$somename}, valid in the
2638 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2639 it will be substituted with the name or ID found in this field of the current
2640 table. For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2641 @@>$1)}. The format @code{B3} is not supported because it can not be
2642 distinguished from a plain table name or ID.
2644 @node Formula syntax for Calc
2645 @subsection Formula syntax for Calc
2646 @cindex formula syntax, Calc
2647 @cindex syntax, of formulas
2649 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2650 package. Note that @file{calc} has the non-standard convention that @samp{/}
2651 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2652 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2653 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2654 GNU Emacs Calc Manual}), variable substitution takes place according to the
2655 rules described above.
2656 @cindex vectors, in table calculations
2657 The range vectors can be directly fed into the Calc vector functions
2658 like @samp{vmean} and @samp{vsum}.
2660 @cindex format specifier
2661 @cindex mode, for @file{calc}
2662 @vindex org-calc-default-modes
2663 A formula can contain an optional mode string after a semicolon. This
2664 string consists of flags to influence Calc and other modes during
2665 execution. By default, Org uses the standard Calc modes (precision
2666 12, angular units degrees, fraction and symbolic modes off). The display
2667 format, however, has been changed to @code{(float 8)} to keep tables
2668 compact. The default settings can be configured using the option
2669 @code{org-calc-default-modes}.
2671 @noindent List of modes:
2675 Set the internal Calc calculation precision to 20 digits.
2676 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2677 Normal, scientific, engineering or fixed format of the result of Calc passed
2678 back to Org. Calc formatting is unlimited in precision as long as the Calc
2679 calculation precision is greater.
2680 @item @code{D}, @code{R}
2681 Degree and radian angle modes of Calc.
2682 @item @code{F}, @code{S}
2683 Fraction and symbolic modes of Calc.
2684 @item @code{T}, @code{t}
2685 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2687 If and how to consider empty fields. Without @samp{E} empty fields in range
2688 references are suppressed so that the Calc vector or Lisp list contains only
2689 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2690 fields in ranges or empty field references the value @samp{nan} (not a
2691 number) is used in Calc formulas and the empty string is used for Lisp
2692 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2693 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2695 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2696 to see how this is essential for computations with Lisp formulas. In Calc
2697 formulas it is used only occasionally because there number strings are
2698 already interpreted as numbers without @samp{N}.
2700 Literal, for Lisp formulas only. See the next section.
2704 Unless you use large integer numbers or high-precision-calculation and
2705 -display for floating point numbers you may alternatively provide a
2706 @samp{printf} format specifier to reformat the Calc result after it has been
2707 passed back to Org instead of letting Calc already do the
2708 formatting@footnote{The @samp{printf} reformatting is limited in precision
2709 because the value passed to it is converted into an @samp{integer} or
2710 @samp{double}. The @samp{integer} is limited in size by truncating the
2711 signed value to 32 bits. The @samp{double} is limited in precision to 64
2712 bits overall which leaves approximately 16 significant decimal digits.}. A
2716 $1+$2 @r{Sum of first and second field}
2717 $1+$2;%.2f @r{Same, format result to two decimals}
2718 exp($2)+exp($1) @r{Math functions can be used}
2719 $0;%.1f @r{Reformat current cell to 1 decimal}
2720 ($3-32)*5/9 @r{Degrees F -> C conversion}
2721 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2722 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2723 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2724 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2727 Calc also contains a complete set of logical operations, (@pxref{Logical
2728 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2731 @item if($1 < 20, teen, string(""))
2732 "teen" if age $1 is less than 20, else the Org table result field is set to
2733 empty with the empty string.
2734 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2735 Sum of the first two columns. When at least one of the input fields is empty
2736 the Org table result field is set to empty. @samp{E} is required to not
2737 convert empty fields to 0. @samp{f-1} is an optional Calc format string
2738 similar to @samp{%.1f} but leaves empty results empty.
2739 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2740 Mean value of a range unless there is any empty field. Every field in the
2741 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2742 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2743 @samp{vmean} and the Org table result field is set to empty. Use this when
2744 the sample set is expected to never have missing values.
2745 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2746 Mean value of a range with empty fields skipped. Every field in the range
2747 that is empty is skipped. When all fields in the range are empty the mean
2748 value is not defined and the Org table result field is set to empty. Use
2749 this when the sample set can have a variable size.
2750 @item vmean($1..$7); EN
2751 To complete the example before: Mean value of a range with empty fields
2752 counting as samples with value 0. Use this only when incomplete sample sets
2753 should be padded with 0 to the full size.
2756 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2757 and use them in formula syntax for Calc.
2759 @node Formula syntax for Lisp
2760 @subsection Emacs Lisp forms as formulas
2761 @cindex Lisp forms, as table formulas
2763 It is also possible to write a formula in Emacs Lisp. This can be useful
2764 for string manipulation and control structures, if Calc's functionality is
2767 If a formula starts with an apostrophe followed by an opening parenthesis,
2768 then it is evaluated as a Lisp form. The evaluation should return either a
2769 string or a number. Just as with @file{calc} formulas, you can specify modes
2770 and a printf format after a semicolon.
2772 With Emacs Lisp forms, you need to be conscious about the way field
2773 references are interpolated into the form. By default, a reference will be
2774 interpolated as a Lisp string (in double-quotes) containing the field. If
2775 you provide the @samp{N} mode switch, all referenced elements will be numbers
2776 (non-number fields will be zero) and interpolated as Lisp numbers, without
2777 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2778 literally, without quotes. I.e., if you want a reference to be interpreted
2779 as a string by the Lisp form, enclose the reference operator itself in
2780 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2781 fields, so you can embed them in list or vector syntax.
2783 Here are a few examples---note how the @samp{N} mode is used when we do
2784 computations in Lisp:
2787 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2788 Swap the first two characters of the content of column 1.
2790 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2791 @item '(apply '+ '($1..$4));N
2792 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2795 @node Durations and time values
2796 @subsection Durations and time values
2797 @cindex Duration, computing
2798 @cindex Time, computing
2799 @vindex org-table-duration-custom-format
2801 If you want to compute time values use the @code{T} flag, either in Calc
2802 formulas or Elisp formulas:
2806 | Task 1 | Task 2 | Total |
2807 |---------+----------+----------|
2808 | 2:12 | 1:47 | 03:59:00 |
2809 | 3:02:20 | -2:07:00 | 0.92 |
2810 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2814 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2815 are optional. With the @code{T} flag, computed durations will be displayed
2816 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2817 computed durations will be displayed according to the value of the option
2818 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2819 will display the result as a fraction of hours (see the second formula in the
2822 Negative duration values can be manipulated as well, and integers will be
2823 considered as seconds in addition and subtraction.
2825 @node Field and range formulas
2826 @subsection Field and range formulas
2827 @cindex field formula
2828 @cindex range formula
2829 @cindex formula, for individual table field
2830 @cindex formula, for range of fields
2832 To assign a formula to a particular field, type it directly into the field,
2833 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2834 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2835 the formula will be stored as the formula for this field, evaluated, and the
2836 current field will be replaced with the result.
2839 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2840 below the table. If you type the equation in the 4th field of the 3rd data
2841 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2842 inserting/deleting/swapping columns and rows with the appropriate commands,
2843 @i{absolute references} (but not relative ones) in stored formulas are
2844 modified in order to still reference the same field. To avoid this, in
2845 particular in range references, anchor ranges at the table borders (using
2846 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2847 @code{@@I} notation. Automatic adaptation of field references does of course
2848 not happen if you edit the table structure with normal editing
2849 commands---then you must fix the equations yourself.
2851 Instead of typing an equation into the field, you may also use the following
2855 @orgcmd{C-u C-c =,org-table-eval-formula}
2856 Install a new formula for the current field. The command prompts for a
2857 formula with default taken from the @samp{#+TBLFM:} line, applies
2858 it to the current field, and stores it.
2861 The left-hand side of a formula can also be a special expression in order to
2862 assign the formula to a number of different fields. There is no keyboard
2863 shortcut to enter such range formulas. To add them, use the formula editor
2864 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2869 Column formula, valid for the entire column. This is so common that Org
2870 treats these formulas in a special way, see @ref{Column formulas}.
2872 Row formula, applies to all fields in the specified row. @code{@@>=} means
2875 Range formula, applies to all fields in the given rectangular range. This
2876 can also be used to assign a formula to some but not all fields in a row.
2878 Named field, see @ref{Advanced features}.
2881 @node Column formulas
2882 @subsection Column formulas
2883 @cindex column formula
2884 @cindex formula, for table column
2886 When you assign a formula to a simple column reference like @code{$3=}, the
2887 same formula will be used in all fields of that column, with the following
2888 very convenient exceptions: (i) If the table contains horizontal separator
2889 hlines with rows above and below, everything before the first such hline is
2890 considered part of the table @emph{header} and will not be modified by column
2891 formulas. Therefore a header is mandatory when you use column formulas and
2892 want to add hlines to group rows, like for example to separate a total row at
2893 the bottom from the summand rows above. (ii) Fields that already get a value
2894 from a field/range formula will be left alone by column formulas. These
2895 conditions make column formulas very easy to use.
2897 To assign a formula to a column, type it directly into any field in the
2898 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2899 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2900 the formula will be stored as the formula for the current column, evaluated
2901 and the current field replaced with the result. If the field contains only
2902 @samp{=}, the previously stored formula for this column is used. For each
2903 column, Org will only remember the most recently used formula. In the
2904 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2905 left-hand side of a column formula cannot be the name of column, it must be
2906 the numeric column reference or @code{$>}.
2908 Instead of typing an equation into the field, you may also use the
2912 @orgcmd{C-c =,org-table-eval-formula}
2913 Install a new formula for the current column and replace current field with
2914 the result of the formula. The command prompts for a formula, with default
2915 taken from the @samp{#+TBLFM} line, applies it to the current field and
2916 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2917 will apply it to that many consecutive fields in the current column.
2920 @node Lookup functions
2921 @subsection Lookup functions
2922 @cindex lookup functions in tables
2923 @cindex table lookup functions
2925 Org has three predefined Emacs Lisp functions for lookups in tables.
2927 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2928 @findex org-lookup-first
2929 Searches for the first element @code{S} in list @code{S-LIST} for which
2933 is @code{t}; returns the value from the corresponding position in list
2934 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2935 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2936 order as the corresponding parameters are in the call to
2937 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2938 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2940 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2941 @findex org-lookup-last
2942 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2943 element for which @code{PREDICATE} is @code{t}.
2944 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2945 @findex org-lookup-all
2946 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2947 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2948 values. This function can not be used by itself in a formula, because it
2949 returns a list of values. However, powerful lookups can be built when this
2950 function is combined with other Emacs Lisp functions.
2953 If the ranges used in these functions contain empty fields, the @code{E} mode
2954 for the formula should usually be specified: otherwise empty fields will not be
2955 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2956 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2957 element of @code{R-LIST}.
2959 These three functions can be used to implement associative arrays, count
2960 matching cells, rank results, group data etc. For practical examples
2961 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2964 @node Editing and debugging formulas
2965 @subsection Editing and debugging formulas
2966 @cindex formula editing
2967 @cindex editing, of table formulas
2969 @vindex org-table-use-standard-references
2970 You can edit individual formulas in the minibuffer or directly in the field.
2971 Org can also prepare a special buffer with all active formulas of a table.
2972 When offering a formula for editing, Org converts references to the standard
2973 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2974 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2975 option @code{org-table-use-standard-references}.
2978 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2979 Edit the formula associated with the current column/field in the
2980 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2981 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2982 Re-insert the active formula (either a
2983 field formula, or a column formula) into the current field, so that you
2984 can edit it directly in the field. The advantage over editing in the
2985 minibuffer is that you can use the command @kbd{C-c ?}.
2986 @orgcmd{C-c ?,org-table-field-info}
2987 While editing a formula in a table field, highlight the field(s)
2988 referenced by the reference at the cursor position in the formula.
2990 @findex org-table-toggle-coordinate-overlays
2992 Toggle the display of row and column numbers for a table, using overlays
2993 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2994 time the table is aligned; you can force it with @kbd{C-c C-c}.
2996 @findex org-table-toggle-formula-debugger
2998 Toggle the formula debugger on and off
2999 (@command{org-table-toggle-formula-debugger}). See below.
3000 @orgcmd{C-c ',org-table-edit-formulas}
3001 Edit all formulas for the current table in a special buffer, where the
3002 formulas will be displayed one per line. If the current field has an
3003 active formula, the cursor in the formula editor will mark it.
3004 While inside the special buffer, Org will automatically highlight
3005 any field or range reference at the cursor position. You may edit,
3006 remove and add formulas, and use the following commands:
3009 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3010 Exit the formula editor and store the modified formulas. With @kbd{C-u}
3011 prefix, also apply the new formulas to the entire table.
3012 @orgcmd{C-c C-q,org-table-fedit-abort}
3013 Exit the formula editor without installing changes.
3014 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3015 Toggle all references in the formula editor between standard (like
3016 @code{B3}) and internal (like @code{@@3$2}).
3017 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3018 Pretty-print or indent Lisp formula at point. When in a line containing
3019 a Lisp formula, format the formula according to Emacs Lisp rules.
3020 Another @key{TAB} collapses the formula back again. In the open
3021 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3022 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3023 Complete Lisp symbols, just like in Emacs Lisp mode.
3025 @kindex S-@key{down}
3026 @kindex S-@key{left}
3027 @kindex S-@key{right}
3028 @findex org-table-fedit-ref-up
3029 @findex org-table-fedit-ref-down
3030 @findex org-table-fedit-ref-left
3031 @findex org-table-fedit-ref-right
3032 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3033 Shift the reference at point. For example, if the reference is
3034 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3035 This also works for relative references and for hline references.
3036 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3037 Move the test line for column formulas in the Org buffer up and
3039 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3040 Scroll the window displaying the table.
3042 @findex org-table-toggle-coordinate-overlays
3044 Turn the coordinate grid in the table on and off.
3048 Making a table field blank does not remove the formula associated with
3049 the field, because that is stored in a different line (the @samp{#+TBLFM}
3050 line)---during the next recalculation the field will be filled again.
3051 To remove a formula from a field, you have to give an empty reply when
3052 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3055 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3056 equations with @kbd{C-c C-c} in that line or with the normal
3057 recalculation commands in the table.
3059 @anchor{Using multiple #+TBLFM lines}
3060 @subsubheading Using multiple #+TBLFM lines
3061 @cindex #+TBLFM line, multiple
3063 @cindex #+TBLFM, switching
3066 You may apply the formula temporarily. This is useful when you
3067 switch the formula. Place multiple @samp{#+TBLFM} lines right
3068 after the table, and then press @kbd{C-c C-c} on the formula to
3069 apply. Here is an example:
3081 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3093 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3094 will get the following result of applying only the first @samp{#+TBLFM} line.
3105 @subsubheading Debugging formulas
3106 @cindex formula debugging
3107 @cindex debugging, of table formulas
3108 When the evaluation of a formula leads to an error, the field content
3109 becomes the string @samp{#ERROR}. If you would like see what is going
3110 on during variable substitution and calculation in order to find a bug,
3111 turn on formula debugging in the @code{Tbl} menu and repeat the
3112 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3113 field. Detailed information will be displayed.
3115 @node Updating the table
3116 @subsection Updating the table
3117 @cindex recomputing table fields
3118 @cindex updating, table
3120 Recalculation of a table is normally not automatic, but needs to be
3121 triggered by a command. See @ref{Advanced features}, for a way to make
3122 recalculation at least semi-automatic.
3124 In order to recalculate a line of a table or the entire table, use the
3128 @orgcmd{C-c *,org-table-recalculate}
3129 Recalculate the current row by first applying the stored column formulas
3130 from left to right, and all field/range formulas in the current row.
3136 Recompute the entire table, line by line. Any lines before the first
3137 hline are left alone, assuming that these are part of the table header.
3139 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3140 Iterate the table by recomputing it until no further changes occur.
3141 This may be necessary if some computed fields use the value of other
3142 fields that are computed @i{later} in the calculation sequence.
3143 @item M-x org-table-recalculate-buffer-tables RET
3144 @findex org-table-recalculate-buffer-tables
3145 Recompute all tables in the current buffer.
3146 @item M-x org-table-iterate-buffer-tables RET
3147 @findex org-table-iterate-buffer-tables
3148 Iterate all tables in the current buffer, in order to converge table-to-table
3152 @node Advanced features
3153 @subsection Advanced features
3155 If you want the recalculation of fields to happen automatically, or if you
3156 want to be able to assign @i{names}@footnote{Such names must start by an
3157 alphabetic character and use only alphanumeric/underscore characters.} to
3158 fields and columns, you need to reserve the first column of the table for
3159 special marking characters.
3162 @orgcmd{C-#,org-table-rotate-recalc-marks}
3163 Rotate the calculation mark in first column through the states @samp{ },
3164 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3165 change all marks in the region.
3168 Here is an example of a table that collects exam results of students and
3169 makes use of these features:
3173 |---+---------+--------+--------+--------+-------+------|
3174 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3175 |---+---------+--------+--------+--------+-------+------|
3176 | ! | | P1 | P2 | P3 | Tot | |
3177 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3178 | ^ | | m1 | m2 | m3 | mt | |
3179 |---+---------+--------+--------+--------+-------+------|
3180 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3181 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3182 |---+---------+--------+--------+--------+-------+------|
3183 | | Average | | | | 25.0 | |
3184 | ^ | | | | | at | |
3185 | $ | max=50 | | | | | |
3186 |---+---------+--------+--------+--------+-------+------|
3187 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3191 @noindent @b{Important}: please note that for these special tables,
3192 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3193 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3194 to the field itself. The column formulas are not applied in rows with
3197 @cindex marking characters, tables
3198 The marking characters have the following meaning:
3202 The fields in this line define names for the columns, so that you may
3203 refer to a column as @samp{$Tot} instead of @samp{$6}.
3205 This row defines names for the fields @emph{above} the row. With such
3206 a definition, any formula in the table may use @samp{$m1} to refer to
3207 the value @samp{10}. Also, if you assign a formula to a names field, it
3208 will be stored as @samp{$name=...}.
3210 Similar to @samp{^}, but defines names for the fields in the row
3213 Fields in this row can define @emph{parameters} for formulas. For
3214 example, if a field in a @samp{$} row contains @samp{max=50}, then
3215 formulas in this table can refer to the value 50 using @samp{$max}.
3216 Parameters work exactly like constants, only that they can be defined on
3219 Fields in this row are automatically recalculated when pressing
3220 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3221 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3222 lines will be left alone by this command.
3224 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3225 not for automatic recalculation. Use this when automatic
3226 recalculation slows down editing too much.
3228 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3229 All lines that should be recalculated should be marked with @samp{#}
3232 Do not export this line. Useful for lines that contain the narrowing
3233 @samp{<N>} markers or column group markers.
3236 Finally, just to whet your appetite for what can be done with the
3237 fantastic @file{calc.el} package, here is a table that computes the Taylor
3238 series of degree @code{n} at location @code{x} for a couple of
3243 |---+-------------+---+-----+--------------------------------------|
3244 | | Func | n | x | Result |
3245 |---+-------------+---+-----+--------------------------------------|
3246 | # | exp(x) | 1 | x | 1 + x |
3247 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3248 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3249 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3250 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3251 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3252 |---+-------------+---+-----+--------------------------------------|
3253 #+TBLFM: $5=taylor($2,$4,$3);n3
3259 @cindex graph, in tables
3260 @cindex plot tables using Gnuplot
3263 Org-Plot can produce graphs of information stored in org tables, either
3264 graphically or in ASCII-art.
3266 @subheading Graphical plots using @file{Gnuplot}
3268 Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
3269 @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3270 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3271 that you have both Gnuplot and Gnuplot mode installed on your system, then
3272 call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
3277 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3278 | Sede | Max cites | H-index |
3279 |-----------+-----------+---------|
3280 | Chile | 257.72 | 21.39 |
3281 | Leeds | 165.77 | 19.68 |
3282 | Sao Paolo | 71.00 | 11.50 |
3283 | Stockholm | 134.19 | 14.33 |
3284 | Morelia | 257.56 | 17.67 |
3288 Notice that Org Plot is smart enough to apply the table's headers as labels.
3289 Further control over the labels, type, content, and appearance of plots can
3290 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3291 for a complete list of Org-plot options. The @code{#+PLOT:} lines are
3292 optional. For more information and examples see the Org-plot tutorial at
3293 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3295 @subsubheading Plot Options
3299 Specify any @command{gnuplot} option to be set when graphing.
3302 Specify the title of the plot.
3305 Specify which column of the table to use as the @code{x} axis.
3308 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3309 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3310 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3314 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3317 Specify a @code{with} option to be inserted for every col being plotted
3318 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3319 Defaults to @code{lines}.
3322 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3325 List of labels to be used for the @code{deps} (defaults to the column headers
3329 Specify an entire line to be inserted in the Gnuplot script.
3332 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3333 flat mapping rather than a @code{3d} slope.
3336 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3337 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3340 If you want total control, you can specify a script file (place the file name
3341 between double-quotes) which will be used to plot. Before plotting, every
3342 instance of @code{$datafile} in the specified script will be replaced with
3343 the path to the generated data file. Note: even if you set this option, you
3344 may still want to specify the plot type, as that can impact the content of
3348 @subheading ASCII bar plots
3350 While the cursor is on a column, typing @kbd{C-c " a} or
3351 @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
3352 ASCII-art bars plot. The plot is implemented through a regular column
3353 formula. When the source column changes, the bar plot may be updated by
3354 refreshing the table, for example typing @kbd{C-u C-c *}.
3358 | Sede | Max cites | |
3359 |---------------+-----------+--------------|
3360 | Chile | 257.72 | WWWWWWWWWWWW |
3361 | Leeds | 165.77 | WWWWWWWh |
3362 | Sao Paolo | 71.00 | WWW; |
3363 | Stockholm | 134.19 | WWWWWW: |
3364 | Morelia | 257.56 | WWWWWWWWWWWH |
3365 | Rochefourchat | 0.00 | |
3366 #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3370 The formula is an elisp call:
3372 (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
3377 is a reference to the source column.
3380 are the minimal and maximal values displayed. Sources values
3381 outside this range are displayed as @samp{too small}
3382 or @samp{too large}.
3385 is the width in characters of the bar-plot. It defaults to @samp{12}.
3393 Like HTML, Org provides links inside a file, external links to
3394 other files, Usenet articles, emails, and much more.
3397 * Link format:: How links in Org are formatted
3398 * Internal links:: Links to other places in the current file
3399 * External links:: URL-like links to the world
3400 * Handling links:: Creating, inserting and following
3401 * Using links outside Org:: Linking from my C source code?
3402 * Link abbreviations:: Shortcuts for writing complex links
3403 * Search options:: Linking to a specific location
3404 * Custom searches:: When the default search is not enough
3408 @section Link format
3410 @cindex format, of links
3412 Org will recognize plain URL-like links and activate them as
3413 clickable links. The general link format, however, looks like this:
3416 [[link][description]] @r{or alternatively} [[link]]
3420 Once a link in the buffer is complete (all brackets present), Org
3421 will change the display so that @samp{description} is displayed instead
3422 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3423 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3424 which by default is an underlined face. You can directly edit the
3425 visible part of a link. Note that this can be either the @samp{link}
3426 part (if there is no description) or the @samp{description} part. To
3427 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3430 If you place the cursor at the beginning or just behind the end of the
3431 displayed text and press @key{BACKSPACE}, you will remove the
3432 (invisible) bracket at that location. This makes the link incomplete
3433 and the internals are again displayed as plain text. Inserting the
3434 missing bracket hides the link internals again. To show the
3435 internal structure of all links, use the menu entry
3436 @code{Org->Hyperlinks->Literal links}.
3438 @node Internal links
3439 @section Internal links
3440 @cindex internal links
3441 @cindex links, internal
3442 @cindex targets, for links
3444 @cindex property, CUSTOM_ID
3445 If the link does not look like a URL, it is considered to be internal in the
3446 current file. The most important case is a link like
3447 @samp{[[#my-custom-id]]} which will link to the entry with the
3448 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3449 to make sure these custom IDs are unique in a file.
3451 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3452 lead to a text search in the current file.
3454 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3455 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3456 point to the corresponding headline. The preferred match for a text link is
3457 a @i{dedicated target}: the same string in double angular brackets, like
3458 @samp{<<My Target>>}.
3461 If no dedicated target exists, the link will then try to match the exact name
3462 of an element within the buffer. Naming is done with the @code{#+NAME}
3463 keyword, which has to be put in the line before the element it refers to, as
3464 in the following example
3473 If none of the above succeeds, Org will search for a headline that is exactly
3474 the link text but may also include a TODO keyword and tags@footnote{To insert
3475 a link targeting a headline, in-buffer completion can be used. Just type
3476 a star followed by a few optional letters into the buffer and press
3477 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3480 During export, internal links will be used to mark objects and assign them
3481 a number. Marked objects will then be referenced by links pointing to them.
3482 In particular, links without a description will appear as the number assigned
3483 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3484 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3485 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3489 - <<target>>another item
3490 Here we refer to item [[target]].
3494 The last sentence will appear as @samp{Here we refer to item 2} when
3497 In non-Org files, the search will look for the words in the link text. In
3498 the above example the search would be for @samp{my target}.
3500 Following a link pushes a mark onto Org's own mark ring. You can
3501 return to the previous position with @kbd{C-c &}. Using this command
3502 several times in direct succession goes back to positions recorded
3506 * Radio targets:: Make targets trigger links in plain text
3510 @subsection Radio targets
3511 @cindex radio targets
3512 @cindex targets, radio
3513 @cindex links, radio targets
3515 Org can automatically turn any occurrences of certain target names
3516 in normal text into a link. So without explicitly creating a link, the
3517 text connects to the target radioing its position. Radio targets are
3518 enclosed by triple angular brackets. For example, a target @samp{<<<My
3519 Target>>>} causes each occurrence of @samp{my target} in normal text to
3520 become activated as a link. The Org file is scanned automatically
3521 for radio targets only when the file is first loaded into Emacs. To
3522 update the target list during editing, press @kbd{C-c C-c} with the
3523 cursor on or at a target.
3525 @node External links
3526 @section External links
3527 @cindex links, external
3528 @cindex external links
3536 @cindex USENET links
3541 Org supports links to files, websites, Usenet and email messages, BBDB
3542 database entries and links to both IRC conversations and their logs.
3543 External links are URL-like locators. They start with a short identifying
3544 string followed by a colon. There can be no space after the colon. The
3545 following list shows examples for each link type.
3548 http://www.astro.uva.nl/~dominik @r{on the web}
3549 doi:10.1000/182 @r{DOI for an electronic resource}
3550 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3551 /home/dominik/images/jupiter.jpg @r{same as above}
3552 file:papers/last.pdf @r{file, relative path}
3553 ./papers/last.pdf @r{same as above}
3554 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3555 /myself@@some.where:papers/last.pdf @r{same as above}
3556 file:sometextfile::NNN @r{file, jump to line number}
3557 file:projects.org @r{another Org file}
3558 file:projects.org::some words @r{text search in Org file}@footnote{
3559 The actual behavior of the search will depend on the value of
3560 the option @code{org-link-search-must-match-exact-headline}. If its value
3561 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3562 exact headline will be matched, ignoring spaces and cookies. If the value is
3563 @code{query-to-create}, then an exact headline will be searched; if it is not
3564 found, then the user will be queried to create it.}
3565 file:projects.org::*task title @r{heading search in Org
3566 file}@footnote{ Headline searches always match the exact headline, ignoring
3567 spaces and cookies. If the headline is not found and the value of the option
3568 @code{org-link-search-must-match-exact-headline} is @code{query-to-create},
3569 then the user will be queried to create it.}
3570 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3571 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3572 news:comp.emacs @r{Usenet link}
3573 mailto:adent@@galaxy.net @r{Mail link}
3574 mhe:folder @r{MH-E folder link}
3575 mhe:folder#id @r{MH-E message link}
3576 rmail:folder @r{RMAIL folder link}
3577 rmail:folder#id @r{RMAIL message link}
3578 gnus:group @r{Gnus group link}
3579 gnus:group#id @r{Gnus article link}
3580 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3581 irc:/irc.com/#emacs/bob @r{IRC link}
3582 info:org#External links @r{Info node or index link}
3583 shell:ls *.org @r{A shell command}
3584 elisp:org-agenda @r{Interactive Elisp command}
3585 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3589 @cindex WANDERLUST links
3590 On top of these built-in link types, some are available through the
3591 @code{contrib/} directory (@pxref{Installation}). For example, these links
3592 to VM or Wanderlust messages are available when you load the corresponding
3593 libraries from the @code{contrib/} directory:
3596 vm:folder @r{VM folder link}
3597 vm:folder#id @r{VM message link}
3598 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3599 vm-imap:account:folder @r{VM IMAP folder link}
3600 vm-imap:account:folder#id @r{VM IMAP message link}
3601 wl:folder @r{WANDERLUST folder link}
3602 wl:folder#id @r{WANDERLUST message link}
3605 For customizing Org to add new link types @ref{Adding hyperlink types}.
3607 A link should be enclosed in double brackets and may contain a descriptive
3608 text to be displayed instead of the URL (@pxref{Link format}), for example:
3611 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3615 If the description is a file name or URL that points to an image, HTML
3616 export (@pxref{HTML export}) will inline the image as a clickable
3617 button. If there is no description at all and the link points to an
3619 that image will be inlined into the exported HTML file.
3621 @cindex square brackets, around links
3622 @cindex plain text external links
3623 Org also finds external links in the normal text and activates them
3624 as links. If spaces must be part of the link (for example in
3625 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3626 about the end of the link, enclose them in square brackets.
3628 @node Handling links
3629 @section Handling links
3630 @cindex links, handling
3632 Org provides methods to create a link in the correct syntax, to
3633 insert it into an Org file, and to follow the link.
3636 @orgcmd{C-c l,org-store-link}
3637 @cindex storing links
3638 Store a link to the current location. This is a @emph{global} command (you
3639 must create the key binding yourself) which can be used in any buffer to
3640 create a link. The link will be stored for later insertion into an Org
3641 buffer (see below). What kind of link will be created depends on the current
3644 @b{Org mode buffers}@*
3645 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3646 to the target. Otherwise it points to the current headline, which will also
3647 be the description@footnote{If the headline contains a timestamp, it will be
3648 removed from the link and result in a wrong link---you should avoid putting
3649 timestamp in the headline.}.
3651 @vindex org-id-link-to-org-use-id
3652 @cindex property, CUSTOM_ID
3653 @cindex property, ID
3654 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3655 will be stored. In addition or alternatively (depending on the value of
3656 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3657 be created and/or used to construct a link@footnote{The library
3658 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3659 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3660 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3661 potentially create two links: a human-readable from the custom ID, and one
3662 that is globally unique and works even if the entry is moved from file to
3663 file. Later, when inserting the link, you need to decide which one to use.
3665 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3666 Pretty much all Emacs mail clients are supported. The link will point to the
3667 current article, or, in some GNUS buffers, to the group. The description is
3668 constructed from the author and the subject.
3670 @b{Web browsers: Eww, W3 and W3M}@*
3671 Here the link will be the current URL, with the page title as description.
3673 @b{Contacts: BBDB}@*
3674 Links created in a BBDB buffer will point to the current entry.
3677 @vindex org-irc-link-to-logs
3678 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3679 a @samp{file:/} style link to the relevant point in the logs for the current
3680 conversation is created. Otherwise an @samp{irc:/} style link to the
3681 user/channel/server under the point will be stored.
3684 For any other files, the link will point to the file, with a search string
3685 (@pxref{Search options}) pointing to the contents of the current line. If
3686 there is an active region, the selected words will form the basis of the
3687 search string. If the automatically created link is not working correctly or
3688 accurately enough, you can write custom functions to select the search string
3689 and to do the search for particular file types---see @ref{Custom searches}.
3690 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3693 When the cursor is in an agenda view, the created link points to the
3694 entry referenced by the current line.
3697 @orgcmd{C-c C-l,org-insert-link}
3698 @cindex link completion
3699 @cindex completion, of links
3700 @cindex inserting links
3701 @vindex org-keep-stored-link-after-insertion
3702 @vindex org-link-parameters
3703 Insert a link@footnote{Note that you don't have to use this command to
3704 insert a link. Links in Org are plain text, and you can type or paste them
3705 straight into the buffer. By using this command, the links are automatically
3706 enclosed in double brackets, and you will be asked for the optional
3707 descriptive text.}. This prompts for a link to be inserted into the buffer.
3708 You can just type a link, using text for an internal link, or one of the link
3709 type prefixes mentioned in the examples above. The link will be inserted
3710 into the buffer@footnote{After insertion of a stored link, the link will be
3711 removed from the list of stored links. To keep it in the list later use, use
3712 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3713 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3714 If some text was selected when this command is called, the selected text
3715 becomes the default description.
3717 @b{Inserting stored links}@*
3718 All links stored during the
3719 current session are part of the history for this prompt, so you can access
3720 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3722 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3723 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3724 defined through link abbreviations (@pxref{Link abbreviations}). If you
3725 press @key{RET} after inserting only the @var{prefix}, Org will offer
3726 specific completion support for some link types@footnote{This works if
3727 a completion function is defined in the @samp{:complete} property of a link
3728 in @code{org-link-parameters}.} For example, if you type @kbd{file
3729 @key{RET}}, file name completion (alternative access: @kbd{C-u C-c C-l}, see
3730 below) will be offered, and after @kbd{bbdb @key{RET}} you can complete
3733 @cindex file name completion
3734 @cindex completion, of file names
3735 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3736 a file will be inserted and you may use file name completion to select
3737 the name of the file. The path to the file is inserted relative to the
3738 directory of the current Org file, if the linked file is in the current
3739 directory or in a sub-directory of it, or if the path is written relative
3740 to the current directory using @samp{../}. Otherwise an absolute path
3741 is used, if possible with @samp{~/} for your home directory. You can
3742 force an absolute path with two @kbd{C-u} prefixes.
3744 @item C-c C-l @ @r{(with cursor on existing link)}
3745 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3746 link and description parts of the link.
3748 @cindex following links
3749 @orgcmd{C-c C-o,org-open-at-point}
3750 @vindex org-file-apps
3751 @vindex org-link-frame-setup
3752 Open link at point. This will launch a web browser for URLs (using
3753 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3754 the corresponding links, and execute the command in a shell link. When the
3755 cursor is on an internal link, this command runs the corresponding search.
3756 When the cursor is on a TAG list in a headline, it creates the corresponding
3757 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3758 date. Furthermore, it will visit text and remote files in @samp{file:} links
3759 with Emacs and select a suitable application for local non-text files.
3760 Classification of files is based on file extension only. See option
3761 @code{org-file-apps}. If you want to override the default application and
3762 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3763 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3764 If the cursor is on a headline, but not on a link, offer all links in the
3765 headline and entry text. If you want to setup the frame configuration for
3766 following links, customize @code{org-link-frame-setup}.
3769 @vindex org-return-follows-link
3770 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3777 On links, @kbd{mouse-1} and @kbd{mouse-2} will open the link just as @kbd{C-c
3782 @vindex org-display-internal-link-with-indirect-buffer
3783 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3784 internal links to be displayed in another window@footnote{See the
3785 option @code{org-display-internal-link-with-indirect-buffer}}.
3787 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3788 @cindex inlining images
3789 @cindex images, inlining
3790 @vindex org-startup-with-inline-images
3791 @cindex @code{inlineimages}, STARTUP keyword
3792 @cindex @code{noinlineimages}, STARTUP keyword
3793 Toggle the inline display of linked images. Normally this will only inline
3794 images that have no description part in the link, i.e., images that will also
3795 be inlined during export. When called with a prefix argument, also display
3796 images that do have a link description. You can ask for inline images to be
3797 displayed at startup by configuring the variable
3798 @code{org-startup-with-inline-images}@footnote{with corresponding
3799 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3800 @orgcmd{C-c %,org-mark-ring-push}
3802 Push the current position onto the mark ring, to be able to return
3803 easily. Commands following an internal link do this automatically.
3805 @orgcmd{C-c &,org-mark-ring-goto}
3806 @cindex links, returning to
3807 Jump back to a recorded position. A position is recorded by the
3808 commands following internal links, and by @kbd{C-c %}. Using this
3809 command several times in direct succession moves through a ring of
3810 previously recorded positions.
3812 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3813 @cindex links, finding next/previous
3814 Move forward/backward to the next link in the buffer. At the limit of
3815 the buffer, the search fails once, and then wraps around. The key
3816 bindings for this are really too long; you might want to bind this also
3817 to @kbd{C-n} and @kbd{C-p}
3819 (add-hook 'org-load-hook
3821 (define-key org-mode-map "\C-n" 'org-next-link)
3822 (define-key org-mode-map "\C-p" 'org-previous-link)))
3826 @node Using links outside Org
3827 @section Using links outside Org
3829 You can insert and follow links that have Org syntax not only in
3830 Org, but in any Emacs buffer. For this, you should create two
3831 global commands, like this (please select suitable global keys
3835 (global-set-key "\C-c L" 'org-insert-link-global)
3836 (global-set-key "\C-c o" 'org-open-at-point-global)
3839 @node Link abbreviations
3840 @section Link abbreviations
3841 @cindex link abbreviations
3842 @cindex abbreviation, links
3844 Long URLs can be cumbersome to type, and often many similar links are
3845 needed in a document. For this you can use link abbreviations. An
3846 abbreviated link looks like this
3849 [[linkword:tag][description]]
3853 @vindex org-link-abbrev-alist
3854 where the tag is optional.
3855 The @i{linkword} must be a word, starting with a letter, followed by
3856 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3857 according to the information in the variable @code{org-link-abbrev-alist}
3858 that relates the linkwords to replacement text. Here is an example:
3862 (setq org-link-abbrev-alist
3863 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3864 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3865 ("google" . "http://www.google.com/search?q=")
3866 ("gmap" . "http://maps.google.com/maps?q=%s")
3867 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3868 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3872 If the replacement text contains the string @samp{%s}, it will be
3873 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3874 url-encode the tag (see the example above, where we need to encode
3875 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3876 to a custom function, and replace it by the resulting string.
3878 If the replacement text doesn't contain any specifier, it will simply
3879 be appended to the string in order to create the link.
3881 Instead of a string, you may also specify a function that will be
3882 called with the tag as the only argument to create the link.
3884 With the above setting, you could link to a specific bug with
3885 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3886 @code{[[google:OrgMode]]}, show the map location of the Free Software
3887 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3888 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3889 what the Org author is doing besides Emacs hacking with
3890 @code{[[ads:Dominik,C]]}.
3892 If you need special abbreviations just for a single Org buffer, you
3893 can define them in the file with
3897 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3898 #+LINK: google http://www.google.com/search?q=%s
3902 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3903 complete link abbreviations. You may also define a function that implements
3904 special (e.g., completion) support for inserting such a link with @kbd{C-c
3905 C-l}. Such a function should not accept any arguments, and return the full
3906 link with prefix. You can add a completion function to a link like this:
3909 (org-link-set-parameters ``type'' :complete #'some-function)
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 Empty kitchen trash
6434 DEADLINE: <2008-02-08 Fri 20:00 ++1d>
6435 Marking this DONE will shift the date by at least one day, and
6436 also by as many days as it takes to get the timestamp into the
6437 future. Since there is a time in the timestamp, the next
6438 deadline in the future will be on today's date if you
6439 complete the task before 20:00.
6440 ** TODO Check the batteries in the smoke detectors
6441 DEADLINE: <2005-11-01 Tue .+1m>
6442 Marking this DONE will shift the date to one month after
6446 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6447 You may have both scheduling and deadline information for a specific task.
6448 If the repeater is set for the scheduling information only, you probably want
6449 the repeater to be ignored after the deadline. If so, set the variable
6450 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6451 @code{repeated-after-deadline}. However, any scheduling information without
6452 a repeater is no longer relevant once the task is done, and thus, removed
6453 upon repeating the task. If you want both scheduling and deadline
6454 information to repeat after the same interval, set the same repeater for both
6457 An alternative to using a repeater is to create a number of copies of a task
6458 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6459 created for this purpose, it is described in @ref{Structure editing}.
6462 @node Clocking work time
6463 @section Clocking work time
6464 @cindex clocking time
6465 @cindex time clocking
6467 Org mode allows you to clock the time you spend on specific tasks in a
6468 project. When you start working on an item, you can start the clock. When
6469 you stop working on that task, or when you mark the task done, the clock is
6470 stopped and the corresponding time interval is recorded. It also computes
6471 the total time spent on each subtree@footnote{Clocking only works if all
6472 headings are indented with less than 30 stars. This is a hardcoded
6473 limitation of @code{lmax} in @code{org-clock-sum}.} of a project.
6474 And it remembers a history or tasks recently clocked, so that you can jump
6475 quickly between a number of tasks absorbing your time.
6477 To save the clock history across Emacs sessions, use
6479 (setq org-clock-persist 'history)
6480 (org-clock-persistence-insinuate)
6482 When you clock into a new task after resuming Emacs, the incomplete
6483 clock@footnote{To resume the clock under the assumption that you have worked
6484 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6485 will be found (@pxref{Resolving idle time}) and you will be prompted about
6489 * Clocking commands:: Starting and stopping a clock
6490 * The clock table:: Detailed reports
6491 * Resolving idle time:: Resolving time when you've been idle
6494 @node Clocking commands
6495 @subsection Clocking commands
6498 @orgcmd{C-c C-x C-i,org-clock-in}
6499 @vindex org-clock-into-drawer
6500 @vindex org-clock-continuously
6501 @cindex property, LOG_INTO_DRAWER
6502 Start the clock on the current item (clock-in). This inserts the CLOCK
6503 keyword together with a timestamp. If this is not the first clocking of
6504 this item, the multiple CLOCK lines will be wrapped into a
6505 @code{:LOGBOOK:} drawer (see also the variable
6506 @code{org-clock-into-drawer}). You can also overrule
6507 the setting of this variable for a subtree by setting a
6508 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6509 When called with a @kbd{C-u} prefix argument,
6510 select the task from a list of recently clocked tasks. With two @kbd{C-u
6511 C-u} prefixes, clock into the task at point and mark it as the default task;
6512 the default task will then always be available with letter @kbd{d} when
6513 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6514 continuous clocking by starting the clock when the last clock stopped.@*
6515 @cindex property: CLOCK_MODELINE_TOTAL
6516 @cindex property: LAST_REPEAT
6517 @vindex org-clock-modeline-total
6518 While the clock is running, the current clocking time is shown in the mode
6519 line, along with the title of the task. The clock time shown will be all
6520 time ever clocked for this task and its children. If the task has an effort
6521 estimate (@pxref{Effort estimates}), the mode line displays the current
6522 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6523 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6524 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6525 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6526 will be shown. More control over what time is shown can be exercised with
6527 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6528 @code{current} to show only the current clocking instance, @code{today} to
6529 show all time clocked on this task today (see also the variable
6530 @code{org-extend-today-until}), @code{all} to include all time, or
6531 @code{auto} which is the default@footnote{See also the variable
6532 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6533 mode line entry will pop up a menu with clocking options.
6535 @orgcmd{C-c C-x C-o,org-clock-out}
6536 @vindex org-log-note-clock-out
6537 Stop the clock (clock-out). This inserts another timestamp at the same
6538 location where the clock was last started. It also directly computes
6539 the resulting time and inserts it after the time range as @samp{=>
6540 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6541 possibility to record an additional note together with the clock-out
6542 timestamp@footnote{The corresponding in-buffer setting is:
6543 @code{#+STARTUP: lognoteclock-out}}.
6544 @orgcmd{C-c C-x C-x,org-clock-in-last}
6545 @vindex org-clock-continuously
6546 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6547 select the task from the clock history. With two @kbd{C-u} prefixes,
6548 force continuous clocking by starting the clock when the last clock
6550 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6551 Update the effort estimate for the current clock task.
6554 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6555 Recompute the time interval after changing one of the timestamps. This
6556 is only necessary if you edit the timestamps directly. If you change
6557 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6558 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6559 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6560 clock duration keeps the same.
6561 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6562 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6563 the one of the previous (or the next clock) timestamp by the same duration.
6564 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6565 by five minutes, then the clocked-in timestamp of the next clock will be
6566 increased by five minutes.
6567 @orgcmd{C-c C-t,org-todo}
6568 Changing the TODO state of an item to DONE automatically stops the clock
6569 if it is running in this same item.
6570 @orgcmd{C-c C-x C-q,org-clock-cancel}
6571 Cancel the current clock. This is useful if a clock was started by
6572 mistake, or if you ended up working on something else.
6573 @orgcmd{C-c C-x C-j,org-clock-goto}
6574 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6575 prefix arg, select the target task from a list of recently clocked tasks.
6576 @orgcmd{C-c C-x C-d,org-clock-display}
6577 @vindex org-remove-highlights-with-change
6578 Display time summaries for each subtree in the current buffer. This puts
6579 overlays at the end of each headline, showing the total time recorded under
6580 that heading, including the time of any subheadings. You can use visibility
6581 cycling to study the tree, but the overlays disappear when you change the
6582 buffer (see variable @code{org-remove-highlights-with-change}) or press
6586 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6587 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6588 worked on or closed during a day.
6590 @strong{Important:} note that both @code{org-clock-out} and
6591 @code{org-clock-in-last} can have a global key binding and will not
6592 modify the window disposition.
6594 @node The clock table
6595 @subsection The clock table
6596 @cindex clocktable, dynamic block
6597 @cindex report, of clocked time
6599 Org mode can produce quite complex reports based on the time clocking
6600 information. Such a report is called a @emph{clock table}, because it is
6601 formatted as one or several Org tables.
6604 @orgcmd{C-c C-x C-r,org-clock-report}
6605 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6606 report as an Org mode table into the current file. When the cursor is
6607 at an existing clock table, just update it. When called with a prefix
6608 argument, jump to the first clock report in the current document and
6609 update it. The clock table always includes also trees with
6610 @code{:ARCHIVE:} tag.
6611 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6612 Update dynamic block at point. The cursor needs to be in the
6613 @code{#+BEGIN} line of the dynamic block.
6614 @orgkey{C-u C-c C-x C-u}
6615 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6616 you have several clock table blocks in a buffer.
6617 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6618 Shift the current @code{:block} interval and update the table. The cursor
6619 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6620 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6624 Here is an example of the frame for a clock table as it is inserted into the
6625 buffer with the @kbd{C-c C-x C-r} command:
6627 @cindex #+BEGIN, clocktable
6629 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6633 @vindex org-clocktable-defaults
6634 The @samp{BEGIN} line specifies a number of options to define the scope,
6635 structure, and formatting of the report. Defaults for all these options can
6636 be configured in the variable @code{org-clocktable-defaults}.
6638 @noindent First there are options that determine which clock entries are to
6641 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6642 @r{Clocks at deeper levels will be summed into the upper level.}
6643 :scope @r{The scope to consider. This can be any of the following:}
6644 nil @r{the current buffer or narrowed region}
6645 file @r{the full current buffer}
6646 subtree @r{the subtree where the clocktable is located}
6647 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6648 tree @r{the surrounding level 1 tree}
6649 agenda @r{all agenda files}
6650 ("file"..) @r{scan these files}
6651 file-with-archives @r{current file and its archives}
6652 agenda-with-archives @r{all agenda files, including archives}
6653 :block @r{The time block to consider. This block is specified either}
6654 @r{absolutely, or relative to the current time and may be any of}
6656 2007-12-31 @r{New year eve 2007}
6657 2007-12 @r{December 2007}
6658 2007-W50 @r{ISO-week 50 in 2007}
6659 2007-Q2 @r{2nd quarter in 2007}
6660 2007 @r{the year 2007}
6661 today, yesterday, today-@var{N} @r{a relative day}
6662 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6663 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6664 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6666 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6667 :tstart @r{A time string specifying when to start considering times.}
6668 @r{Relative times like @code{"<-2w>"} can also be used. See}
6669 @r{@ref{Matching tags and properties} for relative time syntax.}
6670 :tend @r{A time string specifying when to stop considering times.}
6671 @r{Relative times like @code{"<now>"} can also be used. See}
6672 @r{@ref{Matching tags and properties} for relative time syntax.}
6673 :wstart @r{The starting day of the week. The default is 1 for monday.}
6674 :mstart @r{The starting day of the month. The default 1 is for the first}
6675 @r{day of the month.}
6676 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6677 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6678 :stepskip0 @r{Do not show steps that have zero time.}
6679 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6680 :tags @r{A tags match to select entries that should contribute. See}
6681 @r{@ref{Matching tags and properties} for the match syntax.}
6684 Then there are options which determine the formatting of the table. These
6685 options are interpreted by the function @code{org-clocktable-write-default},
6686 but you can specify your own function using the @code{:formatter} parameter.
6688 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6689 :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".}
6690 :link @r{Link the item headlines in the table to their origins.}
6691 :narrow @r{An integer to limit the width of the headline column in}
6692 @r{the org table. If you write it like @samp{50!}, then the}
6693 @r{headline will also be shortened in export.}
6694 :indent @r{Indent each headline field according to its level.}
6695 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6696 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6697 :level @r{Should a level number column be included?}
6698 :sort @r{A cons cell like containing the column to sort and a sorting type.}
6699 @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6700 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6701 @r{All are overwritten except if there is an explicit @code{:narrow}}
6702 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6703 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6704 :properties @r{List of properties that should be shown in the table. Each}
6705 @r{property will get its own column.}
6706 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6707 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6708 @r{As a special case, @samp{:formula %} adds a column with % time.}
6709 @r{If you do not specify a formula here, any existing formula}
6710 @r{below the clock table will survive updates and be evaluated.}
6711 :formatter @r{A function to format clock data and insert it into the buffer.}
6713 To get a clock summary of the current level 1 tree, for the current
6714 day, you could write
6716 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6720 and to use a specific time range you could write@footnote{Note that all
6721 parameters must be specified in a single line---the line is broken here
6722 only to fit it into the manual.}
6724 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6725 :tend "<2006-08-10 Thu 12:00>"
6728 A range starting a week ago and ending right now could be written as
6730 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6733 A summary of the current subtree with % times would be
6735 #+BEGIN: clocktable :scope subtree :link t :formula %
6738 A horizontally compact representation of everything clocked during last week
6741 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6745 @node Resolving idle time
6746 @subsection Resolving idle time and continuous clocking
6748 @subsubheading Resolving idle time
6749 @cindex resolve idle time
6750 @vindex org-clock-x11idle-program-name
6752 @cindex idle, resolve, dangling
6753 If you clock in on a work item, and then walk away from your
6754 computer---perhaps to take a phone call---you often need to ``resolve'' the
6755 time you were away by either subtracting it from the current clock, or
6756 applying it to another one.
6758 @vindex org-clock-idle-time
6759 By customizing the variable @code{org-clock-idle-time} to some integer, such
6760 as 10 or 15, Emacs can alert you when you get back to your computer after
6761 being idle for that many minutes@footnote{On computers using Mac OS X,
6762 idleness is based on actual user idleness, not just Emacs' idle time. For
6763 X11, you can install a utility program @file{x11idle.c}, available in the
6764 @code{contrib/scripts} directory of the Org git distribution, or install the
6765 @file{xprintidle} package and set it to the variable
6766 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6767 same general treatment of idleness. On other systems, idle time refers to
6768 Emacs idle time only.}, and ask what you want to do with the idle time.
6769 There will be a question waiting for you when you get back, indicating how
6770 much idle time has passed (constantly updated with the current amount), as
6771 well as a set of choices to correct the discrepancy:
6775 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6776 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6777 effectively changing nothing, or enter a number to keep that many minutes.
6779 If you use the shift key and press @kbd{K}, it will keep however many minutes
6780 you request and then immediately clock out of that task. If you keep all of
6781 the minutes, this is the same as just clocking out of the current task.
6783 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6784 the clock, and then check back in from the moment you returned.
6786 To keep none of the minutes and just clock out at the start of the away time,
6787 use the shift key and press @kbd{S}. Remember that using shift will always
6788 leave you clocked out, no matter which option you choose.
6790 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6791 canceling you subtract the away time, and the resulting clock amount is less
6792 than a minute, the clock will still be canceled rather than clutter up the
6793 log with an empty entry.
6796 What if you subtracted those away minutes from the current clock, and now
6797 want to apply them to a new clock? Simply clock in to any task immediately
6798 after the subtraction. Org will notice that you have subtracted time ``on
6799 the books'', so to speak, and will ask if you want to apply those minutes to
6800 the next task you clock in on.
6802 There is one other instance when this clock resolution magic occurs. Say you
6803 were clocked in and hacking away, and suddenly your cat chased a mouse who
6804 scared a hamster that crashed into your UPS's power button! You suddenly
6805 lose all your buffers, but thanks to auto-save you still have your recent Org
6806 mode changes, including your last clock in.
6808 If you restart Emacs and clock into any task, Org will notice that you have a
6809 dangling clock which was never clocked out from your last session. Using
6810 that clock's starting time as the beginning of the unaccounted-for period,
6811 Org will ask how you want to resolve that time. The logic and behavior is
6812 identical to dealing with away time due to idleness; it is just happening due
6813 to a recovery event rather than a set amount of idle time.
6815 You can also check all the files visited by your Org agenda for dangling
6816 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6818 @subsubheading Continuous clocking
6819 @cindex continuous clocking
6820 @vindex org-clock-continuously
6822 You may want to start clocking from the time when you clocked out the
6823 previous task. To enable this systematically, set @code{org-clock-continuously}
6824 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6825 last clocked entry for this session, and start the new clock from there.
6827 If you only want this from time to time, use three universal prefix arguments
6828 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6830 @node Effort estimates
6831 @section Effort estimates
6832 @cindex effort estimates
6834 @cindex property, Effort
6835 If you want to plan your work in a very detailed way, or if you need to
6836 produce offers with quotations of the estimated work effort, you may want to
6837 assign effort estimates to entries. If you are also clocking your work, you
6838 may later want to compare the planned effort with the actual working time,
6839 a great way to improve planning estimates. Effort estimates are stored in
6840 a special property @code{EFFORT}. You can set the effort for an entry with
6841 the following commands:
6844 @orgcmd{C-c C-x e,org-set-effort}
6845 Set the effort estimate for the current entry. With a numeric prefix
6846 argument, set it to the Nth allowed value (see below). This command is also
6847 accessible from the agenda with the @kbd{e} key.
6848 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6849 Modify the effort estimate of the item currently being clocked.
6852 Clearly the best way to work with effort estimates is through column view
6853 (@pxref{Column view}). You should start by setting up discrete values for
6854 effort estimates, and a @code{COLUMNS} format that displays these values
6855 together with clock sums (if you want to clock your time). For a specific
6859 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6860 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6864 @vindex org-global-properties
6865 @vindex org-columns-default-format
6866 or, even better, you can set up these values globally by customizing the
6867 variables @code{org-global-properties} and @code{org-columns-default-format}.
6868 In particular if you want to use this setup also in the agenda, a global
6869 setup may be advised.
6871 The way to assign estimates to individual items is then to switch to column
6872 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6873 value. The values you enter will immediately be summed up in the hierarchy.
6874 In the column next to it, any clocked time will be displayed.
6876 @vindex org-agenda-columns-add-appointments-to-effort-sum
6877 If you switch to column view in the daily/weekly agenda, the effort column
6878 will summarize the estimated work effort for each day@footnote{Please note
6879 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6880 column view}).}, and you can use this to find space in your schedule. To get
6881 an overview of the entire part of the day that is committed, you can set the
6882 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6883 appointments on a day that take place over a specified time interval will
6884 then also be added to the load estimate of the day.
6886 Effort estimates can be used in secondary agenda filtering that is triggered
6887 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6888 these estimates defined consistently, two or three key presses will narrow
6889 down the list to stuff that fits into an available time slot.
6892 @section Taking notes with a timer
6893 @cindex relative timer
6894 @cindex countdown timer
6897 Org provides two types of timers. There is a relative timer that counts up,
6898 which can be useful when taking notes during, for example, a meeting or
6899 a video viewing. There is also a countdown timer.
6901 The relative and countdown are started with separate commands.
6904 @orgcmd{C-c C-x 0,org-timer-start}
6905 Start or reset the relative timer. By default, the timer is set to 0. When
6906 called with a @kbd{C-u} prefix, prompt the user for a starting offset. If
6907 there is a timer string at point, this is taken as the default, providing a
6908 convenient way to restart taking notes after a break in the process. When
6909 called with a double prefix argument @kbd{C-u C-u}, change all timer strings
6910 in the active region by a certain amount. This can be used to fix timer
6911 strings if the timer was not started at exactly the right moment.
6912 @orgcmd{C-c C-x ;,org-timer-set-timer}
6913 Start a countdown timer. The user is prompted for a duration.
6914 @code{org-timer-default-timer} sets the default countdown value. Giving a
6915 prefix numeric argument overrides this default value. This command is
6916 available as @kbd{;} in agenda buffers.
6919 Once started, relative and countdown timers are controlled with the same
6923 @orgcmd{C-c C-x .,org-timer}
6924 Insert the value of the current relative or countdown timer into the buffer.
6925 If no timer is running, the relative timer will be started. When called with
6926 a prefix argument, the relative timer is restarted.
6927 @orgcmd{C-c C-x -,org-timer-item}
6928 Insert a description list item with the value of the current relative or
6929 countdown timer. With a prefix argument, first reset the relative timer to
6931 @orgcmd{M-@key{RET},org-insert-heading}
6932 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6934 @orgcmd{C-c C-x @comma{},org-timer-pause-or-continue}
6935 Pause the timer, or continue it if it is already paused.
6936 @orgcmd{C-c C-x _,org-timer-stop}
6937 Stop the timer. After this, you can only start a new timer, not continue the
6938 old one. This command also removes the timer from the mode line.
6941 @node Capture - Refile - Archive
6942 @chapter Capture - Refile - Archive
6945 An important part of any organization system is the ability to quickly
6946 capture new ideas and tasks, and to associate reference material with them.
6947 Org does this using a process called @i{capture}. It also can store files
6948 related to a task (@i{attachments}) in a special directory. Once in the
6949 system, tasks and projects need to be moved around. Moving completed project
6950 trees to an archive file keeps the system compact and fast.
6953 * Capture:: Capturing new stuff
6954 * Attachments:: Add files to tasks
6955 * RSS feeds:: Getting input from RSS feeds
6956 * Protocols:: External (e.g., Browser) access to Emacs and Org
6957 * Refile and copy:: Moving/copying a tree from one place to another
6958 * Archiving:: What to do with finished projects
6965 Capture lets you quickly store notes with little interruption of your work
6966 flow. Org's method for capturing new items is heavily inspired by John
6967 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6968 used a special setup for @file{remember.el}, then replaced it with
6969 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6970 been completely replaced by @file{org-capture.el}.
6972 If your configuration depends on @file{org-remember.el}, you need to update
6973 it and use the setup described below. To convert your
6974 @code{org-remember-templates}, run the command
6976 @kbd{M-x org-capture-import-remember-templates RET}
6978 @noindent and then customize the new variable with @kbd{M-x
6979 customize-variable org-capture-templates}, check the result, and save the
6983 * Setting up capture:: Where notes will be stored
6984 * Using capture:: Commands to invoke and terminate capture
6985 * Capture templates:: Define the outline of different note types
6988 @node Setting up capture
6989 @subsection Setting up capture
6991 The following customization sets a default target file for notes, and defines
6992 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6993 suggestion.} for capturing new material.
6995 @vindex org-default-notes-file
6998 (setq org-default-notes-file (concat org-directory "/notes.org"))
6999 (define-key global-map "\C-cc" 'org-capture)
7004 @subsection Using capture
7007 @orgcmd{C-c c,org-capture}
7008 Call the command @code{org-capture}. Note that this key binding is global and
7009 not active by default: you need to install it. If you have templates
7011 defined @pxref{Capture templates}, it will offer these templates for
7012 selection or use a new Org outline node as the default template. It will
7013 insert the template into the target file and switch to an indirect buffer
7014 narrowed to this new node. You may then insert the information you want.
7016 @orgcmd{C-c C-c,org-capture-finalize}
7017 Once you have finished entering information into the capture buffer, @kbd{C-c
7018 C-c} will return you to the window configuration before the capture process,
7019 so that you can resume your work without further distraction. When called
7020 with a prefix arg, finalize and then jump to the captured item.
7022 @orgcmd{C-c C-w,org-capture-refile}
7023 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
7024 a different place. Please realize that this is a normal refiling command
7025 that will be executed---so the cursor position at the moment you run this
7026 command is important. If you have inserted a tree with a parent and
7027 children, first move the cursor back to the parent. Any prefix argument
7028 given to this command will be passed on to the @code{org-refile} command.
7030 @orgcmd{C-c C-k,org-capture-kill}
7031 Abort the capture process and return to the previous state.
7035 You can also call @code{org-capture} in a special way from the agenda, using
7036 the @kbd{k c} key combination. With this access, any timestamps inserted by
7037 the selected capture template will default to the cursor date in the agenda,
7038 rather than to the current date.
7040 To find the locations of the last stored capture, use @code{org-capture} with
7045 Visit the target location of a capture template. You get to select the
7046 template in the usual way.
7047 @orgkey{C-u C-u C-c c}
7048 Visit the last stored capture item in its buffer.
7051 @vindex org-capture-bookmark
7052 @cindex org-capture-last-stored
7053 You can also jump to the bookmark @code{org-capture-last-stored}, which will
7054 automatically be created unless you set @code{org-capture-bookmark} to
7057 To insert the capture at point in an Org buffer, call @code{org-capture} with
7058 a @code{C-0} prefix argument.
7060 @node Capture templates
7061 @subsection Capture templates
7062 @cindex templates, for Capture
7064 You can use templates for different types of capture items, and
7065 for different target locations. The easiest way to create such templates is
7066 through the customize interface.
7070 Customize the variable @code{org-capture-templates}.
7073 Before we give the formal description of template definitions, let's look at
7074 an example. Say you would like to use one template to create general TODO
7075 entries, and you want to put these entries under the heading @samp{Tasks} in
7076 your file @file{~/org/gtd.org}. Also, a date tree in the file
7077 @file{journal.org} should capture journal entries. A possible configuration
7082 (setq org-capture-templates
7083 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
7084 "* TODO %?\n %i\n %a")
7085 ("j" "Journal" entry (file+datetree "~/org/journal.org")
7086 "* %?\nEntered on %U\n %i\n %a")))
7090 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
7094 [[file:@var{link to where you initiated capture}]]
7098 During expansion of the template, @code{%a} has been replaced by a link to
7099 the location from where you called the capture command. This can be
7100 extremely useful for deriving tasks from emails, for example. You fill in
7101 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7102 place where you started the capture process.
7104 To define special keys to capture to a particular template without going
7105 through the interactive template selection, you can create your key binding
7109 (define-key global-map "\C-cx"
7110 (lambda () (interactive) (org-capture nil "x")))
7114 * Template elements:: What is needed for a complete template entry
7115 * Template expansion:: Filling in information about time and context
7116 * Templates in contexts:: Only show a template in a specific context
7119 @node Template elements
7120 @subsubsection Template elements
7122 Now lets look at the elements of a template definition. Each entry in
7123 @code{org-capture-templates} is a list with the following items:
7127 The keys that will select the template, as a string, characters
7128 only, for example @code{"a"} for a template to be selected with a
7129 single key, or @code{"bt"} for selection with two keys. When using
7130 several keys, keys using the same prefix key must be sequential
7131 in the list and preceded by a 2-element entry explaining the
7132 prefix key, for example
7134 ("b" "Templates for marking stuff to buy")
7136 @noindent If you do not define a template for the @kbd{C} key, this key will
7137 be used to open the customize buffer for this complex variable.
7140 A short string describing the template, which will be shown during
7144 The type of entry, a symbol. Valid values are:
7148 An Org mode node, with a headline. Will be filed as the child of the target
7149 entry or as a top-level entry. The target file should be an Org mode file.
7151 A plain list item, placed in the first plain list at the target
7152 location. Again the target file should be an Org file.
7154 A checkbox item. This only differs from the plain list item by the
7157 a new line in the first table at the target location. Where exactly the
7158 line will be inserted depends on the properties @code{:prepend} and
7159 @code{:table-line-pos} (see below).
7161 Text to be inserted as it is.
7165 @vindex org-default-notes-file
7166 Specification of where the captured item should be placed. In Org mode
7167 files, targets usually define a node. Entries will become children of this
7168 node. Other types will be added to the table or list in the body of this
7169 node. Most target specifications contain a file name. If that file name is
7170 the empty string, it defaults to @code{org-default-notes-file}. A file can
7171 also be given as a variable, function, or Emacs Lisp form. When an absolute
7172 path is not specified for a target, it is taken as relative to
7173 @code{org-directory}.
7178 @item (file "path/to/file")
7179 Text will be placed at the beginning or end of that file.
7181 @item (id "id of existing org entry")
7182 Filing as child of this entry, or in the body of the entry.
7184 @item (file+headline "path/to/file" "node headline")
7185 Fast configuration if the target heading is unique in the file.
7187 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7188 For non-unique headings, the full path is safer.
7190 @item (file+regexp "path/to/file" "regexp to find location")
7191 Use a regular expression to position the cursor.
7193 @item (file+datetree "path/to/file")
7194 Will create a heading in a date tree for today's date@footnote{Datetree
7195 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7196 and @code{* 2013} in your file, the capture will refile the note to the first
7199 @item (file+datetree+prompt "path/to/file")
7200 Will create a heading in a date tree, but will prompt for the date.
7202 @item (file+weektree "path/to/file")
7203 Will create a heading in a week tree for today's date. Week trees are sorted
7204 by week and not by month unlike datetrees.
7206 @item (file+weektree+prompt "path/to/file")
7207 Will create a heading in a week tree, but will prompt for the date.
7209 @item (file+function "path/to/file" function-finding-location)
7210 A function to find the right location in the file.
7213 File to the entry that is currently being clocked.
7215 @item (function function-finding-location)
7216 Most general way: write your own function which both visits
7217 the file and moves point to the right location.
7221 The template for creating the capture item. If you leave this empty, an
7222 appropriate default template will be used. Otherwise this is a string with
7223 escape codes, which will be replaced depending on time and context of the
7224 capture call. The string with escapes may be loaded from a template file,
7225 using the special syntax @code{(file "path/to/template")}. See below for
7229 The rest of the entry is a property list of additional options.
7230 Recognized properties are:
7234 Normally new captured information will be appended at
7235 the target location (last child, last table line, last list item...).
7236 Setting this property will change that.
7238 @item :immediate-finish
7239 When set, do not offer to edit the information, just
7240 file it away immediately. This makes sense if the template only needs
7241 information that can be added automatically.
7244 Set this to the number of lines to insert
7245 before and after the new item. Default 0, only common other value is 1.
7248 Start the clock in this item.
7251 Keep the clock running when filing the captured entry.
7254 If starting the capture interrupted a clock, restart that clock when finished
7255 with the capture. Note that @code{:clock-keep} has precedence over
7256 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7257 run and the previous one will not be resumed.
7260 Do not narrow the target buffer, simply show the full buffer. Default is to
7261 narrow it so that you only see the new material.
7263 @item :table-line-pos
7264 Specification of the location in the table where the new line should be
7265 inserted. It can be a string, a variable holding a string or a function
7266 returning a string. The string should look like @code{"II-3"} meaning that
7267 the new line should become the third line before the second horizontal
7271 If the target file was not yet visited when capture was invoked, kill the
7272 buffer again after capture is completed.
7276 @node Template expansion
7277 @subsubsection Template expansion
7279 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7280 these sequences literally, escape the @kbd{%} with a backslash.} allow
7281 dynamic insertion of content. The templates are expanded in the order given here:
7284 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7285 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7286 @r{For convenience, %:keyword (see below) placeholders}
7287 @r{within the expression will be expanded prior to this.}
7288 @r{The sexp must return a string.}
7289 %<...> @r{The result of format-time-string on the ... format specification.}
7290 %t @r{Timestamp, date only.}
7291 %T @r{Timestamp, with date and time.}
7292 %u, %U @r{Like the above, but inactive timestamps.}
7293 %i @r{Initial content, the region when capture is called while the}
7294 @r{region is active.}
7295 @r{The entire text will be indented like @code{%i} itself.}
7296 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7297 %A @r{Like @code{%a}, but prompt for the description part.}
7298 %l @r{Like %a, but only insert the literal link.}
7299 %c @r{Current kill ring head.}
7300 %x @r{Content of the X clipboard.}
7301 %k @r{Title of the currently clocked task.}
7302 %K @r{Link to the currently clocked task.}
7303 %n @r{User name (taken from @code{user-full-name}).}
7304 %f @r{File visited by current buffer when org-capture was called.}
7305 %F @r{Full path of the file or directory visited by current buffer.}
7306 %:keyword @r{Specific information for certain link types, see below.}
7307 %^g @r{Prompt for tags, with completion on tags in target file.}
7308 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7309 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7310 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7311 %^C @r{Interactive selection of which kill or clip to use.}
7312 %^L @r{Like @code{%^C}, but insert as link.}
7313 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7314 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7315 @r{You may specify a default value and a completion table with}
7316 @r{%^@{prompt|default|completion2|completion3...@}.}
7317 @r{The arrow keys access a prompt-specific history.}
7318 %\\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7319 @r{a number, starting from 1.}
7320 %? @r{After completing the template, position cursor here.}
7324 For specific link types, the following keywords will be
7325 defined@footnote{If you define your own link types (@pxref{Adding
7326 hyperlink types}), any property you store with
7327 @code{org-store-link-props} can be accessed in capture templates in a
7330 @vindex org-from-is-user-regexp
7332 Link type | Available keywords
7333 ---------------------------------+----------------------------------------------
7334 bbdb | %:name %:company
7335 irc | %:server %:port %:nick
7336 vm, vm-imap, wl, mh, mew, rmail, | %:type %:subject %:message-id
7337 gnus, notmuch | %:from %:fromname %:fromaddress
7338 | %:to %:toname %:toaddress
7339 | %:date @r{(message date header field)}
7340 | %:date-timestamp @r{(date as active timestamp)}
7341 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7342 | %: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}.}}
7343 gnus | %:group, @r{for messages also all email fields}
7344 eww, w3, w3m | %:url
7345 info | %:file %:node
7350 To place the cursor after template expansion use:
7353 %? @r{After completing the template, position cursor here.}
7356 @node Templates in contexts
7357 @subsubsection Templates in contexts
7359 @vindex org-capture-templates-contexts
7360 To control whether a capture template should be accessible from a specific
7361 context, you can customize @code{org-capture-templates-contexts}. Let's say
7362 for example that you have a capture template @code{"p"} for storing Gnus
7363 emails containing patches. Then you would configure this option like this:
7366 (setq org-capture-templates-contexts
7367 '(("p" (in-mode . "message-mode"))))
7370 You can also tell that the command key @code{"p"} should refer to another
7371 template. In that case, add this command key like this:
7374 (setq org-capture-templates-contexts
7375 '(("p" "q" (in-mode . "message-mode"))))
7378 See the docstring of the variable for more information.
7381 @section Attachments
7384 @vindex org-attach-directory
7385 It is often useful to associate reference material with an outline node/task.
7386 Small chunks of plain text can simply be stored in the subtree of a project.
7387 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7388 files that live elsewhere on your computer or in the cloud, like emails or
7389 source code files belonging to a project. Another method is @i{attachments},
7390 which are files located in a directory belonging to an outline node. Org
7391 uses directories named by the unique ID of each entry. These directories are
7392 located in the @file{data} directory which lives in the same directory where
7393 your Org file lives@footnote{If you move entries or Org files from one
7394 directory to another, you may want to configure @code{org-attach-directory}
7395 to contain an absolute path.}. If you initialize this directory with
7396 @code{git init}, Org will automatically commit changes when it sees them.
7397 The attachment system has been contributed to Org by John Wiegley.
7399 In cases where it seems better to do so, you can also attach a directory of your
7400 choice to an entry. You can also make children inherit the attachment
7401 directory from a parent, so that an entire subtree uses the same attached
7404 @noindent The following commands deal with attachments:
7407 @orgcmd{C-c C-a,org-attach}
7408 The dispatcher for commands related to the attachment system. After these
7409 keys, a list of commands is displayed and you must press an additional key
7410 to select a command:
7413 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7414 @vindex org-attach-method
7415 Select a file and move it into the task's attachment directory. The file
7416 will be copied, moved, or linked, depending on @code{org-attach-method}.
7417 Note that hard links are not supported on all systems.
7423 Attach a file using the copy/move/link method.
7424 Note that hard links are not supported on all systems.
7426 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7427 Create a new attachment as an Emacs buffer.
7429 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7430 Synchronize the current task with its attachment directory, in case you added
7431 attachments yourself.
7433 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7434 @vindex org-file-apps
7435 Open current task's attachment. If there is more than one, prompt for a
7436 file name first. Opening will follow the rules set by @code{org-file-apps}.
7437 For more details, see the information on following hyperlinks
7438 (@pxref{Handling links}).
7440 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7441 Also open the attachment, but force opening the file in Emacs.
7443 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7444 Open the current task's attachment directory.
7446 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7447 Also open the directory, but force using @command{dired} in Emacs.
7449 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7450 Select and delete a single attachment.
7452 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7453 Delete all of a task's attachments. A safer way is to open the directory in
7454 @command{dired} and delete from there.
7456 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7457 @cindex property, ATTACH_DIR
7458 Set a specific directory as the entry's attachment directory. This works by
7459 putting the directory path into the @code{ATTACH_DIR} property.
7461 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7462 @cindex property, ATTACH_DIR_INHERIT
7463 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7464 same directory for attachments as the parent does.
7473 Org can add and change entries based on information found in RSS feeds and
7474 Atom feeds. You could use this to make a task out of each new podcast in a
7475 podcast feed. Or you could use a phone-based note-creating service on the
7476 web to import tasks into Org. To access feeds, configure the variable
7477 @code{org-feed-alist}. The docstring of this variable has detailed
7478 information. Here is just an example:
7482 (setq org-feed-alist
7484 "http://rss.slashdot.org/Slashdot/slashdot"
7485 "~/txt/org/feeds.org" "Slashdot Entries")))
7490 will configure that new items from the feed provided by
7491 @code{rss.slashdot.org} will result in new entries in the file
7492 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7493 the following command is used:
7496 @orgcmd{C-c C-x g,org-feed-update-all}
7498 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7500 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7501 Prompt for a feed name and go to the inbox configured for this feed.
7504 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7505 it will store information about the status of items in the feed, to avoid
7506 adding the same item several times.
7508 For more information, including how to read atom feeds, see
7509 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7512 @section Protocols for external access
7513 @cindex protocols, for external access
7516 You can set up Org for handling protocol calls from outside applications that
7517 are passed to Emacs through the @file{emacsserver}. For example, you can
7518 configure bookmarks in your web browser to send a link to the current page to
7519 Org and create a note from it using capture (@pxref{Capture}). Or you
7520 could create a bookmark that will tell Emacs to open the local source file of
7521 a remote website you are looking at with the browser. See
7522 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7523 documentation and setup instructions.
7525 @node Refile and copy
7526 @section Refile and copy
7527 @cindex refiling notes
7528 @cindex copying notes
7530 When reviewing the captured data, you may want to refile or to copy some of
7531 the entries into a different list, for example into a project. Cutting,
7532 finding the right location, and then pasting the note is cumbersome. To
7533 simplify this process, you can use the following special command:
7536 @orgcmd{C-c M-w,org-copy}
7538 Copying works like refiling, except that the original note is not deleted.
7539 @orgcmd{C-c C-w,org-refile}
7541 @vindex org-reverse-note-order
7542 @vindex org-refile-targets
7543 @vindex org-refile-use-outline-path
7544 @vindex org-outline-path-complete-in-steps
7545 @vindex org-refile-allow-creating-parent-nodes
7546 @vindex org-log-refile
7547 @vindex org-refile-use-cache
7548 @vindex org-refile-keep
7549 Refile the entry or region at point. This command offers possible locations
7550 for refiling the entry and lets you select one with completion. The item (or
7551 all items in the region) is filed below the target heading as a subitem.
7552 Depending on @code{org-reverse-note-order}, it will be either the first or
7554 By default, all level 1 headlines in the current buffer are considered to be
7555 targets, but you can have more complex definitions across a number of files.
7556 See the variable @code{org-refile-targets} for details. If you would like to
7557 select a location via a file-path-like completion along the outline path, see
7558 the variables @code{org-refile-use-outline-path} and
7559 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7560 create new nodes as new parents for refiling on the fly, check the
7561 variable @code{org-refile-allow-creating-parent-nodes}.
7562 When the variable @code{org-log-refile}@footnote{with corresponding
7563 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7564 and @code{nologrefile}} is set, a timestamp or a note will be
7565 recorded when an entry has been refiled.
7566 @orgkey{C-u C-c C-w}
7567 Use the refile interface to jump to a heading.
7568 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7569 Jump to the location where @code{org-refile} last moved a tree to.
7571 Refile as the child of the item currently being clocked.
7573 Refile and keep the entry in place. Also see @code{org-refile-keep} to make
7574 this the default behavior, and beware that this may result in duplicated
7575 @code{ID} properties.
7576 @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}
7577 Clear the target cache. Caching of refile targets can be turned on by
7578 setting @code{org-refile-use-cache}. To make the command see new possible
7579 targets, you have to clear the cache with this command.
7586 When a project represented by a (sub)tree is finished, you may want
7587 to move the tree out of the way and to stop it from contributing to the
7588 agenda. Archiving is important to keep your working files compact and global
7589 searches like the construction of agenda views fast.
7592 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7593 @vindex org-archive-default-command
7594 Archive the current entry using the command specified in the variable
7595 @code{org-archive-default-command}.
7599 * Moving subtrees:: Moving a tree to an archive file
7600 * Internal archiving:: Switch off a tree but keep it in the file
7603 @node Moving subtrees
7604 @subsection Moving a tree to the archive file
7605 @cindex external archiving
7607 The most common archiving action is to move a project tree to another file,
7611 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7612 @vindex org-archive-location
7613 Archive the subtree starting at the cursor position to the location
7614 given by @code{org-archive-location}.
7615 @orgkey{C-u C-c C-x C-s}
7616 Check if any direct children of the current headline could be moved to
7617 the archive. To do this, each subtree is checked for open TODO entries.
7618 If none are found, the command offers to move it to the archive
7619 location. If the cursor is @emph{not} on a headline when this command
7620 is invoked, the level 1 trees will be checked.
7621 @orgkey{C-u C-u C-c C-x C-s}
7622 As above, but check subtree for timestamps instead of TODO entries. The
7623 command will offer to archive the subtree if it @emph{does} contain a
7624 timestamp, and that timestamp is in the past.
7627 @cindex archive locations
7628 The default archive location is a file in the same directory as the
7629 current file, with the name derived by appending @file{_archive} to the
7630 current file name. You can also choose what heading to file archived
7631 items under, with the possibility to add them to a datetree in a file.
7632 For information and examples on how to specify the file and the heading,
7633 see the documentation string of the variable
7634 @code{org-archive-location}.
7636 There is also an in-buffer option for setting this variable, for example:
7640 #+ARCHIVE: %s_done::
7643 @cindex property, ARCHIVE
7645 If you would like to have a special ARCHIVE location for a single entry
7646 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7647 location as the value (@pxref{Properties and columns}).
7649 @vindex org-archive-save-context-info
7650 When a subtree is moved, it receives a number of special properties that
7651 record context information like the file from where the entry came, its
7652 outline path the archiving time etc. Configure the variable
7653 @code{org-archive-save-context-info} to adjust the amount of information
7657 @node Internal archiving
7658 @subsection Internal archiving
7660 If you want to just switch off (for agenda views) certain subtrees without
7661 moving them to a different file, you can use the @code{ARCHIVE tag}.
7663 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7664 its location in the outline tree, but behaves in the following way:
7667 @vindex org-cycle-open-archived-trees
7668 It does not open when you attempt to do so with a visibility cycling
7669 command (@pxref{Visibility cycling}). You can force cycling archived
7670 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7671 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7672 @code{show-all} will open archived subtrees.
7674 @vindex org-sparse-tree-open-archived-trees
7675 During sparse tree construction (@pxref{Sparse trees}), matches in
7676 archived subtrees are not exposed, unless you configure the option
7677 @code{org-sparse-tree-open-archived-trees}.
7679 @vindex org-agenda-skip-archived-trees
7680 During agenda view construction (@pxref{Agenda views}), the content of
7681 archived trees is ignored unless you configure the option
7682 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7683 be included. In the agenda you can press @kbd{v a} to get archives
7684 temporarily included.
7686 @vindex org-export-with-archived-trees
7687 Archived trees are not exported (@pxref{Exporting}), only the headline
7688 is. Configure the details using the variable
7689 @code{org-export-with-archived-trees}.
7691 @vindex org-columns-skip-archived-trees
7692 Archived trees are excluded from column view unless the variable
7693 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7696 The following commands help manage the ARCHIVE tag:
7699 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7700 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7701 the headline changes to a shadowed face, and the subtree below it is
7703 @orgkey{C-u C-c C-x a}
7704 Check if any direct children of the current headline should be archived.
7705 To do this, each subtree is checked for open TODO entries. If none are
7706 found, the command offers to set the ARCHIVE tag for the child. If the
7707 cursor is @emph{not} on a headline when this command is invoked, the
7708 level 1 trees will be checked.
7709 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7710 Cycle a tree even if it is tagged with ARCHIVE.
7711 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7712 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7713 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7714 entry becomes a child of that sibling and in this way retains a lot of its
7715 original context, including inherited tags and approximate position in the
7721 @chapter Agenda views
7722 @cindex agenda views
7724 Due to the way Org works, TODO items, time-stamped items, and
7725 tagged headlines can be scattered throughout a file or even a number of
7726 files. To get an overview of open action items, or of events that are
7727 important for a particular date, this information must be collected,
7728 sorted and displayed in an organized way.
7730 Org can select items based on various criteria and display them
7731 in a separate buffer. Seven different view types are provided:
7735 an @emph{agenda} that is like a calendar and shows information
7738 a @emph{TODO list} that covers all unfinished
7741 a @emph{match view}, showings headlines based on the tags, properties, and
7742 TODO state associated with them,
7744 a @emph{timeline view} that shows all events in a single Org file,
7745 in time-sorted view,
7747 a @emph{text search view} that shows all entries from multiple files
7748 that contain specified keywords,
7750 a @emph{stuck projects view} showing projects that currently don't move
7753 @emph{custom views} that are special searches and combinations of different
7758 The extracted information is displayed in a special @emph{agenda
7759 buffer}. This buffer is read-only, but provides commands to visit the
7760 corresponding locations in the original Org files, and even to
7761 edit these files remotely.
7763 @vindex org-agenda-window-setup
7764 @vindex org-agenda-restore-windows-after-quit
7765 Two variables control how the agenda buffer is displayed and whether the
7766 window configuration is restored when the agenda exits:
7767 @code{org-agenda-window-setup} and
7768 @code{org-agenda-restore-windows-after-quit}.
7771 * Agenda files:: Files being searched for agenda information
7772 * Agenda dispatcher:: Keyboard access to agenda views
7773 * Built-in agenda views:: What is available out of the box?
7774 * Presentation and sorting:: How agenda items are prepared for display
7775 * Agenda commands:: Remote editing of Org trees
7776 * Custom agenda views:: Defining special searches and views
7777 * Exporting agenda views:: Writing a view to a file
7778 * Agenda column view:: Using column view for collected entries
7782 @section Agenda files
7783 @cindex agenda files
7784 @cindex files for agenda
7786 @vindex org-agenda-files
7787 The information to be shown is normally collected from all @emph{agenda
7788 files}, the files listed in the variable
7789 @code{org-agenda-files}@footnote{If the value of that variable is not a
7790 list, but a single file name, then the list of agenda files will be
7791 maintained in that external file.}. If a directory is part of this list,
7792 all files with the extension @file{.org} in this directory will be part
7795 Thus, even if you only work with a single Org file, that file should
7796 be put into the list@footnote{When using the dispatcher, pressing
7797 @kbd{<} before selecting a command will actually limit the command to
7798 the current file, and ignore @code{org-agenda-files} until the next
7799 dispatcher command.}. You can customize @code{org-agenda-files}, but
7800 the easiest way to maintain it is through the following commands
7802 @cindex files, adding to agenda list
7804 @orgcmd{C-c [,org-agenda-file-to-front}
7805 Add current file to the list of agenda files. The file is added to
7806 the front of the list. If it was already in the list, it is moved to
7807 the front. With a prefix argument, file is added/moved to the end.
7808 @orgcmd{C-c ],org-remove-file}
7809 Remove current file from the list of agenda files.
7811 @cindex cycling, of agenda files
7812 @orgcmd{C-',org-cycle-agenda-files}
7814 Cycle through agenda file list, visiting one file after the other.
7815 @kindex M-x org-iswitchb
7816 @item M-x org-iswitchb RET
7817 Command to use an @code{iswitchb}-like interface to switch to and between Org
7822 The Org menu contains the current list of files and can be used
7823 to visit any of them.
7825 If you would like to focus the agenda temporarily on a file not in
7826 this list, or on just one file in the list, or even on only a subtree in a
7827 file, then this can be done in different ways. For a single agenda command,
7828 you may press @kbd{<} once or several times in the dispatcher
7829 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7830 extended period, use the following commands:
7833 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7834 Permanently restrict the agenda to the current subtree. When with a
7835 prefix argument, or with the cursor before the first headline in a file,
7836 the agenda scope is set to the entire file. This restriction remains in
7837 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7838 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7839 agenda view, the new restriction takes effect immediately.
7840 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7841 Remove the permanent restriction created by @kbd{C-c C-x <}.
7845 When working with @file{speedbar.el}, you can use the following commands in
7849 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7850 Permanently restrict the agenda to the item---either an Org file or a subtree
7851 in such a file---at the cursor in the Speedbar frame.
7852 If there is a window displaying an agenda view, the new restriction takes
7854 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7855 Lift the restriction.
7858 @node Agenda dispatcher
7859 @section The agenda dispatcher
7860 @cindex agenda dispatcher
7861 @cindex dispatching agenda commands
7862 The views are created through a dispatcher, which should be bound to a
7863 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7864 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7865 is accessed and list keyboard access to commands accordingly. After
7866 pressing @kbd{C-c a}, an additional letter is required to execute a
7867 command. The dispatcher offers the following default commands:
7871 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7873 Create a list of all TODO items (@pxref{Global TODO list}).
7875 Create a list of headlines matching a TAGS expression (@pxref{Matching
7876 tags and properties}).
7878 Create the timeline view for the current buffer (@pxref{Timeline}).
7880 Create a list of entries selected by a boolean expression of keywords
7881 and/or regular expressions that must or must not occur in the entry.
7883 @vindex org-agenda-text-search-extra-files
7884 Search for a regular expression in all agenda files and additionally in
7885 the files listed in @code{org-agenda-text-search-extra-files}. This
7886 uses the Emacs command @code{multi-occur}. A prefix argument can be
7887 used to specify the number of context lines for each match, default is
7890 Create a list of stuck projects (@pxref{Stuck projects}).
7892 Restrict an agenda command to the current buffer@footnote{For backward
7893 compatibility, you can also press @kbd{1} to restrict to the current
7894 buffer.}. After pressing @kbd{<}, you still need to press the character
7895 selecting the command.
7897 If there is an active region, restrict the following agenda command to
7898 the region. Otherwise, restrict it to the current subtree@footnote{For
7899 backward compatibility, you can also press @kbd{0} to restrict to the
7900 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7901 character selecting the command.
7904 @cindex agenda, sticky
7905 @vindex org-agenda-sticky
7906 Toggle sticky agenda views. By default, Org maintains only a single agenda
7907 buffer and rebuilds it each time you change the view, to make sure everything
7908 is always up to date. If you often switch between agenda views and the build
7909 time bothers you, you can turn on sticky agenda buffers or make this the
7910 default by customizing the variable @code{org-agenda-sticky}. With sticky
7911 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7912 it will only switch to the selected one, and you need to update the agenda by
7913 hand with @kbd{r} or @kbd{g} when needed. You can toggle sticky agenda view
7914 any time with @code{org-toggle-sticky-agenda}.
7917 You can also define custom commands that will be accessible through the
7918 dispatcher, just like the default commands. This includes the
7919 possibility to create extended agenda buffers that contain several
7920 blocks together, for example the weekly agenda, the global TODO list and
7921 a number of special tags matches. @xref{Custom agenda views}.
7923 @node Built-in agenda views
7924 @section The built-in agenda views
7926 In this section we describe the built-in views.
7929 * Weekly/daily agenda:: The calendar page with current tasks
7930 * Global TODO list:: All unfinished action items
7931 * Matching tags and properties:: Structured information with fine-tuned search
7932 * Timeline:: Time-sorted view for single file
7933 * Search view:: Find entries by searching for text
7934 * Stuck projects:: Find projects you need to review
7937 @node Weekly/daily agenda
7938 @subsection The weekly/daily agenda
7940 @cindex weekly agenda
7941 @cindex daily agenda
7943 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7944 paper agenda, showing all the tasks for the current week or day.
7947 @cindex org-agenda, command
7948 @orgcmd{C-c a a,org-agenda-list}
7949 Compile an agenda for the current week from a list of Org files. The agenda
7950 shows the entries for each day. With a numeric prefix@footnote{For backward
7951 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7952 listed before the agenda. This feature is deprecated, use the dedicated TODO
7953 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7954 C-c a a}) you may set the number of days to be displayed.
7957 @vindex org-agenda-span
7958 @vindex org-agenda-ndays
7959 @vindex org-agenda-start-day
7960 @vindex org-agenda-start-on-weekday
7961 The default number of days displayed in the agenda is set by the variable
7962 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7963 variable can be set to any number of days you want to see by default in the
7964 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7965 @code{year}. For weekly agendas, the default is to start on the previous
7966 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7967 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7968 start the agenda ten days from today in the future.
7970 Remote editing from the agenda buffer means, for example, that you can
7971 change the dates of deadlines and appointments from the agenda buffer.
7972 The commands available in the Agenda buffer are listed in @ref{Agenda
7975 @subsubheading Calendar/Diary integration
7976 @cindex calendar integration
7977 @cindex diary integration
7979 Emacs contains the calendar and diary by Edward M. Reingold. The
7980 calendar displays a three-month calendar with holidays from different
7981 countries and cultures. The diary allows you to keep track of
7982 anniversaries, lunar phases, sunrise/set, recurrent appointments
7983 (weekly, monthly) and more. In this way, it is quite complementary to
7984 Org. It can be very useful to combine output from Org with
7987 In order to include entries from the Emacs diary into Org mode's
7988 agenda, you only need to customize the variable
7991 (setq org-agenda-include-diary t)
7994 @noindent After that, everything will happen automatically. All diary
7995 entries including holidays, anniversaries, etc., will be included in the
7996 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7997 @key{RET} can be used from the agenda buffer to jump to the diary
7998 file in order to edit existing diary entries. The @kbd{i} command to
7999 insert new entries for the current date works in the agenda buffer, as
8000 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
8001 Sunrise/Sunset times, show lunar phases and to convert to other
8002 calendars, respectively. @kbd{c} can be used to switch back and forth
8003 between calendar and agenda.
8005 If you are using the diary only for sexp entries and holidays, it is
8006 faster to not use the above setting, but instead to copy or even move
8007 the entries into an Org file. Org mode evaluates diary-style sexp
8008 entries, and does it faster because there is no overhead for first
8009 creating the diary display. Note that the sexp entries must start at
8010 the left margin, no whitespace is allowed before them. For example,
8011 the following segment of an Org file will be processed and entries
8012 will be made in the agenda:
8019 %%(org-calendar-holiday) ; special function for holiday names
8025 %%(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
8026 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
8029 @subsubheading Anniversaries from BBDB
8030 @cindex BBDB, anniversaries
8031 @cindex anniversaries, from BBDB
8033 If you are using the Big Brothers Database to store your contacts, you will
8034 very likely prefer to store anniversaries in BBDB rather than in a
8035 separate Org or diary file. Org supports this and will show BBDB
8036 anniversaries as part of the agenda. All you need to do is to add the
8037 following to one of your agenda files:
8044 %%(org-bbdb-anniversaries)
8047 You can then go ahead and define anniversaries for a BBDB record. Basically,
8048 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
8049 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
8050 followed by a space and the class of the anniversary (@samp{birthday} or
8051 @samp{wedding}, or a format string). If you omit the class, it will default to
8052 @samp{birthday}. Here are a few examples, the header for the file
8053 @file{org-bbdb.el} contains more detailed information.
8059 2008-04-14 %s released version 6.01 of org mode, %d years ago
8062 After a change to BBDB, or for the first agenda display during an Emacs
8063 session, the agenda display will suffer a short delay as Org updates its
8064 hash with anniversaries. However, from then on things will be very fast---much
8065 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
8066 in an Org or Diary file.
8068 If you would like to see upcoming anniversaries with a bit of forewarning,
8069 you can use the following instead:
8076 %%(org-bbdb-anniversaries-future 3)
8079 That will give you three days' warning: on the anniversary date itself and the
8080 two days prior. The argument is optional: if omitted, it defaults to 7.
8082 @subsubheading Appointment reminders
8083 @cindex @file{appt.el}
8084 @cindex appointment reminders
8088 Org can interact with Emacs appointments notification facility. To add the
8089 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
8090 This command lets you filter through the list of your appointments and add
8091 only those belonging to a specific category or matching a regular expression.
8092 It also reads a @code{APPT_WARNTIME} property which will then override the
8093 value of @code{appt-message-warning-time} for this appointment. See the
8094 docstring for details.
8096 @node Global TODO list
8097 @subsection The global TODO list
8098 @cindex global TODO list
8099 @cindex TODO list, global
8101 The global TODO list contains all unfinished TODO items formatted and
8102 collected into a single place.
8105 @orgcmd{C-c a t,org-todo-list}
8106 Show the global TODO list. This collects the TODO items from all agenda
8107 files (@pxref{Agenda views}) into a single buffer. By default, this lists
8108 items with a state the is not a DONE state. The buffer is in
8109 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
8110 entries directly from that buffer (@pxref{Agenda commands}).
8111 @orgcmd{C-c a T,org-todo-list}
8112 @cindex TODO keyword matching
8113 @vindex org-todo-keywords
8114 Like the above, but allows selection of a specific TODO keyword. You can
8115 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
8116 prompted for a keyword, and you may also specify several keywords by
8117 separating them with @samp{|} as the boolean OR operator. With a numeric
8118 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
8120 The @kbd{r} key in the agenda buffer regenerates it, and you can give
8121 a prefix argument to this command to change the selected TODO keyword,
8122 for example @kbd{3 r}. If you often need a search for a specific
8123 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
8124 Matching specific TODO keywords can also be done as part of a tags
8125 search (@pxref{Tag searches}).
8128 Remote editing of TODO items means that you can change the state of a
8129 TODO entry with a single key press. The commands available in the
8130 TODO list are described in @ref{Agenda commands}.
8132 @cindex sublevels, inclusion into TODO list
8133 Normally the global TODO list simply shows all headlines with TODO
8134 keywords. This list can become very long. There are two ways to keep
8138 @vindex org-agenda-todo-ignore-scheduled
8139 @vindex org-agenda-todo-ignore-deadlines
8140 @vindex org-agenda-todo-ignore-timestamp
8141 @vindex org-agenda-todo-ignore-with-date
8142 Some people view a TODO item that has been @emph{scheduled} for execution or
8143 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8144 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8145 @code{org-agenda-todo-ignore-deadlines},
8146 @code{org-agenda-todo-ignore-timestamp} and/or
8147 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8150 @vindex org-agenda-todo-list-sublevels
8151 TODO items may have sublevels to break up the task into subtasks. In
8152 such cases it may be enough to list only the highest level TODO headline
8153 and omit the sublevels from the global list. Configure the variable
8154 @code{org-agenda-todo-list-sublevels} to get this behavior.
8157 @node Matching tags and properties
8158 @subsection Matching tags and properties
8159 @cindex matching, of tags
8160 @cindex matching, of properties
8164 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8165 or have properties (@pxref{Properties and columns}), you can select headlines
8166 based on this metadata and collect them into an agenda buffer. The match
8167 syntax described here also applies when creating sparse trees with @kbd{C-c /
8171 @orgcmd{C-c a m,org-tags-view}
8172 Produce a list of all headlines that match a given set of tags. The
8173 command prompts for a selection criterion, which is a boolean logic
8174 expression with tags, like @samp{+work+urgent-withboss} or
8175 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
8176 define a custom command for it (@pxref{Agenda dispatcher}).
8177 @orgcmd{C-c a M,org-tags-view}
8178 @vindex org-tags-match-list-sublevels
8179 @vindex org-agenda-tags-todo-honor-ignore-options
8180 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8181 not-DONE state and force checking subitems (see variable
8182 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
8183 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
8184 specific TODO keywords together with a tags match is also possible, see
8188 The commands available in the tags list are described in @ref{Agenda
8191 @subsubheading Match syntax
8193 @cindex Boolean logic, for tag/property searches
8194 A search string can use Boolean operators @samp{&} for @code{AND} and
8195 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8196 Parentheses are not implemented. Each element in the search is either a
8197 tag, a regular expression matching tags, or an expression like
8198 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8199 property value. Each element may be preceded by @samp{-}, to select
8200 against it, and @samp{+} is syntactic sugar for positive selection. The
8201 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8202 present. Here are some examples, using only tags.
8206 Select headlines tagged @samp{:work:}.
8208 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8210 Select headlines tagged @samp{:work:}, but discard those also tagged
8213 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8214 @item work|laptop+night
8215 Like before, but require the @samp{:laptop:} lines to be tagged also
8219 @cindex regular expressions, with tags search
8220 Instead of a tag, you may also specify a regular expression enclosed in curly
8221 braces. For example,
8222 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8223 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8225 @cindex group tags, as regular expressions
8226 Group tags (@pxref{Tag hierarchy}) are expanded as regular expressions. E.g.,
8227 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8228 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8229 and searching for @samp{-work} will search for all headlines but those with
8230 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8232 @cindex TODO keyword matching, with tags search
8233 @cindex level, require for tags/property match
8234 @cindex category, require for tags/property match
8235 @vindex org-odd-levels-only
8236 You may also test for properties (@pxref{Properties and columns}) at the same
8237 time as matching tags. The properties may be real properties, or special
8238 properties that represent other metadata (@pxref{Special properties}). For
8239 example, the ``property'' @code{TODO} represents the TODO keyword of the
8240 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8243 In addition to the @ref{Special properties}, one other ``property'' can also
8244 be used. @code{LEVEL} represents the level of an entry. So a search
8245 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8246 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8247 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8248 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8250 Here are more examples:
8253 @item work+TODO="WAITING"
8254 Select @samp{:work:}-tagged TODO lines with the specific TODO
8255 keyword @samp{WAITING}.
8256 @item work+TODO="WAITING"|home+TODO="WAITING"
8257 Waiting tasks both at work and at home.
8260 When matching properties, a number of different operators can be used to test
8261 the value of a property. Here is a complex example:
8264 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8265 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8269 The type of comparison will depend on how the comparison value is written:
8272 If the comparison value is a plain number, a numerical comparison is done,
8273 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8274 @samp{>=}, and @samp{<>}.
8276 If the comparison value is enclosed in double-quotes,
8277 a string comparison is done, and the same operators are allowed.
8279 If the comparison value is enclosed in double-quotes @emph{and} angular
8280 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8281 assumed to be date/time specifications in the standard Org way, and the
8282 comparison will be done accordingly. Special values that will be recognized
8283 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8284 @code{"<tomorrow>"} for these days at 00:00 hours, i.e., without a time
8285 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8286 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8287 respectively, can be used.
8289 If the comparison value is enclosed
8290 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8291 regexp matches the property value, and @samp{<>} meaning that it does not
8295 So the search string in the example finds entries tagged @samp{:work:} but
8296 not @samp{:boss:}, which also have a priority value @samp{A}, a
8297 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8298 property that is numerically smaller than 2, a @samp{:With:} property that is
8299 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8300 on or after October 11, 2008.
8302 You can configure Org mode to use property inheritance during a search, but
8303 beware that this can slow down searches considerably. See @ref{Property
8304 inheritance}, for details.
8306 For backward compatibility, and also for typing speed, there is also a
8307 different way to test TODO states in a search. For this, terminate the
8308 tags/property part of the search string (which may include several terms
8309 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8310 expression just for TODO keywords. The syntax is then similar to that for
8311 tags, but should be applied with care: for example, a positive selection on
8312 several TODO keywords cannot meaningfully be combined with boolean AND@.
8313 However, @emph{negative selection} combined with AND can be meaningful. To
8314 make sure that only lines are checked that actually have any TODO keyword
8315 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8316 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8317 not match TODO keywords in a DONE state. Examples:
8321 Same as @samp{work+TODO="WAITING"}
8322 @item work/!-WAITING-NEXT
8323 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8325 @item work/!+WAITING|+NEXT
8326 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8331 @subsection Timeline for a single file
8332 @cindex timeline, single file
8333 @cindex time-sorted view
8335 The timeline summarizes all time-stamped items from a single Org mode
8336 file in a @emph{time-sorted view}. The main purpose of this command is
8337 to give an overview over events in a project.
8340 @orgcmd{C-c a L,org-timeline}
8341 Show a time-sorted view of the Org file, with all time-stamped items.
8342 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8343 (scheduled or not) are also listed under the current date.
8347 The commands available in the timeline buffer are listed in
8348 @ref{Agenda commands}.
8351 @subsection Search view
8354 @cindex searching, for text
8356 This agenda view is a general text search facility for Org mode entries.
8357 It is particularly useful to find notes.
8360 @orgcmd{C-c a s,org-search-view}
8361 This is a special search that lets you select entries by matching a substring
8362 or specific words using a boolean logic.
8364 For example, the search string @samp{computer equipment} will find entries
8365 that contain @samp{computer equipment} as a substring. If the two words are
8366 separated by more space or a line break, the search will still match.
8367 Search view can also search for specific keywords in the entry, using Boolean
8368 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8369 will search for note entries that contain the keywords @code{computer}
8370 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8371 not matched by the regular expression @code{8\.11[bg]}, meaning to
8372 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8373 word search, other @samp{+} characters are optional. For more details, see
8374 the docstring of the command @code{org-search-view}.
8376 @vindex org-agenda-text-search-extra-files
8377 Note that in addition to the agenda files, this command will also search
8378 the files listed in @code{org-agenda-text-search-extra-files}.
8380 @node Stuck projects
8381 @subsection Stuck projects
8382 @pindex GTD, Getting Things Done
8384 If you are following a system like David Allen's GTD to organize your
8385 work, one of the ``duties'' you have is a regular review to make sure
8386 that all projects move along. A @emph{stuck} project is a project that
8387 has no defined next actions, so it will never show up in the TODO lists
8388 Org mode produces. During the review, you need to identify such
8389 projects and define next actions for them.
8392 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8393 List projects that are stuck.
8396 @vindex org-stuck-projects
8397 Customize the variable @code{org-stuck-projects} to define what a stuck
8398 project is and how to find it.
8401 You almost certainly will have to configure this view before it will
8402 work for you. The built-in default assumes that all your projects are
8403 level-2 headlines, and that a project is not stuck if it has at least
8404 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8406 Let's assume that you, in your own way of using Org mode, identify
8407 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8408 indicate a project that should not be considered yet. Let's further
8409 assume that the TODO keyword DONE marks finished projects, and that NEXT
8410 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8411 is a next action even without the NEXT tag. Finally, if the project
8412 contains the special word IGNORE anywhere, it should not be listed
8413 either. In this case you would start by identifying eligible projects
8414 with a tags/todo match@footnote{@xref{Tag searches}.}
8415 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8416 IGNORE in the subtree to identify projects that are not stuck. The
8417 correct customization for this is
8420 (setq org-stuck-projects
8421 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8425 Note that if a project is identified as non-stuck, the subtree of this entry
8426 will still be searched for stuck projects.
8428 @node Presentation and sorting
8429 @section Presentation and sorting
8430 @cindex presentation, of agenda items
8432 @vindex org-agenda-prefix-format
8433 @vindex org-agenda-tags-column
8434 Before displaying items in an agenda view, Org mode visually prepares the
8435 items and sorts them. Each item occupies a single line. The line starts
8436 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8437 of the item and other important information. You can customize in which
8438 column tags will be displayed through @code{org-agenda-tags-column}. You can
8439 also customize the prefix using the option @code{org-agenda-prefix-format}.
8440 This prefix is followed by a cleaned-up version of the outline headline
8441 associated with the item.
8444 * Categories:: Not all tasks are equal
8445 * Time-of-day specifications:: How the agenda knows the time
8446 * Sorting agenda items:: The order of things
8447 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8451 @subsection Categories
8455 The category is a broad label assigned to each agenda item. By default, the
8456 category is simply derived from the file name, but you can also specify it
8457 with a special line in the buffer, like this:
8464 @cindex property, CATEGORY
8465 If you would like to have a special CATEGORY for a single entry or a
8466 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8467 special category you want to apply as the value.
8470 The display in the agenda buffer looks best if the category is not
8471 longer than 10 characters.
8474 You can set up icons for category by customizing the
8475 @code{org-agenda-category-icon-alist} variable.
8477 @node Time-of-day specifications
8478 @subsection Time-of-day specifications
8479 @cindex time-of-day specification
8481 Org mode checks each agenda item for a time-of-day specification. The
8482 time can be part of the timestamp that triggered inclusion into the
8483 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8484 ranges can be specified with two timestamps, like
8486 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8488 In the headline of the entry itself, a time(range) may also appear as
8489 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8490 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8491 specifications in diary entries are recognized as well.
8493 For agenda display, Org mode extracts the time and displays it in a
8494 standard 24 hour format as part of the prefix. The example times in
8495 the previous paragraphs would end up in the agenda like this:
8498 8:30-13:00 Arthur Dent lies in front of the bulldozer
8499 12:45...... Ford Prefect arrives and takes Arthur to the pub
8500 19:00...... The Vogon reads his poem
8501 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8505 If the agenda is in single-day mode, or for the display of today, the
8506 timed entries are embedded in a time grid, like
8509 8:00...... ------------------
8510 8:30-13:00 Arthur Dent lies in front of the bulldozer
8511 10:00...... ------------------
8512 12:00...... ------------------
8513 12:45...... Ford Prefect arrives and takes Arthur to the pub
8514 14:00...... ------------------
8515 16:00...... ------------------
8516 18:00...... ------------------
8517 19:00...... The Vogon reads his poem
8518 20:00...... ------------------
8519 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8522 @vindex org-agenda-use-time-grid
8523 @vindex org-agenda-time-grid
8524 The time grid can be turned on and off with the variable
8525 @code{org-agenda-use-time-grid}, and can be configured with
8526 @code{org-agenda-time-grid}.
8528 @node Sorting agenda items
8529 @subsection Sorting agenda items
8530 @cindex sorting, of agenda items
8531 @cindex priorities, of agenda items
8532 Before being inserted into a view, the items are sorted. How this is
8533 done depends on the type of view.
8536 @vindex org-agenda-files
8537 For the daily/weekly agenda, the items for each day are sorted. The
8538 default order is to first collect all items containing an explicit
8539 time-of-day specification. These entries will be shown at the beginning
8540 of the list, as a @emph{schedule} for the day. After that, items remain
8541 grouped in categories, in the sequence given by @code{org-agenda-files}.
8542 Within each category, items are sorted by priority (@pxref{Priorities}),
8543 which is composed of the base priority (2000 for priority @samp{A}, 1000
8544 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8545 overdue scheduled or deadline items.
8547 For the TODO list, items remain in the order of categories, but within
8548 each category, sorting takes place according to priority
8549 (@pxref{Priorities}). The priority used for sorting derives from the
8550 priority cookie, with additions depending on how close an item is to its due
8553 For tags matches, items are not sorted at all, but just appear in the
8554 sequence in which they are found in the agenda files.
8557 @vindex org-agenda-sorting-strategy
8558 Sorting can be customized using the variable
8559 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8560 the estimated effort of an entry (@pxref{Effort estimates}).
8562 @node Filtering/limiting agenda items
8563 @subsection Filtering/limiting agenda items
8565 Agenda built-in or customized commands are statically defined. Agenda
8566 filters and limits provide two ways of dynamically narrowing down the list of
8567 agenda entries: @emph{filters} and @emph{limits}. Filters only act on the
8568 display of the items, while limits take effect before the list of agenda
8569 entries is built. Filters are more often used interactively, while limits are
8570 mostly useful when defined as local variables within custom agenda commands.
8572 @subsubheading Filtering in the agenda
8573 @cindex filtering, by tag, category, top headline and effort, in agenda
8574 @cindex tag filtering, in agenda
8575 @cindex category filtering, in agenda
8576 @cindex top headline filtering, in agenda
8577 @cindex effort filtering, in agenda
8578 @cindex query editing, in agenda
8581 @orgcmd{/,org-agenda-filter-by-tag}
8582 @vindex org-agenda-tag-filter-preset
8583 Filter the agenda view with respect to a tag and/or effort estimates. The
8584 difference between this and a custom agenda command is that filtering is very
8585 fast, so that you can switch quickly between different filters without having
8586 to recreate the agenda.@footnote{Custom commands can preset a filter by
8587 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8588 filter will then be applied to the view and persist as a basic filter through
8589 refreshes and more secondary filtering. The filter is a global property of
8590 the entire agenda view---in a block agenda, you should only set this in the
8591 global options section, not in the section of an individual block.}
8593 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8594 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8595 tag (including any tags that do not have a selection character). The command
8596 then hides all entries that do not contain or inherit this tag. When called
8597 with prefix arg, remove the entries that @emph{do} have the tag. A second
8598 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8599 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8600 will be narrowed by requiring or forbidding the selected additional tag.
8601 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8602 immediately use the @kbd{\} command.
8604 Org also supports automatic, context-aware tag filtering. If the variable
8605 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8606 that function can decide which tags should be excluded from the agenda
8607 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8608 as a sub-option key and runs the auto exclusion logic. For example, let's
8609 say you use a @code{Net} tag to identify tasks which need network access, an
8610 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8611 calls. You could auto-exclude these tags based on the availability of the
8612 Internet, and outside of business hours, with something like this:
8616 (defun org-my-auto-exclude-function (tag)
8618 ((string= tag "Net")
8619 (/= 0 (call-process "/sbin/ping" nil nil nil
8620 "-c1" "-q" "-t1" "mail.gnu.org")))
8621 ((or (string= tag "Errand") (string= tag "Call"))
8622 (let ((hour (nth 2 (decode-time))))
8623 (or (< hour 8) (> hour 21)))))
8626 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8637 @item @r{in} search view
8638 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8639 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8640 add a positive search term prefixed by @samp{+}, indicating that this search
8641 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8642 negative search term which @i{must not} occur/match in the entry for it to be
8646 @orgcmd{<,org-agenda-filter-by-category}
8647 @vindex org-agenda-category-filter-preset
8649 Filter the current agenda view with respect to the category of the item at
8650 point. Pressing @code{<} another time will remove this filter. When called
8651 with a prefix argument exclude the category of the item at point from the
8652 agenda. You can add a filter preset through the option
8653 @code{org-agenda-category-filter-preset} (see below.)
8655 @orgcmd{^,org-agenda-filter-by-top-headline}
8656 Filter the current agenda view and only display the siblings and the parent
8657 headline of the one at point.
8659 @orgcmd{=,org-agenda-filter-by-regexp}
8660 @vindex org-agenda-regexp-filter-preset
8662 Filter the agenda view by a regular expression: only show agenda entries
8663 matching the regular expression the user entered. When called with a prefix
8664 argument, it will filter @emph{out} entries matching the regexp. With two
8665 universal prefix arguments, it will remove all the regexp filters, which can
8666 be accumulated. You can add a filter preset through the option
8667 @code{org-agenda-category-filter-preset} (see below.)
8669 @orgcmd{_,org-agenda-filter-by-effort}
8670 @vindex org-agenda-effort-filter-preset
8671 @vindex org-sort-agenda-noeffort-is-high
8672 Filter the agenda view with respect to effort estimates.
8673 You first need to set up allowed efforts globally, for example
8675 (setq org-global-properties
8676 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8678 You can then filter for an effort by first typing an operator, one of
8679 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8680 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8681 The filter will then restrict to entries with effort smaller-or-equal, equal,
8682 or larger-or-equal than the selected value. For application of the operator,
8683 entries without a defined effort will be treated according to the value of
8684 @code{org-sort-agenda-noeffort-is-high}.
8686 @orgcmd{|,org-agenda-filter-remove-all}
8687 Remove all filters in the current agenda view.
8690 @subsubheading Setting limits for the agenda
8691 @cindex limits, in agenda
8692 @vindex org-agenda-max-entries
8693 @vindex org-agenda-max-effort
8694 @vindex org-agenda-max-todos
8695 @vindex org-agenda-max-tags
8697 Here is a list of options that you can set, either globally, or locally in
8698 your custom agenda views (@pxref{Custom agenda views}).
8701 @item org-agenda-max-entries
8702 Limit the number of entries.
8703 @item org-agenda-max-effort
8704 Limit the duration of accumulated efforts (as minutes).
8705 @item org-agenda-max-todos
8706 Limit the number of entries with TODO keywords.
8707 @item org-agenda-max-tags
8708 Limit the number of tagged entries.
8711 When set to a positive integer, each option will exclude entries from other
8712 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8713 the agenda to 100 minutes of effort and exclude any entry that has no effort
8714 property. If you want to include entries with no effort property, use a
8715 negative value for @code{org-agenda-max-effort}.
8717 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8718 command. For example, this custom command will display the next five entries
8719 with a @code{NEXT} TODO keyword.
8722 (setq org-agenda-custom-commands
8724 ((org-agenda-max-entries 5)))))
8727 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8728 will again the next five entries again, including the first entry that was
8731 You can also dynamically set temporary limits, which will be lost when
8732 rebuilding the agenda:
8735 @orgcmd{~,org-agenda-limit-interactively}
8736 This prompts for the type of limit to apply and its value.
8739 @node Agenda commands
8740 @section Commands in the agenda buffer
8741 @cindex commands, in agenda buffer
8743 Entries in the agenda buffer are linked back to the Org file or diary
8744 file where they originate. You are not allowed to edit the agenda
8745 buffer itself, but commands are provided to show and jump to the
8746 original entry location, and to edit the Org files ``remotely'' from
8747 the agenda buffer. In this way, all information is stored only once,
8748 removing the risk that your agenda and note files may diverge.
8750 Some commands can be executed with mouse clicks on agenda lines. For
8751 the other commands, the cursor needs to be in the desired line.
8754 @tsubheading{Motion}
8755 @cindex motion commands in agenda
8756 @orgcmd{n,org-agenda-next-line}
8757 Next line (same as @key{down} and @kbd{C-n}).
8758 @orgcmd{p,org-agenda-previous-line}
8759 Previous line (same as @key{up} and @kbd{C-p}).
8760 @orgcmd{N,org-agenda-next-item}
8761 Next item: same as next line, but only consider items.
8762 @orgcmd{P,org-agenda-previous-item}
8763 Previous item: same as previous line, but only consider items.
8764 @tsubheading{View/Go to Org file}
8765 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8766 Display the original location of the item in another window.
8767 With prefix arg, make sure that the entire entry is made visible in the
8768 outline, not only the heading.
8770 @orgcmd{L,org-agenda-recenter}
8771 Display original location and recenter that window.
8773 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8774 Go to the original location of the item in another window.
8776 @orgcmd{@key{RET},org-agenda-switch-to}
8777 Go to the original location of the item and delete other windows.
8779 @orgcmd{F,org-agenda-follow-mode}
8780 @vindex org-agenda-start-with-follow-mode
8781 Toggle Follow mode. In Follow mode, as you move the cursor through
8782 the agenda buffer, the other window always shows the corresponding
8783 location in the Org file. The initial setting for this mode in new
8784 agenda buffers can be set with the variable
8785 @code{org-agenda-start-with-follow-mode}.
8787 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8788 Display the entire subtree of the current item in an indirect buffer. With a
8789 numeric prefix argument N, go up to level N and then take that tree. If N is
8790 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8791 previously used indirect buffer.
8793 @orgcmd{C-c C-o,org-agenda-open-link}
8794 Follow a link in the entry. This will offer a selection of any links in the
8795 text belonging to the referenced Org node. If there is only one link, it
8796 will be followed without a selection prompt.
8798 @tsubheading{Change display}
8799 @cindex display changing, in agenda
8802 Interactively select another agenda view and append it to the current view.
8806 Delete other windows.
8808 @orgcmdkskc{v d,d,org-agenda-day-view}
8809 @xorgcmdkskc{v w,w,org-agenda-week-view}
8810 @xorgcmd{v t,org-agenda-fortnight-view}
8811 @xorgcmd{v m,org-agenda-month-view}
8812 @xorgcmd{v y,org-agenda-year-view}
8813 @xorgcmd{v SPC,org-agenda-reset-view}
8814 @vindex org-agenda-span
8815 Switch to day/week/month/year view. When switching to day or week view, this
8816 setting becomes the default for subsequent agenda refreshes. Since month and
8817 year views are slow to create, they do not become the default. A numeric
8818 prefix argument may be used to jump directly to a specific day of the year,
8819 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8820 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8821 month view, a year may be encoded in the prefix argument as well. For
8822 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8823 specification has only one or two digits, it will be mapped to the interval
8824 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8825 @code{org-agenda-span}.
8827 @orgcmd{f,org-agenda-later}
8828 Go forward in time to display the following @code{org-agenda-current-span} days.
8829 For example, if the display covers a week, switch to the following week.
8830 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8832 @orgcmd{b,org-agenda-earlier}
8833 Go backward in time to display earlier dates.
8835 @orgcmd{.,org-agenda-goto-today}
8838 @orgcmd{j,org-agenda-goto-date}
8839 Prompt for a date and go there.
8841 @orgcmd{J,org-agenda-clock-goto}
8842 Go to the currently clocked-in task @i{in the agenda buffer}.
8844 @orgcmd{D,org-agenda-toggle-diary}
8845 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8847 @orgcmdkskc{v l,l,org-agenda-log-mode}
8849 @vindex org-log-done
8850 @vindex org-agenda-log-mode-items
8851 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8852 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8853 entries that have been clocked on that day. You can configure the entry
8854 types that should be included in log mode using the variable
8855 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8856 all possible logbook entries, including state changes. When called with two
8857 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8858 @kbd{v L} is equivalent to @kbd{C-u v l}.
8860 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8861 Include inactive timestamps into the current view. Only for weekly/daily
8862 agenda and timeline views.
8864 @orgcmd{v a,org-agenda-archives-mode}
8865 @xorgcmd{v A,org-agenda-archives-mode 'files}
8866 @cindex Archives mode
8867 Toggle Archives mode. In Archives mode, trees that are marked
8868 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8869 capital @kbd{A}, even all archive files are included. To exit archives mode,
8870 press @kbd{v a} again.
8872 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8873 @vindex org-agenda-start-with-clockreport-mode
8874 @vindex org-clock-report-include-clocking-task
8875 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8876 always show a table with the clocked times for the time span and file scope
8877 covered by the current agenda view. The initial setting for this mode in new
8878 agenda buffers can be set with the variable
8879 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8880 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8881 contributions from entries that are hidden by agenda filtering@footnote{Only
8882 tags filtering will be respected here, effort filtering is ignored.}. See
8883 also the variable @code{org-clock-report-include-clocking-task}.
8886 @vindex org-agenda-clock-consistency-checks
8887 Show overlapping clock entries, clocking gaps, and other clocking problems in
8888 the current agenda range. You can then visit clocking lines and fix them
8889 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8890 information on how to customize the definition of what constituted a clocking
8891 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8894 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8895 @vindex org-agenda-start-with-entry-text-mode
8896 @vindex org-agenda-entry-text-maxlines
8897 Toggle entry text mode. In entry text mode, a number of lines from the Org
8898 outline node referenced by an agenda line will be displayed below the line.
8899 The maximum number of lines is given by the variable
8900 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8901 prefix argument will temporarily modify that number to the prefix value.
8903 @orgcmd{G,org-agenda-toggle-time-grid}
8904 @vindex org-agenda-use-time-grid
8905 @vindex org-agenda-time-grid
8906 Toggle the time grid on and off. See also the variables
8907 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8909 @orgcmd{r,org-agenda-redo}
8910 Recreate the agenda buffer, for example to reflect the changes after
8911 modification of the timestamps of items with @kbd{S-@key{left}} and
8912 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8913 argument is interpreted to create a selective list for a specific TODO
8915 @orgcmd{g,org-agenda-redo}
8918 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8919 Save all Org buffers in the current Emacs session, and also the locations of
8922 @orgcmd{C-c C-x C-c,org-agenda-columns}
8923 @vindex org-columns-default-format
8924 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8925 view format is taken from the entry at point, or (if there is no entry at
8926 point), from the first entry in the agenda view. So whatever the format for
8927 that entry would be in the original buffer (taken from a property, from a
8928 @code{#+COLUMNS} line, or from the default variable
8929 @code{org-columns-default-format}), will be used in the agenda.
8931 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8932 Remove the restriction lock on the agenda, if it is currently restricted to a
8933 file or subtree (@pxref{Agenda files}).
8935 @tsubheading{Secondary filtering and query editing}
8937 For a detailed description of these commands, see @pxref{Filtering/limiting
8940 @orgcmd{/,org-agenda-filter-by-tag}
8941 @vindex org-agenda-tag-filter-preset
8942 Filter the agenda view with respect to a tag and/or effort estimates.
8944 @orgcmd{<,org-agenda-filter-by-category}
8945 @vindex org-agenda-category-filter-preset
8947 Filter the current agenda view with respect to the category of the item at
8948 point. Pressing @code{<} another time will remove this filter.
8950 @orgcmd{^,org-agenda-filter-by-top-headline}
8951 Filter the current agenda view and only display the siblings and the parent
8952 headline of the one at point.
8954 @orgcmd{=,org-agenda-filter-by-regexp}
8955 @vindex org-agenda-regexp-filter-preset
8957 Filter the agenda view by a regular expression: only show agenda entries
8958 matching the regular expression the user entered. When called with a prefix
8959 argument, it will filter @emph{out} entries matching the regexp. With two
8960 universal prefix arguments, it will remove all the regexp filters, which can
8961 be accumulated. You can add a filter preset through the option
8962 @code{org-agenda-category-filter-preset} (see below.)
8964 @orgcmd{|,org-agenda-filter-remove-all}
8965 Remove all filters in the current agenda view.
8967 @tsubheading{Remote editing}
8968 @cindex remote editing, from agenda
8973 @cindex undoing remote-editing events
8974 @cindex remote editing, undo
8975 @orgcmd{C-_,org-agenda-undo}
8976 Undo a change due to a remote editing command. The change is undone
8977 both in the agenda buffer and in the remote buffer.
8979 @orgcmd{t,org-agenda-todo}
8980 Change the TODO state of the item, both in the agenda and in the
8983 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8984 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8985 Switch to the next/previous set of TODO keywords.
8987 @orgcmd{C-k,org-agenda-kill}
8988 @vindex org-agenda-confirm-kill
8989 Delete the current agenda item along with the entire subtree belonging
8990 to it in the original Org file. If the text to be deleted remotely
8991 is longer than one line, the kill needs to be confirmed by the user. See
8992 variable @code{org-agenda-confirm-kill}.
8994 @orgcmd{C-c C-w,org-agenda-refile}
8995 Refile the entry at point.
8997 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8998 @vindex org-archive-default-command
8999 Archive the subtree corresponding to the entry at point using the default
9000 archiving command set in @code{org-archive-default-command}. When using the
9001 @code{a} key, confirmation will be required.
9003 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
9004 Toggle the ARCHIVE tag for the current headline.
9006 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
9007 Move the subtree corresponding to the current entry to its @emph{archive
9010 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
9011 Archive the subtree corresponding to the current headline. This means the
9012 entry will be moved to the configured archive location, most likely a
9015 @orgcmd{T,org-agenda-show-tags}
9016 @vindex org-agenda-show-inherited-tags
9017 Show all tags associated with the current item. This is useful if you have
9018 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
9019 tags of a headline occasionally.
9021 @orgcmd{:,org-agenda-set-tags}
9022 Set tags for the current headline. If there is an active region in the
9023 agenda, change a tag for all headings in the region.
9027 Set the priority for the current item (@command{org-agenda-priority}).
9028 Org mode prompts for the priority character. If you reply with @key{SPC},
9029 the priority cookie is removed from the entry.
9031 @orgcmd{P,org-agenda-show-priority}
9032 Display weighted priority of current item.
9034 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
9035 Increase the priority of the current item. The priority is changed in
9036 the original buffer, but the agenda is not resorted. Use the @kbd{r}
9039 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
9040 Decrease the priority of the current item.
9042 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
9043 @vindex org-log-into-drawer
9044 Add a note to the entry. This note will be recorded, and then filed to the
9045 same location where state change notes are put. Depending on
9046 @code{org-log-into-drawer}, this may be inside a drawer.
9048 @orgcmd{C-c C-a,org-attach}
9049 Dispatcher for all command related to attachments.
9051 @orgcmd{C-c C-s,org-agenda-schedule}
9052 Schedule this item. With prefix arg remove the scheduling timestamp
9054 @orgcmd{C-c C-d,org-agenda-deadline}
9055 Set a deadline for this item. With prefix arg remove the deadline.
9057 @orgcmd{S-@key{right},org-agenda-do-date-later}
9058 Change the timestamp associated with the current line by one day into the
9059 future. If the date is in the past, the first call to this command will move
9061 With a numeric prefix argument, change it by that many days. For example,
9062 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
9063 change the time by one hour. If you immediately repeat the command, it will
9064 continue to change hours even without the prefix arg. With a double @kbd{C-u
9065 C-u} prefix, do the same for changing minutes.@*
9066 The stamp is changed in the original Org file, but the change is not directly
9067 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
9069 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
9070 Change the timestamp associated with the current line by one day
9073 @orgcmd{>,org-agenda-date-prompt}
9074 Change the timestamp associated with the current line. The key @kbd{>} has
9075 been chosen, because it is the same as @kbd{S-.} on my keyboard.
9077 @orgcmd{I,org-agenda-clock-in}
9078 Start the clock on the current item. If a clock is running already, it
9081 @orgcmd{O,org-agenda-clock-out}
9082 Stop the previously started clock.
9084 @orgcmd{X,org-agenda-clock-cancel}
9085 Cancel the currently running clock.
9087 @orgcmd{J,org-agenda-clock-goto}
9088 Jump to the running clock in another window.
9090 @orgcmd{k,org-agenda-capture}
9091 Like @code{org-capture}, but use the date at point as the default date for
9092 the capture template. See @code{org-capture-use-agenda-date} to make this
9093 the default behavior of @code{org-capture}.
9094 @cindex capturing, from agenda
9095 @vindex org-capture-use-agenda-date
9097 @tsubheading{Dragging agenda lines forward/backward}
9098 @cindex dragging, agenda lines
9100 @orgcmd{M-<up>,org-agenda-drag-line-backward}
9101 Drag the line at point backward one line@footnote{Moving agenda lines does
9102 not persist after an agenda refresh and does not modify the contributing
9103 @file{.org} files}. With a numeric prefix argument, drag backward by that
9106 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9107 Drag the line at point forward one line. With a numeric prefix argument,
9108 drag forward by that many lines.
9110 @tsubheading{Bulk remote editing selected entries}
9111 @cindex remote editing, bulk, from agenda
9112 @vindex org-agenda-bulk-custom-functions
9114 @orgcmd{m,org-agenda-bulk-mark}
9115 Mark the entry at point for bulk action. With numeric prefix argument, mark
9116 that many successive entries.
9118 @orgcmd{*,org-agenda-bulk-mark-all}
9119 Mark all visible agenda entries for bulk action.
9121 @orgcmd{u,org-agenda-bulk-unmark}
9122 Unmark entry at point for bulk action.
9124 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9125 Unmark all marked entries for bulk action.
9127 @orgcmd{M-m,org-agenda-bulk-toggle}
9128 Toggle mark of the entry at point for bulk action.
9130 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9131 Toggle marks of all visible entries for bulk action.
9133 @orgcmd{%,org-agenda-bulk-mark-regexp}
9134 Mark entries matching a regular expression for bulk action.
9136 @orgcmd{B,org-agenda-bulk-action}
9137 Bulk action: act on all marked entries in the agenda. This will prompt for
9138 another key to select the action to be applied. The prefix arg to @kbd{B}
9139 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9140 these special timestamps. By default, marks are removed after the bulk. If
9141 you want them to persist, set @code{org-agenda-persistent-marks} to @code{t}
9142 or hit @kbd{p} at the prompt.
9146 Toggle persistent marks.
9148 Archive all selected entries.
9150 Archive entries by moving them to their respective archive siblings.
9152 Change TODO state. This prompts for a single TODO keyword and changes the
9153 state of all selected entries, bypassing blocking and suppressing logging
9154 notes (but not timestamps).
9156 Add a tag to all selected entries.
9158 Remove a tag from all selected entries.
9160 Schedule all items to a new date. To shift existing schedule dates by a
9161 fixed number of days, use something starting with double plus at the prompt,
9162 for example @samp{++8d} or @samp{++2w}.
9164 Set deadline to a specific date.
9166 Prompt for a single refile target and move all entries. The entries will no
9167 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9169 Reschedule randomly into the coming N days. N will be prompted for. With
9170 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9172 Apply a function@footnote{You can also create persistent custom functions
9173 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
9174 example, the function below sets the CATEGORY property of the entries to web.
9178 (defun set-category ()
9180 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9181 (org-agenda-error)))
9182 (buffer (marker-buffer marker)))
9183 (with-current-buffer buffer
9188 (org-back-to-heading t)
9189 (org-set-property "CATEGORY" "web"))))))
9194 @tsubheading{Calendar commands}
9195 @cindex calendar commands, from agenda
9197 @orgcmd{c,org-agenda-goto-calendar}
9198 Open the Emacs calendar and move to the date at the agenda cursor.
9200 @orgcmd{c,org-calendar-goto-agenda}
9201 When in the calendar, compute and show the Org mode agenda for the
9204 @cindex diary entries, creating from agenda
9205 @orgcmd{i,org-agenda-diary-entry}
9206 @vindex org-agenda-diary-file
9207 Insert a new entry into the diary, using the date at the cursor and (for
9208 block entries) the date at the mark. This will add to the Emacs diary
9209 file@footnote{This file is parsed for the agenda when
9210 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9211 command in the calendar. The diary file will pop up in another window, where
9212 you can add the entry.
9214 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9215 Org will create entries (in Org mode syntax) in that file instead. Most
9216 entries will be stored in a date-based outline tree that will later make it
9217 easy to archive appointments from previous months/years. The tree will be
9218 built under an entry with a @code{DATE_TREE} property, or else with years as
9219 top-level entries. Emacs will prompt you for the entry text---if you specify
9220 it, the entry will be created in @code{org-agenda-diary-file} without further
9221 interaction. If you directly press @key{RET} at the prompt without typing
9222 text, the target file will be shown in another window for you to finish the
9223 entry there. See also the @kbd{k r} command.
9225 @orgcmd{M,org-agenda-phases-of-moon}
9226 Show the phases of the moon for the three months around current date.
9228 @orgcmd{S,org-agenda-sunrise-sunset}
9229 Show sunrise and sunset times. The geographical location must be set
9230 with calendar variables, see the documentation for the Emacs calendar.
9232 @orgcmd{C,org-agenda-convert-date}
9233 Convert the date at cursor into many other cultural and historic
9236 @orgcmd{H,org-agenda-holidays}
9237 Show holidays for three months around the cursor date.
9239 @item M-x org-icalendar-combine-agenda-files RET
9240 Export a single iCalendar file containing entries from all agenda files.
9241 This is a globally available command, and also available in the agenda menu.
9243 @tsubheading{Exporting to a file}
9244 @orgcmd{C-x C-w,org-agenda-write}
9245 @cindex exporting agenda views
9246 @cindex agenda views, exporting
9247 @vindex org-agenda-exporter-settings
9248 Write the agenda view to a file. Depending on the extension of the selected
9249 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9250 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9251 (any other extension). When exporting to Org, only the body of original
9252 headlines are exported, not subtrees or inherited tags. When called with a
9253 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9254 variable @code{org-agenda-exporter-settings} to set options for
9255 @file{ps-print} and for @file{htmlize} to be used during export.
9257 @tsubheading{Quit and Exit}
9258 @orgcmd{q,org-agenda-quit}
9259 Quit agenda, remove the agenda buffer.
9261 @cindex agenda files, removing buffers
9262 @orgcmd{x,org-agenda-exit}
9263 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9264 for the compilation of the agenda. Buffers created by the user to
9265 visit Org files will not be removed.
9269 @node Custom agenda views
9270 @section Custom agenda views
9271 @cindex custom agenda views
9272 @cindex agenda views, custom
9274 Custom agenda commands serve two purposes: to store and quickly access
9275 frequently used TODO and tags searches, and to create special composite
9276 agenda buffers. Custom agenda commands will be accessible through the
9277 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9280 * Storing searches:: Type once, use often
9281 * Block agenda:: All the stuff you need in a single buffer
9282 * Setting options:: Changing the rules
9285 @node Storing searches
9286 @subsection Storing searches
9288 The first application of custom searches is the definition of keyboard
9289 shortcuts for frequently used searches, either creating an agenda
9290 buffer, or a sparse tree (the latter covering of course only the current
9293 @vindex org-agenda-custom-commands
9294 @cindex agenda views, main example
9295 @cindex agenda, as an agenda views
9296 @cindex agenda*, as an agenda views
9297 @cindex tags, as an agenda view
9298 @cindex todo, as an agenda view
9304 Custom commands are configured in the variable
9305 @code{org-agenda-custom-commands}. You can customize this variable, for
9306 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9307 Lisp in @file{.emacs}. The following example contains all valid agenda
9312 (setq org-agenda-custom-commands
9315 ("w" todo "WAITING")
9316 ("W" todo-tree "WAITING")
9317 ("u" tags "+boss-urgent")
9318 ("v" tags-todo "+boss-urgent")
9319 ("U" tags-tree "+boss-urgent")
9320 ("f" occur-tree "\\<FIXME\\>")
9321 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9322 ("hl" tags "+home+Lisa")
9323 ("hp" tags "+home+Peter")
9324 ("hk" tags "+home+Kim")))
9329 The initial string in each entry defines the keys you have to press
9330 after the dispatcher command @kbd{C-c a} in order to access the command.
9331 Usually this will be just a single character, but if you have many
9332 similar commands, you can also define two-letter combinations where the
9333 first character is the same in several combinations and serves as a
9334 prefix key@footnote{You can provide a description for a prefix key by
9335 inserting a cons cell with the prefix and the description.}. The second
9336 parameter is the search type, followed by the string or regular
9337 expression to be used for the matching. The example above will
9342 as a global search for agenda entries planned@footnote{@emph{Planned} means
9343 here that these entries have some planning information attached to them, like
9344 a time-stamp, a scheduled or a deadline string. See
9345 @code{org-agenda-entry-types} on how to set what planning information will be
9346 taken into account.} this week/day.
9348 as a global search for agenda entries planned this week/day, but only those
9349 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9351 as a global search for TODO entries with @samp{WAITING} as the TODO
9354 as the same search, but only in the current buffer and displaying the
9355 results as a sparse tree
9357 as a global tags search for headlines marked @samp{:boss:} but not
9360 as the same search as @kbd{C-c a u}, but limiting the search to
9361 headlines that are also TODO items
9363 as the same search as @kbd{C-c a u}, but only in the current buffer and
9364 displaying the result as a sparse tree
9366 to create a sparse tree (again: current buffer only) with all entries
9367 containing the word @samp{FIXME}
9369 as a prefix command for a HOME tags search where you have to press an
9370 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9371 Peter, or Kim) as additional tag to match.
9374 Note that the @code{*-tree} agenda views need to be called from an
9375 Org buffer as they operate on the current buffer only.
9378 @subsection Block agenda
9379 @cindex block agenda
9380 @cindex agenda, with block views
9382 Another possibility is the construction of agenda views that comprise
9383 the results of @emph{several} commands, each of which creates a block in
9384 the agenda buffer. The available commands include @code{agenda} for the
9385 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9386 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9387 matching commands discussed above: @code{todo}, @code{tags}, and
9388 @code{tags-todo}. Here are two examples:
9392 (setq org-agenda-custom-commands
9393 '(("h" "Agenda and Home-related tasks"
9397 ("o" "Agenda and Office-related tasks"
9405 This will define @kbd{C-c a h} to create a multi-block view for stuff
9406 you need to attend to at home. The resulting agenda buffer will contain
9407 your agenda for the current week, all TODO items that carry the tag
9408 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9409 command @kbd{C-c a o} provides a similar view for office tasks.
9411 @node Setting options
9412 @subsection Setting options for custom commands
9413 @cindex options, for custom agenda views
9415 @vindex org-agenda-custom-commands
9416 Org mode contains a number of variables regulating agenda construction
9417 and display. The global variables define the behavior for all agenda
9418 commands, including the custom commands. However, if you want to change
9419 some settings just for a single custom view, you can do so. Setting
9420 options requires inserting a list of variable names and values at the
9421 right spot in @code{org-agenda-custom-commands}. For example:
9425 (setq org-agenda-custom-commands
9426 '(("w" todo "WAITING"
9427 ((org-agenda-sorting-strategy '(priority-down))
9428 (org-agenda-prefix-format " Mixed: ")))
9429 ("U" tags-tree "+boss-urgent"
9430 ((org-show-context-detail 'minimal)))
9432 ((org-agenda-files '("~org/notes.org"))
9433 (org-agenda-text-search-extra-files nil)))))
9438 Now the @kbd{C-c a w} command will sort the collected entries only by
9439 priority, and the prefix format is modified to just say @samp{ Mixed: }
9440 instead of giving the category of the entry. The sparse tags tree of
9441 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9442 headline hierarchy above the match, nor the headline following the match
9443 will be shown. The command @kbd{C-c a N} will do a text search limited
9444 to only a single file.
9446 @vindex org-agenda-custom-commands
9447 For command sets creating a block agenda,
9448 @code{org-agenda-custom-commands} has two separate spots for setting
9449 options. You can add options that should be valid for just a single
9450 command in the set, and options that should be valid for all commands in
9451 the set. The former are just added to the command entry; the latter
9452 must come after the list of command entries. Going back to the block
9453 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9454 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9455 the results for GARDEN tags query in the opposite order,
9456 @code{priority-up}. This would look like this:
9460 (setq org-agenda-custom-commands
9461 '(("h" "Agenda and Home-related tasks"
9465 ((org-agenda-sorting-strategy '(priority-up)))))
9466 ((org-agenda-sorting-strategy '(priority-down))))
9467 ("o" "Agenda and Office-related tasks"
9474 As you see, the values and parentheses setting is a little complex.
9475 When in doubt, use the customize interface to set this variable---it
9476 fully supports its structure. Just one caveat: when setting options in
9477 this interface, the @emph{values} are just Lisp expressions. So if the
9478 value is a string, you need to add the double-quotes around the value
9481 @vindex org-agenda-custom-commands-contexts
9482 To control whether an agenda command should be accessible from a specific
9483 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9484 say for example that you have an agenda command @code{"o"} displaying a view
9485 that you only need when reading emails. Then you would configure this option
9489 (setq org-agenda-custom-commands-contexts
9490 '(("o" (in-mode . "message-mode"))))
9493 You can also tell that the command key @code{"o"} should refer to another
9494 command key @code{"r"}. In that case, add this command key like this:
9497 (setq org-agenda-custom-commands-contexts
9498 '(("o" "r" (in-mode . "message-mode"))))
9501 See the docstring of the variable for more information.
9503 @node Exporting agenda views
9504 @section Exporting agenda views
9505 @cindex agenda views, exporting
9507 If you are away from your computer, it can be very useful to have a printed
9508 version of some agenda views to carry around. Org mode can export custom
9509 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9510 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9511 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9512 a PDF file will also create the postscript file.}, and iCalendar files. If
9513 you want to do this only occasionally, use the command
9516 @orgcmd{C-x C-w,org-agenda-write}
9517 @cindex exporting agenda views
9518 @cindex agenda views, exporting
9519 @vindex org-agenda-exporter-settings
9520 Write the agenda view to a file. Depending on the extension of the selected
9521 file name, the view will be exported as HTML (extension @file{.html} or
9522 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9523 @file{.ics}), or plain text (any other extension). Use the variable
9524 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9525 for @file{htmlize} to be used during export, for example
9527 @vindex org-agenda-add-entry-text-maxlines
9528 @vindex htmlize-output-type
9529 @vindex ps-number-of-columns
9530 @vindex ps-landscape-mode
9532 (setq org-agenda-exporter-settings
9533 '((ps-number-of-columns 2)
9534 (ps-landscape-mode t)
9535 (org-agenda-add-entry-text-maxlines 5)
9536 (htmlize-output-type 'css)))
9540 If you need to export certain agenda views frequently, you can associate
9541 any custom agenda command with a list of output file names
9542 @footnote{If you want to store standard views like the weekly agenda
9543 or the global TODO list as well, you need to define custom commands for
9544 them in order to be able to specify file names.}. Here is an example
9545 that first defines custom commands for the agenda and the global
9546 TODO list, together with a number of files to which to export them.
9547 Then we define two block agenda commands and specify file names for them
9548 as well. File names can be relative to the current working directory,
9553 (setq org-agenda-custom-commands
9554 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9555 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9556 ("h" "Agenda and Home-related tasks"
9561 ("~/views/home.html"))
9562 ("o" "Agenda and Office-related tasks"
9567 ("~/views/office.ps" "~/calendars/office.ics"))))
9571 The extension of the file name determines the type of export. If it is
9572 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9573 the buffer to HTML and save it to this file name. If the extension is
9574 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9575 Postscript output. If the extension is @file{.ics}, iCalendar export is
9576 run export over all files that were used to construct the agenda, and
9577 limit the export to entries listed in the agenda. Any other
9578 extension produces a plain ASCII file.
9580 The export files are @emph{not} created when you use one of those
9581 commands interactively because this might use too much overhead.
9582 Instead, there is a special command to produce @emph{all} specified
9586 @orgcmd{C-c a e,org-store-agenda-views}
9587 Export all agenda views that have export file names associated with
9591 You can use the options section of the custom agenda commands to also
9592 set options for the export commands. For example:
9595 (setq org-agenda-custom-commands
9597 ((ps-number-of-columns 2)
9598 (ps-landscape-mode t)
9599 (org-agenda-prefix-format " [ ] ")
9600 (org-agenda-with-colors nil)
9601 (org-agenda-remove-tags t))
9606 This command sets two options for the Postscript exporter, to make it
9607 print in two columns in landscape format---the resulting page can be cut
9608 in two and then used in a paper agenda. The remaining settings modify
9609 the agenda prefix to omit category and scheduling information, and
9610 instead include a checkbox to check off items. We also remove the tags
9611 to make the lines compact, and we don't want to use colors for the
9612 black-and-white printer. Settings specified in
9613 @code{org-agenda-exporter-settings} will also apply, but the settings
9614 in @code{org-agenda-custom-commands} take precedence.
9617 From the command line you may also use
9619 emacs -eval (org-batch-store-agenda-views) -kill
9622 or, if you need to modify some parameters@footnote{Quoting depends on the
9623 system you use, please check the FAQ for examples.}
9625 emacs -eval '(org-batch-store-agenda-views \
9626 org-agenda-span (quote month) \
9627 org-agenda-start-day "2007-11-01" \
9628 org-agenda-include-diary nil \
9629 org-agenda-files (quote ("~/org/project.org")))' \
9633 which will create the agenda views restricted to the file
9634 @file{~/org/project.org}, without diary entries and with a 30-day
9637 You can also extract agenda information in a way that allows further
9638 processing by other programs. See @ref{Extracting agenda information}, for
9642 @node Agenda column view
9643 @section Using column view in the agenda
9644 @cindex column view, in agenda
9645 @cindex agenda, column view
9647 Column view (@pxref{Column view}) is normally used to view and edit
9648 properties embedded in the hierarchical structure of an Org file. It can be
9649 quite useful to use column view also from the agenda, where entries are
9650 collected by certain criteria.
9653 @orgcmd{C-c C-x C-c,org-agenda-columns}
9654 Turn on column view in the agenda.
9657 To understand how to use this properly, it is important to realize that the
9658 entries in the agenda are no longer in their proper outline environment.
9659 This causes the following issues:
9663 @vindex org-columns-default-format
9664 @vindex org-overriding-columns-format
9665 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9666 entries in the agenda are collected from different files, and different files
9667 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9668 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9669 currently set, and if so, takes the format from there. Otherwise it takes
9670 the format associated with the first item in the agenda, or, if that item
9671 does not have a specific format (defined in a property, or in its file), it
9672 uses @code{org-columns-default-format}.
9674 @cindex property, special, CLOCKSUM
9675 If any of the columns has a summary type defined (@pxref{Column attributes}),
9676 turning on column view in the agenda will visit all relevant agenda files and
9677 make sure that the computations of this property are up to date. This is
9678 also true for the special @code{CLOCKSUM} property. Org will then sum the
9679 values displayed in the agenda. In the daily/weekly agenda, the sums will
9680 cover a single day; in all other views they cover the entire block. It is
9681 vital to realize that the agenda may show the same entry @emph{twice} (for
9682 example as scheduled and as a deadline), and it may show two entries from the
9683 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9684 cases, the summation in the agenda will lead to incorrect results because
9685 some values will count double.
9687 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9688 the entire clocked time for this item. So even in the daily/weekly agenda,
9689 the clocksum listed in column view may originate from times outside the
9690 current view. This has the advantage that you can compare these values with
9691 a column listing the planned total effort for a task---one of the major
9692 applications for column view in the agenda. If you want information about
9693 clocked time in the displayed period use clock table mode (press @kbd{R} in
9697 @cindex property, special, CLOCKSUM_T
9698 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9699 always today's clocked time for this item. So even in the weekly agenda,
9700 the clocksum listed in column view only originates from today. This lets
9701 you compare the time you spent on a task for today, with the time already
9702 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9707 @chapter Markup for rich export
9709 When exporting Org mode documents, the exporter tries to reflect the
9710 structure of the document as accurately as possible in the back-end. Since
9711 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9712 rules on how to prepare text for rich export. This section summarizes the
9713 markup rules used in an Org mode buffer.
9716 * Paragraphs:: The basic unit of text
9717 * Emphasis and monospace:: Bold, italic, etc.
9718 * Horizontal rules:: Make a line
9719 * Images and tables:: Images, tables and caption mechanism
9720 * Literal examples:: Source code examples with special formatting
9721 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9725 @section Paragraphs, line breaks, and quoting
9726 @cindex paragraphs, markup rules
9728 Paragraphs are separated by at least one empty line. If you need to enforce
9729 a line break within a paragraph, use @samp{\\} at the end of a line.
9731 To preserve the line breaks, indentation and blank lines in a region, but
9732 otherwise use normal formatting, you can use this construct, which can also
9733 be used to format poetry.
9735 @cindex #+BEGIN_VERSE
9736 @cindex verse blocks
9739 Great clouds overhead
9740 Tiny black birds rise and fall
9747 When quoting a passage from another document, it is customary to format this
9748 as a paragraph that is indented on both the left and the right margin. You
9749 can include quotations in Org mode documents like this:
9751 @cindex #+BEGIN_QUOTE
9752 @cindex quote blocks
9755 Everything should be made as simple as possible,
9756 but not any simpler -- Albert Einstein
9760 If you would like to center some text, do it like this:
9761 @cindex #+BEGIN_CENTER
9762 @cindex center blocks
9765 Everything should be made as simple as possible, \\
9770 @node Emphasis and monospace
9771 @section Emphasis and monospace
9773 @cindex underlined text, markup rules
9774 @cindex bold text, markup rules
9775 @cindex italic text, markup rules
9776 @cindex verbatim text, markup rules
9777 @cindex code text, markup rules
9778 @cindex strike-through text, markup rules
9779 @vindex org-fontify-emphasized-text
9780 @vindex org-emphasis-regexp-components
9781 @vindex org-emphasis-alist
9782 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9783 and @code{~code~}, and, if you must, @samp{+strike-through+}. Text
9784 in the code and verbatim string is not processed for Org mode specific
9785 syntax, it is exported verbatim.
9787 To turn off fontification for marked up text, you can set
9788 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9789 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9790 tune what characters are allowed before and after the markup characters, you
9791 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9792 the above variables will no take effect until you reload Org, for which you
9793 may need to restart Emacs.
9795 @node Horizontal rules
9796 @section Horizontal rules
9797 @cindex horizontal rules, markup rules
9798 A line consisting of only dashes, and at least 5 of them, will be exported as
9801 @node Images and tables
9802 @section Images and Tables
9804 @cindex tables, markup rules
9807 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9808 the @file{table.el} package will be exported properly. For Org mode tables,
9809 the lines before the first horizontal separator line will become table header
9810 lines. You can use the following lines somewhere before the table to assign
9811 a caption and a label for cross references, and in the text you can refer to
9812 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9815 #+CAPTION: This is the caption for the next table (or link)
9816 #+NAME: tab:basic-data
9821 Optionally, the caption can take the form:
9823 #+CAPTION[Caption for list of tables]: Caption for table.
9826 @cindex inlined images, markup rules
9827 Some back-ends allow you to directly include images into the exported
9828 document. Org does this, if a link to an image files does not have
9829 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9830 define a caption for the image and maybe a label for internal cross
9831 references, make sure that the link is on a line by itself and precede it
9832 with @code{#+CAPTION} and @code{#+NAME} as follows:
9835 #+CAPTION: This is the caption for the next figure link (or table)
9836 #+NAME: fig:SED-HR4049
9841 Such images can be displayed within the buffer. @xref{Handling links,the
9842 discussion of image links}.
9844 Even though images and tables are prominent examples of captioned structures,
9845 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9846 equations, source code blocks). Depending on the export back-end, those may
9847 or may not be handled.
9849 @node Literal examples
9850 @section Literal examples
9851 @cindex literal examples, markup rules
9852 @cindex code line references, markup rules
9854 You can include literal examples that should not be subjected to
9855 markup. Such examples will be typeset in monospace, so this is well suited
9856 for source code and similar examples.
9857 @cindex #+BEGIN_EXAMPLE
9861 Some example from a text file.
9865 Note that such blocks may be @i{indented} in order to align nicely with
9866 indented text and in particular with plain list structure (@pxref{Plain
9867 lists}). For simplicity when using small examples, you can also start the
9868 example lines with a colon followed by a space. There may also be additional
9869 whitespace before the colon:
9873 : Some example from a text file.
9876 @cindex formatting source code, markup rules
9877 @vindex org-latex-listings
9878 If the example is source code from a programming language, or any other text
9879 that can be marked up by font-lock in Emacs, you can ask for the example to
9880 look like the fontified Emacs buffer@footnote{This works automatically for
9881 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9882 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9883 achieved using either the
9884 @url{https://www.ctan.org/tex-archive/macros/latex/contrib/listings/?lang=en, listings,}
9886 @url{https://github.com/gpoore/minted, minted,} package.
9887 If you use minted or listing, you must load the packages manually, for
9888 example by adding the desired package to
9889 @code{org-latex-packages-alist}. Refer to @code{org-latex-listings}
9890 for details.}. This is done with the @samp{src} block, where you also need
9891 to specify the name of the major mode that should be used to fontify the
9892 example@footnote{Code in @samp{src} blocks may also be evaluated either
9893 interactively or on export. See @pxref{Working with source code} for more
9894 information on evaluating code blocks.}, see @ref{Easy templates} for
9895 shortcuts to easily insert code blocks.
9899 #+BEGIN_SRC emacs-lisp
9900 (defun org-xor (a b)
9906 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9907 switch to the end of the @code{BEGIN} line, to get the lines of the example
9908 numbered. The @code{-n} takes an optional numeric argument specifying the
9909 starting line number of the block. If you use a @code{+n} switch, the
9910 numbering from the previous numbered snippet will be continued in the current
9911 one. The @code{+n} can also take a numeric argument. The value of the
9912 argument will be added to the last line of the previous block to determine
9913 the starting line number.
9916 #+BEGIN_SRC emacs-lisp -n 20
9917 ;; this will export with line number 20
9918 (message "This is line 21")
9920 #+BEGIN_SRC emacs-lisp +n 10
9921 ;; This will be listed as line 31
9922 (message "This is line 32")
9926 In literal examples, Org will interpret strings like @samp{(ref:name)} as
9927 labels, and use them as targets for special hyperlinks like @code{[[(name)]]}
9928 (i.e., the reference name enclosed in single parenthesis). In HTML, hovering
9929 the mouse over such a link will remote-highlight the corresponding code line,
9930 which is kind of cool.
9932 You can also add a @code{-r} switch which @i{removes} the labels from the
9933 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9934 labels in the source code while using line numbers for the links, which might
9935 be useful to explain those in an Org mode example code.}. With the @code{-n}
9936 switch, links to these references will be labeled by the line numbers from
9937 the code listing, otherwise links will use the labels with no parentheses.
9941 #+BEGIN_SRC emacs-lisp -n -r
9942 (save-excursion (ref:sc)
9943 (goto-char (point-min))) (ref:jump)
9945 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9949 @cindex indentation, in source blocks
9950 Finally, you can use @code{-i} to preserve the indentation of a specific code
9951 block (@pxref{Editing source code}).
9953 @vindex org-coderef-label-format
9954 If the syntax for the label format conflicts with the language syntax, use a
9955 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9956 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9958 HTML export also allows examples to be published as text areas (@pxref{Text
9959 areas in HTML export}).
9961 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9962 so often, shortcuts are provided using the Easy templates facility
9963 (@pxref{Easy templates}).
9968 Edit the source code example at point in its native mode. This works by
9969 switching to a temporary buffer with the source code. You need to exit by
9970 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9971 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9972 from being interpreted by Org as outline nodes or special syntax. These
9973 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9974 The edited version will then replace the old version in the Org buffer.
9975 Fixed-width regions (where each line starts with a colon followed by a space)
9976 will be edited using @code{artist-mode}@footnote{You may select
9977 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9978 to allow creating ASCII drawings easily. Using this command in an empty line
9979 will create a new fixed-width region.
9982 Calling @code{org-store-link} while editing a source code example in a
9983 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9984 that it is unique in the current buffer, and insert it with the proper
9985 formatting like @samp{(ref:label)} at the end of the current line. Then the
9986 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9989 @node Embedded @LaTeX{}
9990 @section Embedded @LaTeX{}
9991 @cindex @TeX{} interpretation
9992 @cindex @LaTeX{} interpretation
9994 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9995 include scientific notes, which often require mathematical symbols and the
9996 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9997 Donald E. Knuth's @TeX{} system. Many of the features described here as
9998 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9999 distinction.} is widely used to typeset scientific documents. Org mode
10000 supports embedding @LaTeX{} code into its files, because many academics are
10001 used to writing and reading @LaTeX{} source code, and because it can be
10002 readily processed to produce pretty output for a number of export back-ends.
10005 * Special symbols:: Greek letters and other symbols
10006 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10007 * @LaTeX{} fragments:: Complex formulas made easy
10008 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10009 * CDLaTeX mode:: Speed up entering of formulas
10012 @node Special symbols
10013 @subsection Special symbols
10014 @cindex math symbols
10015 @cindex special symbols
10016 @cindex @TeX{} macros
10017 @cindex @LaTeX{} fragments, markup rules
10018 @cindex HTML entities
10019 @cindex @LaTeX{} entities
10021 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10022 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10023 for these symbols is available, just type @samp{\} and maybe a few letters,
10024 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10025 code, Org mode allows these symbols to be present without surrounding math
10026 delimiters, for example:
10029 Angles are written as Greek letters \alpha, \beta and \gamma.
10032 @vindex org-entities
10033 During export, these symbols will be transformed into the native format of
10034 the exporter back-end. Strings like @code{\alpha} will be exported as
10035 @code{α} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10036 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10037 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10038 like this: @samp{\Aacute@{@}stor}.
10040 A large number of entities is provided, with names taken from both HTML and
10041 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10042 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10043 @samp{...} are all converted into special commands creating hyphens of
10044 different lengths or a compact set of dots.
10046 If you would like to see entities displayed as UTF-8 characters, use the
10047 following command@footnote{You can turn this on by default by setting the
10048 variable @code{org-pretty-entities}, or on a per-file base with the
10049 @code{#+STARTUP} option @code{entitiespretty}.}:
10052 @cindex @code{entitiespretty}, STARTUP keyword
10055 Toggle display of entities as UTF-8 characters. This does not change the
10056 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10057 for display purposes only.
10060 @node Subscripts and superscripts
10061 @subsection Subscripts and superscripts
10063 @cindex superscript
10065 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10066 subscripts. Again, these can be used without embedding them in math-mode
10067 delimiters. To increase the readability of ASCII text, it is not necessary
10068 (but OK) to surround multi-character sub- and superscripts with curly braces.
10072 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10073 the sun is R_@{sun@} = 6.96 x 10^8 m.
10076 @vindex org-use-sub-superscripts
10077 If you write a text where the underscore is often used in a different
10078 context, Org's convention to always interpret these as subscripts can get in
10079 your way. Configure the variable @code{org-use-sub-superscripts} to change
10080 this convention. For example, when setting this variable to @code{@{@}},
10081 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10086 In addition to showing entities as UTF-8 characters, this command will also
10087 format sub- and superscripts in a WYSIWYM way.
10090 @node @LaTeX{} fragments
10091 @subsection @LaTeX{} fragments
10092 @cindex @LaTeX{} fragments
10094 @vindex org-format-latex-header
10095 Going beyond symbols and sub- and superscripts, a full formula language is
10096 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10097 to process these for several export back-ends. When exporting to @LaTeX{},
10098 the code is left as it is. When exporting to HTML, Org can use either
10099 @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML
10100 export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
10103 @LaTeX{} fragments don't need any special marking at all. The following
10104 snippets will be identified as @LaTeX{} source code:
10107 Environments of any kind@footnote{When MathJax is used, only the
10108 environments recognized by MathJax will be processed. When
10109 @file{dvipng} program, @file{dvisvgm} program or @file{imagemagick} suite is
10110 used to create images, any @LaTeX{} environment will be handled.}. The only
10111 requirement is that the @code{\begin} statement appears on a new line, at the
10112 beginning of the line or after whitespaces only.
10114 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10115 currency specifications, single @samp{$} characters are only recognized as
10116 math delimiters if the enclosed text contains at most two line breaks, is
10117 directly attached to the @samp{$} characters with no whitespace in between,
10118 and if the closing @samp{$} is followed by whitespace or punctuation
10119 (parentheses and quotes are considered to be punctuation in this
10120 context). For the other delimiters, there is no such restriction, so when in
10121 doubt, use @samp{\(...\)} as inline math delimiters.
10124 @noindent For example:
10131 If $a^2=b$ and \( b=2 \), then the solution must be
10132 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10137 @c @vindex org-format-latex-options
10138 @c If you need any of the delimiter ASCII sequences for other purposes, you
10139 @c can configure the option @code{org-format-latex-options} to deselect the
10140 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10142 @vindex org-export-with-latex
10143 @LaTeX{} processing can be configured with the variable
10144 @code{org-export-with-latex}. The default setting is @code{t} which means
10145 MathJax for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10146 You can also set this variable on a per-file basis using one of these
10150 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10151 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10152 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10155 @node Previewing @LaTeX{} fragments
10156 @subsection Previewing @LaTeX{} fragments
10157 @cindex @LaTeX{} fragments, preview
10159 @vindex org-preview-latex-default-process
10160 If you have a working @LaTeX{} installation and @file{dvipng}, @file{dvisvgm}
10161 or @file{convert} installed@footnote{These are respectively available at
10162 @url{http://sourceforge.net/projects/dvipng/}, @url{http://dvisvgm.bplaced.net/}
10163 and from the @file{imagemagick} suite. Choose the converter by setting the
10164 variable @code{org-preview-latex-default-process} accordingly.}, @LaTeX{}
10165 fragments can be processed to produce images of the typeset expressions to be
10166 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10167 or for inline previewing within Org mode.
10169 @vindex org-format-latex-options
10170 @vindex org-format-latex-header
10171 You can customize the variables @code{org-format-latex-options} and
10172 @code{org-format-latex-header} to influence some aspects of the preview. In
10173 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10174 property of the former can be used to adjust the size of the preview images.
10177 @kindex C-c C-x C-l
10179 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10180 over the source code. If there is no fragment at point, process all
10181 fragments in the current entry (between two headlines). When called
10182 with a prefix argument, process the entire subtree. When called with
10183 two prefix arguments, or when the cursor is before the first headline,
10184 process the entire buffer.
10187 Remove the overlay preview images.
10190 @vindex org-startup-with-latex-preview
10191 You can turn on the previewing of all @LaTeX{} fragments in a file with
10194 #+STARTUP: latexpreview
10197 To disable it, simply use
10200 #+STARTUP: nolatexpreview
10204 @subsection Using CD@LaTeX{} to enter math
10207 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10208 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10209 environments and math templates. Inside Org mode, you can make use of
10210 some of the features of CD@LaTeX{} mode. You need to install
10211 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10212 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10213 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10214 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10215 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10219 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10222 When this mode is enabled, the following features are present (for more
10223 details see the documentation of CD@LaTeX{} mode):
10227 Environment templates can be inserted with @kbd{C-c @{}.
10230 The @key{TAB} key will do template expansion if the cursor is inside a
10231 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10232 inside such a fragment, see the documentation of the function
10233 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10234 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10235 correctly inside the first brace. Another @key{TAB} will get you into
10236 the second brace. Even outside fragments, @key{TAB} will expand
10237 environment abbreviations at the beginning of a line. For example, if
10238 you write @samp{equ} at the beginning of a line and press @key{TAB},
10239 this abbreviation will be expanded to an @code{equation} environment.
10240 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10244 @vindex cdlatex-simplify-sub-super-scripts
10245 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10246 characters together with a pair of braces. If you use @key{TAB} to move
10247 out of the braces, and if the braces surround only a single character or
10248 macro, they are removed again (depending on the variable
10249 @code{cdlatex-simplify-sub-super-scripts}).
10252 Pressing the grave accent @kbd{`} followed by a character inserts math
10253 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10254 after the grave accent, a help window will pop up.
10257 Pressing the apostrophe @kbd{'} followed by another character modifies
10258 the symbol before point with an accent or a font. If you wait more than
10259 1.5 seconds after the apostrophe, a help window will pop up. Character
10260 modification will work only inside @LaTeX{} fragments; outside the quote
10268 Sometimes, you may want to pretty print your notes, publish them on the web
10269 or even share them with people not using Org. In these cases, the Org export
10270 facilities can be used to convert your documents to a variety of other
10271 formats, while retaining as much structure (@pxref{Document structure}) and
10272 markup (@pxref{Markup}) as possible.
10274 @cindex export back-end
10275 Libraries responsible for such translation are called back-ends. Org ships
10276 with the following ones
10279 @item ascii (ASCII format)
10280 @item beamer (@LaTeX{} Beamer format)
10281 @item html (HTML format)
10282 @item icalendar (iCalendar format)
10283 @item latex (@LaTeX{} format)
10284 @item md (Markdown format)
10285 @item odt (OpenDocument Text format)
10286 @item org (Org format)
10287 @item texinfo (Texinfo format)
10288 @item man (Man page format)
10291 @noindent More of them can be found in the @code{contrib/} directory
10292 (@pxref{Installation}) or through the Emacs packaging system@footnote{These
10293 libraries traditionnaly appear as @file{ox-NAME}, e.g., @file{ox-koma-letter}
10294 for @code{koma-letter} back-end.}.
10296 @vindex org-export-backends
10297 By default, the following five back-ends are loaded: @code{ascii},
10298 @code{html}, @code{icalendar}, @code{latex} and @code{odt}. Others need to
10299 be specifically loaded, either by customizing @code{org-export-backends}, or
10300 by requiring the associated library, e.g.,
10306 Eventually, you can these facilities can be used with @code{orgtbl-mode} or
10307 @code{orgstruct-mode} in foreign buffers so you can author tables and lists
10308 in Org syntax and convert them in place to the target language.
10311 * The export dispatcher:: The main exporter interface
10312 * Export settings:: Generic export settings
10313 * Table of contents:: The if and where of the table of contents
10314 * Include files:: Include additional files into a document
10315 * Macro replacement:: Use macros to create templates
10316 * Comment lines:: What will not be exported
10317 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10318 * Beamer export:: Exporting as a Beamer presentation
10319 * HTML export:: Exporting to HTML
10320 * @LaTeX{} export:: Exporting to @LaTeX{}, and processing to PDF
10321 * Markdown export:: Exporting to Markdown
10322 * OpenDocument Text export:: Exporting to OpenDocument Text
10323 * Org export:: Exporting to Org
10324 * Texinfo export:: Exporting to Texinfo
10325 * iCalendar export:: Exporting to iCalendar
10326 * Other built-in back-ends:: Exporting to a man page
10327 * Advanced configuration:: Fine-tuning the export output
10328 * Export in foreign buffers:: Author tables and lists in Org syntax
10331 @node The export dispatcher
10332 @section The export dispatcher
10333 @vindex org-export-dispatch-use-expert-ui
10334 @cindex Export, dispatcher
10336 The main entry point for export related tasks is the dispatcher, a
10337 hierarchical menu from which it is possible to select an export format and
10338 toggle export options@footnote{It is also possible to use a less intrusive
10339 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10340 non-@code{nil} value. In that case, only a prompt is visible from the
10341 minibuffer. From there one can still switch back to regular menu by pressing
10345 @orgcmd{C-c C-e,org-export-dispatch}
10347 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10348 prefix argument, repeat the last export command on the current buffer while
10349 preserving toggled options. If the current buffer hasn't changed and subtree
10350 export was activated, the command will affect that same subtree.
10353 Normally the entire buffer is exported, but if there is an active region
10354 only that part of the buffer will be exported.
10356 Several export options (@pxref{Export settings}) can be toggled from the
10357 export dispatcher with the following key combinations:
10361 @vindex org-export-async-init-file
10362 Toggle asynchronous export. Asynchronous export uses an external Emacs
10363 process that is configured with a specified initialization file.
10365 While exporting asynchronously, the output is not displayed, but stored in
10366 a place called ``the export stack''. This stack can be displayed by calling
10367 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10368 from the dispatcher menu.
10370 @vindex org-export-in-background
10371 To make this behavior the default, customize the variable
10372 @code{org-export-in-background}.
10375 Toggle body-only export. Its effect depends on the back-end used.
10376 Typically, if the back-end has a header section (like @code{<head>...</head>}
10377 in the HTML back-end), a body-only export will not include this header.
10380 @vindex org-export-initial-scope
10381 Toggle subtree export. The top heading becomes the document title.
10383 You can change the default state of this option by setting
10384 @code{org-export-initial-scope}.
10387 Toggle visible-only export. Only export the text that is currently
10388 visible, i.e., not hidden by outline visibility in the buffer.
10391 @node Export settings
10392 @section Export settings
10393 @cindex Export, settings
10396 Export options can be set: globally with variables; for an individual file by
10397 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10398 settings}), by setting individual keywords, or by specifying them in a
10399 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10400 properties (@pxref{Properties and columns}). Options set at a specific level
10401 override options set at a more general level.
10403 @cindex #+SETUPFILE
10404 In-buffer settings may appear anywhere in the file, either directly or
10405 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10406 Option keyword sets tailored to a particular back-end can be inserted from
10407 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10408 template} command by pressing @key{#}. To insert keywords individually,
10409 a good way to make sure the keyword is correct is to type @code{#+} and then
10410 to use @kbd{M-<TAB>} for completion.
10412 The export keywords available for every back-end, and their equivalent global
10413 variables, include:
10418 @vindex user-full-name
10419 The document author (@code{user-full-name}).
10423 @vindex org-export-creator-string
10424 Entity responsible for output generation (@code{org-export-creator-string}).
10428 @vindex org-export-date-timestamp-format
10429 A date or a time-stamp@footnote{The variable
10430 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10435 @vindex user-mail-address
10436 The email address (@code{user-mail-address}).
10440 @vindex org-export-default-language
10441 The language used for translating some strings
10442 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10443 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10447 @cindex #+SELECT_TAGS
10448 @vindex org-export-select-tags
10449 The tags that select a tree for export (@code{org-export-select-tags}). The
10450 default value is @code{:export:}. Within a subtree tagged with
10451 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10452 below). When headlines are selectively exported with @code{:export:}
10453 anywhere in a file, text before the first headline is ignored.
10456 @cindex #+EXCLUDE_TAGS
10457 @vindex org-export-exclude-tags
10458 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10459 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10460 tag will be unconditionally excluded from the export, even if they have an
10461 @code{:export:} tag. Code blocks contained in excluded subtrees will still
10462 be executed during export even though the subtree is not exported.
10466 @cindex document title
10467 The title to be shown. You can use several such keywords for long titles.
10470 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10471 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10472 recognizes the following arguments:
10476 @vindex org-export-with-smart-quotes
10477 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10480 Toggle emphasized text (@code{org-export-with-emphasize}).
10483 @vindex org-export-with-special-strings
10484 Toggle conversion of special strings
10485 (@code{org-export-with-special-strings}).
10488 @vindex org-export-with-fixed-width
10489 Toggle fixed-width sections
10490 (@code{org-export-with-fixed-width}).
10493 @vindex org-export-with-timestamps
10494 Toggle inclusion of any time/date active/inactive stamps
10495 (@code{org-export-with-timestamps}).
10498 @vindex org-export-preserve-breaks
10499 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10502 @vindex org-export-with-sub-superscripts
10503 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10504 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10505 it is (@code{org-export-with-sub-superscripts}).
10508 @vindex org-export-with-archived-trees
10509 Configure export of archived trees. Can be set to @code{headline} to only
10510 process the headline, skipping its contents
10511 (@code{org-export-with-archived-trees}).
10514 @vindex org-export-with-author
10515 Toggle inclusion of author name into exported file
10516 (@code{org-export-with-author}).
10518 @item broken-links:
10519 @vindex org-export-with-broken-links
10520 Decide whether to raise an error or not when encountering a broken internal
10521 link. When set to @code{mark}, signal the problem clearly in the output
10522 (@code{org-export-with-broken-links}).
10525 @vindex org-export-with-clocks
10526 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10529 @vindex org-export-with-creator
10530 Toggle inclusion of creator info into exported file
10531 (@code{org-export-with-creator}).
10534 @vindex org-export-with-drawers
10535 Toggle inclusion of drawers, or list drawers to include
10536 (@code{org-export-with-drawers}).
10539 @vindex org-export-with-date
10540 Toggle inclusion of a date into exported file (@code{org-export-with-date}).
10543 @vindex org-export-with-entities
10544 Toggle inclusion of entities (@code{org-export-with-entities}).
10547 @vindex org-export-with-email
10548 Toggle inclusion of the author's e-mail into exported file
10549 (@code{org-export-with-email}).
10552 @vindex org-export-with-footnotes
10553 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10556 @vindex org-export-headline-levels
10557 Set the number of headline levels for export
10558 (@code{org-export-headline-levels}). Below that level, headlines are treated
10559 differently. In most back-ends, they become list items.
10562 @vindex org-export-with-inlinetasks
10563 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10566 @vindex org-export-with-section-numbers
10567 @cindex property, UNNUMBERED
10568 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10569 be set to a number @samp{n}, so only headlines at that level or above will be
10570 numbered. Finally, irrespective of the level of a specific headline, the
10571 numbering of it can be disabled by setting the @code{UNNUMBERED} property to
10572 non-@code{nil}. This also affects subheadings.
10575 @vindex org-export-with-planning
10576 Toggle export of planning information (@code{org-export-with-planning}).
10577 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10578 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10581 @vindex org-export-with-priority
10582 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10585 @vindex org-export-with-properties
10586 Toggle inclusion of property drawers, or list properties to include
10587 (@code{org-export-with-properties}).
10590 @vindex org-export-with-statistics-cookies
10591 Toggle inclusion of statistics cookies
10592 (@code{org-export-with-statistics-cookies}).
10595 @vindex org-export-with-tags
10596 Toggle inclusion of tags, may also be @code{not-in-toc}
10597 (@code{org-export-with-tags}).
10600 @vindex org-export-with-tasks
10601 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10602 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10603 (@code{org-export-with-tasks}).
10606 @vindex org-export-with-latex
10607 Configure export of @LaTeX{} fragments and environments. It may be set to
10608 @code{verbatim} (@code{org-export-with-latex}).
10611 @vindex org-export-time-stamp-file
10612 Toggle inclusion of the creation time into exported file
10613 (@code{org-export-time-stamp-file}).
10616 @vindex org-export-with-title
10617 Toggle inclusion of title (@code{org-export-with-title}).
10620 @vindex org-export-with-toc
10621 Toggle inclusion of the table of contents, or set the level limit
10622 (@code{org-export-with-toc}).
10625 @vindex org-export-with-todo-keywords
10626 Toggle inclusion of TODO keywords into exported text
10627 (@code{org-export-with-todo-keywords}).
10630 @vindex org-export-with-tables
10631 Toggle inclusion of tables (@code{org-export-with-tables}).
10635 When exporting only a subtree, each of the previous keywords@footnote{With
10636 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10637 properties. These begin with @samp{EXPORT_}, followed by the name of the
10638 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10639 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10643 @vindex org-export-allow-bind-keywords
10644 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10645 can become buffer-local during export by using the BIND keyword. Its syntax
10646 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10647 settings that cannot be changed using specific keywords.
10649 @cindex property, EXPORT_FILE_NAME
10650 The name of the output file to be generated is taken from the file associated
10651 to the buffer, when possible, or asked to you otherwise. For subtree export,
10652 you can also set @code{EXPORT_FILE_NAME} property. In all cases, only the
10653 base name of the file is retained, and a back-end specific extension is
10656 @node Table of contents
10657 @section Table of contents
10658 @cindex table of contents
10659 @cindex list of tables
10660 @cindex list of listings
10663 @vindex org-export-with-toc
10664 The table of contents is normally inserted directly before the first headline
10665 of the file. The depth of the table is by default the same as the number of
10666 headline levels, but you can choose a smaller number, or turn off the table
10667 of contents entirely, by configuring the variable @code{org-export-with-toc},
10668 or on a per-file basis with a line like
10671 #+OPTIONS: toc:2 @r{only inlcude two levels in TOC}
10672 #+OPTIONS: toc:nil @r{no default TOC at all}
10675 If you would like to move the table of contents to a different location, you
10676 should turn off the default table using @code{org-export-with-toc} or
10677 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
10681 #+OPTIONS: toc:nil @r{no default TOC}
10683 #+TOC: headlines 2 @r{insert TOC here, with two headline levels}
10686 Moreover, if you append @samp{local} parameter, the table contains only
10687 entries for the children of the current section@footnote{For @LaTeX{} export,
10688 this feature requires the @code{titletoc} package. Note that @code{titletoc}
10689 must be loaded @emph{before} @code{hyperref}. Thus, you may have to
10690 customize @code{org-latex-default-packages-alist}.}. In this case, any depth
10691 parameter becomes relative to the current level.
10695 #+TOC: headlines 1 local @r{insert local TOC, with direct children only}
10698 The same @code{TOC} keyword can also generate a list of all tables (resp.@:
10699 all listings) with a caption in the document.
10702 #+TOC: listings @r{build a list of listings}
10703 #+TOC: tables @r{build a list of tables}
10706 @cindex property, ALT_TITLE
10707 The headline's title usually determines its corresponding entry in a table of
10708 contents. However, it is possible to specify an alternative title by
10709 setting @code{ALT_TITLE} property accordingly. It will then be used when
10710 building the table.
10712 @node Include files
10713 @section Include files
10714 @cindex include files, during export
10716 During export, you can include the content of another file. For example, to
10717 include your @file{.emacs} file, you could use:
10721 #+INCLUDE: "~/.emacs" src emacs-lisp
10725 The first parameter names the the file to include. The optional second and
10726 third parameter specify the markup (i.e., @samp{example}, @samp{export} or
10727 @samp{src}), and, if the markup is either @samp{export} or @samp{src}, the
10728 language for formatting the contents.
10730 If markup is requested, the included content will be placed within an
10731 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10732 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10733 of content that is permissible}. No changes to the included content are made
10734 and it is the responsibility of the user to ensure that the result is valid
10735 Org syntax. For markup @samp{example} and @samp{src}, which is requesting a
10736 literal example, the content will be code-escaped before inclusion.
10738 If no markup is requested, the text will be assumed to be in Org mode format
10739 and will be processed normally. However, footnote labels (@pxref{Footnotes})
10740 in the file will be made local to that file. Contents of the included file
10741 will belong to the same structure (headline, item) containing the
10742 @code{INCLUDE} keyword. In particular, headlines within the file will become
10743 children of the current section. That behavior can be changed by providing
10744 an additional keyword parameter, @code{:minlevel}. In that case, all
10745 headlines in the included file will be shifted so the one with the lowest
10746 level reaches that specified level. For example, to make a file become a
10747 sibling of the current top-level headline, use
10750 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10753 You can also include a portion of a file by specifying a lines range using
10754 the @code{:lines} keyword parameter. The line at the upper end of the range
10755 will not be included. The start and/or the end of the range may be omitted
10756 to use the obvious defaults.
10759 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
10760 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
10761 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
10764 Finally, you may use a file-link to extract an object as matched by
10765 @code{org-link-search}@footnote{Note that
10766 @code{org-link-search-must-match-exact-headline} is locally bound to non-@code{nil}.
10767 Therefore, @code{org-link-search} only matches headlines and named elements.}
10768 (@pxref{Search options}). If the @code{:only-contents} property is non-@code{nil},
10769 only the contents of the requested element will be included, omitting
10770 properties drawer and planning-line if present. The @code{:lines} keyword
10771 operates locally with respect to the requested element. Some examples:
10774 #+INCLUDE: "./paper.org::#theory" :only-contents t
10775 @r{Include the body of the heading with the custom id @samp{theory}}
10776 #+INCLUDE: "./paper.org::mytable" @r{Include named element.}
10777 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10778 @r{Include the first 20 lines of the headline named @samp{conclusion}.}
10784 Visit the include file at point.
10787 @node Macro replacement
10788 @section Macro replacement
10789 @cindex macro replacement, during export
10792 You can define text snippets with
10795 #+MACRO: name replacement text $1, $2 are arguments
10798 @noindent which can be referenced
10799 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10800 commas within arguments have to be escaped with a backslash character.
10801 Conversely, backslash characters before a comma, and only them, need to be
10802 escaped with another backslash character.}.
10804 These references, called macros, can be inserted anywhere Org markup is
10805 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10806 They can also be used in keywords accepting Org syntax, e.g.,
10807 @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR}, @code{#+DATE} and some
10808 others, export back-end specific, ones.
10810 In addition to user-defined macros, a set of predefined macros can be used:
10813 @item @{@{@{title@}@}@}
10814 @itemx @{@{@{author@}@}@}
10815 @itemx @{@{@{email@}@}@}
10816 @cindex title, macro
10817 @cindex author, macro
10818 @cindex email, macro
10819 These macros are replaced with the information available at the time of
10822 @item @{@{@{date@}@}@}
10823 @itemx @{@{@{date(@var{FORMAT})@}@}@}
10824 @cindex date, macro
10825 This macro refers to the @code{#+DATE} keyword. @var{FORMAT} is an optional
10826 argument to the @code{@{@{@{date@}@}@}} macro that will be used only if
10827 @code{#+DATE} is a single timestamp. @var{FORMAT} should be a format string
10828 understood by @code{format-time-string}.
10830 @item @{@{@{time(@var{FORMAT})@}@}@}
10831 @itemx @{@{@{modification-time(@var{FORMAT}, @var{VC})@}@}@}
10832 @cindex time, macro
10833 @cindex modification time, macro
10834 These macros refer to the date and time when the document is exported and to
10835 the modification date and time, respectively. @var{FORMAT} should be a
10836 format string understood by @code{format-time-string}. If the second
10837 argument to the @code{modification-time} macro is non-@code{nil}, Org
10838 retrieves the information from the version control system, using
10839 @file{vc.el}, instead of the file attributes.
10841 @item @{@{@{input-file@}@}@}
10842 @cindex input file, macro
10843 This macro refers to the filename of the exported file, if any.
10845 @item @{@{@{property(@var{PROPERTY-NAME})@}@}@}
10846 @itemx @{@{@{property(@var{PROPERTY-NAME},@var{SEARCH-OPTION})@}@}@}
10847 @cindex property, macro
10848 This macro returns the value of property @var{PROPERTY-NAME} in current
10849 entry. If @var{SEARCH-OPTION} (@pxref{Search options}) refers to a remote
10850 entry, it will be used instead.
10853 The surrounding brackets can be made invisible by setting
10854 @code{org-hide-macro-markers} non-@code{nil}.
10856 Macro expansion takes place during the very beginning of the export process.
10858 @node Comment lines
10859 @section Comment lines
10860 @cindex comment lines
10861 @cindex exporting, not
10862 @cindex #+BEGIN_COMMENT
10864 Lines starting with zero or more whitespace characters followed by one
10865 @samp{#} and a whitespace are treated as comments and, as such, are not
10868 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
10869 ... @samp{#+END_COMMENT} are not exported.
10871 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
10872 other keyword or priority cookie, comments out the entire subtree. In this
10873 case, the subtree is not exported and no code block within it is executed
10874 either@footnote{For a less drastic behavior, consider using a select tag
10875 (@pxref{Export settings}) instead.}. The command below helps changing the
10876 comment status of a headline.
10881 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
10884 @node ASCII/Latin-1/UTF-8 export
10885 @section ASCII/Latin-1/UTF-8 export
10886 @cindex ASCII export
10887 @cindex Latin-1 export
10888 @cindex UTF-8 export
10890 ASCII export produces a simple and very readable version of an Org mode
10891 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10892 with special characters and symbols available in these encodings.
10894 @vindex org-ascii-text-width
10895 Upon exporting, text is filled and justified, when appropriate, according the
10896 text width set in @code{org-ascii-text-width}.
10898 @vindex org-ascii-links-to-notes
10899 Links are exported in a footnote-like style, with the descriptive part in the
10900 text and the link in a note before the next heading. See the variable
10901 @code{org-ascii-links-to-notes} for details and other options.
10903 @subheading ASCII export commands
10906 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10907 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10908 will be @file{myfile.txt}. The file will be overwritten without warning.
10909 When the original file is @file{myfile.txt}, the resulting file becomes
10910 @file{myfile.txt.txt} in order to prevent data loss.
10911 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10912 Export to a temporary buffer. Do not create a file.
10915 @subheading ASCII specific export settings
10917 ASCII export introduces a single of keywords, similar to the general options
10918 settings described in @ref{Export settings}.
10922 @cindex #+SUBTITLE (ASCII)
10923 The document subtitle.
10926 @subheading Header and sectioning structure
10928 In the exported version, the first three outline levels become headlines,
10929 defining a general document structure. Additional levels are exported as
10930 lists. The transition can also occur at a different level (@pxref{Export
10933 @subheading Quoting ASCII text
10935 You can insert text that will only appear when using @code{ASCII} back-end
10936 with the following constructs:
10939 @cindex #+BEGIN_EXPORT ascii
10941 Text @@@@ascii:and additional text@@@@ within a paragraph.
10945 #+BEGIN_EXPORT ascii
10946 All lines in this block will appear only when using this back-end.
10950 @subheading ASCII specific attributes
10951 @cindex #+ATTR_ASCII
10952 @cindex horizontal rules, in ASCII export
10954 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10955 specifies the length, in characters, of a given horizontal rule. It must be
10956 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10959 #+ATTR_ASCII: :width 10
10963 @subheading ASCII special blocks
10964 @cindex special blocks, in ASCII export
10965 @cindex #+BEGIN_JUSTIFYLEFT
10966 @cindex #+BEGIN_JUSTIFYRIGHT
10968 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
10969 possible to justify contents to the left or the right of the page with the
10970 following dedicated blocks.
10973 #+BEGIN_JUSTIFYLEFT
10974 It's just a jump to the left...
10977 #+BEGIN_JUSTIFYRIGHT
10978 ...and then a step to the right.
10982 @node Beamer export
10983 @section Beamer export
10984 @cindex Beamer export
10986 The @LaTeX{} class @emph{Beamer} allows production of high quality
10987 presentations using @LaTeX{} and PDF processing. Org mode has special
10988 support for turning an Org mode file or tree into a Beamer presentation.
10991 * Beamer export commands:: How to export Beamer documents.
10992 * Beamer specific export settings:: Export settings for Beamer export.
10993 * Sectioning Frames and Blocks in Beamer:: Blocks and sections in Beamer.
10994 * Beamer specific syntax:: Syntax specific to Beamer.
10995 * Editing support:: Helper functions for Org Beamer export.
10996 * A Beamer Example:: An complete Beamer example.
10999 @node Beamer export commands
11000 @subsection Beamer export commands
11003 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
11004 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11005 file will be @file{myfile.tex}. The file will be overwritten without
11007 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
11008 Export to a temporary buffer. Do not create a file.
11009 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
11010 Export as @LaTeX{} and then process to PDF.
11012 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11015 @node Beamer specific export settings
11016 @subsection Beamer specific export settings
11018 Beamer export introduces a number of keywords, similar to the general options
11019 settings described in @ref{Export settings}.
11023 @cindex #+BEAMER_THEME
11024 @vindex org-beamer-theme
11025 The Beamer theme (@code{org-beamer-theme}). Options can be specified via
11026 brackets, for example:
11028 #+BEAMER_THEME: Rochester [height=20pt]
11031 @item BEAMER_FONT_THEME
11032 @cindex #+BEAMER_FONT_THEME
11033 The Beamer font theme.
11035 @item BEAMER_INNER_THEME
11036 @cindex #+BEAMER_INNER_THEME
11037 The Beamer inner theme.
11039 @item BEAMER_OUTER_THEME
11040 @cindex #+BEAMER_OUTER_THEME
11041 The Beamer outer theme.
11043 @item BEAMER_HEADER
11044 @cindex #+BEAMER_HEADER
11045 Arbitrary lines inserted into the preamble, just before the @samp{hyperref}
11049 @cindex #+DESCRIPTION (Beamer)
11050 The document description. By default these are inserted as metadata using
11051 @samp{hyperref}. Document metadata can be configured via
11052 @code{org-latex-hyperref-template}. Description can also be typeset as part
11053 of the front matter via @code{org-latex-title-command}. You can use several
11054 @code{#+DESCRIPTION} keywords if the description is is long.
11057 @cindex #+KEYWORDS (Beamer)
11058 The keywords defining the contents of the document. By default these are
11059 inserted as metadata using @samp{hyperref}. Document metadata can be
11060 configured via @code{org-latex-hyperref-template}. Description can also be
11061 typeset as part of the front matter via @code{org-latex-title-command}. You
11062 can use several @code{#+KEYWORDS} if the description is is long.
11065 @cindex #+SUBTITLE (Beamer)
11066 @vindex org-beamer-subtitle-format
11067 The document subtitle. This is typeset using the format string
11068 @code{org-beamer-subtitle-format}. It can also access via
11069 @code{org-latex-hyperref-template} or typeset as part of the front
11070 matter via @code{org-latex-title-command}.
11073 @node Sectioning Frames and Blocks in Beamer
11074 @subsection Sectioning, Frames and Blocks in Beamer
11076 Any tree with not-too-deep level nesting should in principle be exportable as
11077 a Beamer presentation. Headlines fall into three categories: sectioning
11078 elements, frames and blocks.
11082 @vindex org-beamer-frame-level
11083 Headlines become frames when their level is equal to
11084 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
11085 (@pxref{Export settings}).
11087 @cindex property, BEAMER_ENV
11088 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
11089 set to either to @code{frame} or @code{fullframe}, its level overrides the
11090 variable. A @code{fullframe} is a frame with an empty (ignored) title.
11093 @vindex org-beamer-environments-default
11094 @vindex org-beamer-environments-extra
11095 All frame's children become @code{block} environments. Special block types
11096 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
11097 this property is set, the entry will also get a @code{:B_environment:} tag to
11098 make this visible. This tag has no semantic meaning, it is only a visual
11099 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
11100 supported values and @code{org-beamer-environments-extra} for adding more).
11103 @cindex property, BEAMER_REF
11104 As a special case, if the @code{BEAMER_ENV} property is set to either
11105 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
11106 headline will become, respectively, an appendix, a note (within frame or
11107 between frame, depending on its level), a note with its title ignored or an
11108 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
11109 is mandatory in order to refer to the frame being resumed, and contents are
11112 Also, a headline with an @code{ignoreheading} environment will have its
11113 contents only inserted in the output. This special value is useful to have
11114 data between frames, or to properly close a @code{column} environment.
11117 @cindex property, BEAMER_ACT
11118 @cindex property, BEAMER_OPT
11119 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
11120 The former is translated as an overlay/action specification, or a default
11121 overlay specification when enclosed within square brackets. The latter
11122 specifies options@footnote{The @code{fragile} option is added automatically
11123 if it contains code that requires a verbatim environment, though.} for the
11124 current frame or block. The export back-end will automatically wrap
11125 properties within angular or square brackets when appropriate.
11127 @cindex property, BEAMER_COL
11128 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
11129 be a decimal number representing the width of the column as a fraction of the
11130 total text width. If the headline has no specific environment, its title
11131 will be ignored and its contents will fill the column created. Otherwise,
11132 the block will fill the whole column and the title will be preserved. Two
11133 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
11134 @code{columns} @LaTeX{} environment. It will end before the next headline
11135 without such a property. This environment is generated automatically.
11136 Although, it can also be explicitly created, with a special @code{columns}
11137 value for @code{BEAMER_ENV} property (if it needs to be set up with some
11138 specific options, for example).
11140 @node Beamer specific syntax
11141 @subsection Beamer specific syntax
11143 The Beamer back-end is an extension of the @LaTeX{} back-end. As such, all
11144 @LaTeX{} specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
11145 recognized. See @ref{@LaTeX{} export} for more information.
11147 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11148 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
11149 keyword (@pxref{Table of contents}) are not. In that case, it is also
11150 possible to specify options, enclosed within square brackets.
11153 #+TOC: headlines [currentsection]
11156 Beamer specific code can be inserted with the following constructs:
11159 @cindex #+BEGIN_EXPORT beamer
11163 #+BEGIN_EXPORT beamer
11164 All lines in this block will appear only when using this back-end.
11167 Text @@@@beamer:some code@@@@ within a paragraph.
11170 In particular, this last example can be used to add overlay specifications to
11171 objects whose type is among @code{bold}, @code{item}, @code{link},
11172 @code{radio-target} and @code{target}, when the value is enclosed within
11173 angular brackets and put at the beginning the object.
11176 A *@@@@beamer:<2->@@@@useful* feature
11179 @cindex #+ATTR_BEAMER
11180 Eventually, every plain list has support for @code{:environment},
11181 @code{:overlay} and @code{:options} attributes through
11182 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
11183 of a different environment, the second sets overlay specifications and
11184 the last one inserts optional arguments in current list environment.
11187 #+ATTR_BEAMER: :overlay +-
11192 @node Editing support
11193 @subsection Editing support
11195 You can turn on a special minor mode @code{org-beamer-mode} for faster
11203 @orgcmd{C-c C-b,org-beamer-select-environment}
11204 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11205 environment or the @code{BEAMER_COL} property.
11208 @node A Beamer Example
11209 @subsection A Beamer example
11211 Here is a simple example Org document that is intended for Beamer export.
11214 #+TITLE: Example Presentation
11215 #+AUTHOR: Carsten Dominik
11216 #+OPTIONS: H:2 toc:t num:t
11217 #+LATEX_CLASS: beamer
11218 #+LATEX_CLASS_OPTIONS: [presentation]
11219 #+BEAMER_THEME: Madrid
11220 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11222 * This is the first structural section
11225 *** Thanks to Eric Fraga :B_block:
11230 for the first viable Beamer setup in Org
11231 *** Thanks to everyone else :B_block:
11237 for contributing to the discussion
11238 **** This will be formatted as a beamer note :B_note:
11242 ** Frame 2 (where we will not use columns)
11244 Please test this stuff!
11248 @section HTML export
11249 @cindex HTML export
11251 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11252 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11253 language, but with additional support for tables.
11256 * HTML Export commands:: How to invoke HTML export
11257 * HTML Specific export settings:: Export settings for HTML export
11258 * HTML doctypes:: Org can export to various (X)HTML flavors
11259 * HTML preamble and postamble:: How to insert a preamble and a postamble
11260 * Quoting HTML tags:: Using direct HTML in Org mode
11261 * Links in HTML export:: How links will be interpreted and formatted
11262 * Tables in HTML export:: How to modify the formatting of tables
11263 * Images in HTML export:: How to insert figures into HTML output
11264 * Math formatting in HTML export:: Beautiful math also on the web
11265 * Text areas in HTML export:: An alternative way to show an example
11266 * CSS support:: Changing the appearance of the output
11267 * JavaScript support:: Info and Folding in a web browser
11271 @node HTML Export commands
11272 @subsection HTML export commands
11275 @orgcmd{C-c C-e h h,org-html-export-to-html}
11276 Export as an HTML file. For an Org file @file{myfile.org},
11277 the HTML file will be @file{myfile.html}. The file will be overwritten
11280 Export as an HTML file and immediately open it with a browser.
11281 @orgcmd{C-c C-e h H,org-html-export-as-html}
11282 Export to a temporary buffer. Do not create a file.
11285 @c FIXME Exporting sublevels
11286 @c @cindex headline levels, for exporting
11287 @c In the exported version, the first 3 outline levels will become headlines,
11288 @c defining a general document structure. Additional levels will be exported as
11289 @c itemized lists. If you want that transition to occur at a different level,
11290 @c specify it with a numeric prefix argument. For example,
11293 @c @kbd{C-2 C-c C-e b}
11297 @c creates two levels of headings and does the rest as items.
11299 @node HTML Specific export settings
11300 @subsection HTML Specific export settings
11301 HTML export introduces a number of keywords, similar to the general options
11302 settings described in @ref{Export settings}.
11306 @cindex #+DESCRIPTION (HTML)
11307 The document description. This description is inserted as a HTML meta tag.
11308 You can use several such keywords if the list is long.
11311 @cindex #+HTML_DOCTYPE
11312 @vindex org-html-doctype
11313 The document type, e.g. HTML5, (@code{org-html-doctype}).
11315 @item HTML_CONTAINER
11316 @cindex #+HTML_CONTAINER
11317 @vindex org-html-container-element
11318 The container, e.g. @samp{div}, used to wrap sections and elements
11319 (@code{org-html-container-element}).
11321 @item HTML_LINK_HOME
11322 @cindex #+HTML_LINK_HOME
11323 @vindex org-html-link-home
11324 The home link URL (@code{org-html-link-home}).
11327 @cindex #+HTML_LINK_UP
11328 @vindex org-html-link-up
11329 The up link URL (@code{org-html-link-up}).
11332 @cindex #+HTML_MATHJAX
11333 @vindex org-html-mathjax-options
11334 Options for the MathJax (@code{org-html-mathjax-options}). MathJax is used
11335 to typeset @LaTeX{} math in HTML documents. @ref{Math formatting in HTML
11336 export} contains an example.
11339 @cindex #+HTML_HEAD
11340 @vindex org-html-head
11341 Arbitrary lines appended to the end of the head of the document
11342 (@code{org-html-head}).
11344 @item HTML_HEAD_EXTRA
11345 @cindex #+HTML_HEAD_EXTRA
11346 @vindex org-html-head-extra
11347 Arbitrary lines appended to the end of the header of the document
11348 (@code{org-html-head-extra}).
11351 @cindex #+KEYWORDS (HTML)
11352 The keywords defining the contents of the document. This description is
11353 inserted as a HTML meta tag. You can use several such keywords if the list
11357 @cindex #+LATEX_HEADER (HTML)
11358 Arbitrary lines appended to the preamble used when transcoding @LaTeX{}
11359 fragments to images. See @ref{Math formatting in HTML export} for details.
11362 @cindex #+SUBTILE (HTML)
11363 The document subtitle. The formatting depends on whether HTML5 in used
11364 and on the @samp{subtitle} CSS class.
11367 These keywords are treated in details in the following sections.
11369 @node HTML doctypes
11370 @subsection HTML doctypes
11372 Org can export to various (X)HTML flavors.
11374 @vindex org-html-doctype
11375 @vindex org-html-doctype-alist
11376 Setting the variable @code{org-html-doctype} allows you to export to different
11377 (X)HTML variants. The exported HTML will be adjusted according to the syntax
11378 requirements of that variant. You can either set this variable to a doctype
11379 string directly, in which case the exporter will try to adjust the syntax
11380 automatically, or you can use a ready-made doctype. The ready-made options
11387 ``html4-transitional''
11393 ``xhtml-transitional''
11404 @noindent See the variable @code{org-html-doctype-alist} for details. The default is
11407 @vindex org-html-html5-fancy
11408 @cindex HTML5, export new elements
11409 HTML5 introduces several new element types. By default, Org will not make
11410 use of these element types, but you can set @code{org-html-html5-fancy} to
11411 non-@code{nil} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11412 enable a few new block-level elements. These are created using arbitrary
11413 #+BEGIN and #+END blocks. For instance:
11432 #+ATTR_HTML: :controls controls :width 350
11434 #+HTML: <source src="movie.mp4" type="video/mp4">
11435 #+HTML: <source src="movie.ogg" type="video/ogg">
11436 Your browser does not support the video tag.
11443 <video controls="controls" width="350">
11444 <source src="movie.mp4" type="video/mp4">
11445 <source src="movie.ogg" type="video/ogg">
11446 <p>Your browser does not support the video tag.</p>
11450 @vindex org-html-html5-elements
11451 Special blocks that do not correspond to HTML5 elements (see
11452 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11453 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11455 Headlines cannot appear within special blocks. To wrap a headline and its
11456 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11457 @code{HTML_CONTAINER} property on the headline itself.
11459 @node HTML preamble and postamble
11460 @subsection HTML preamble and postamble
11461 @vindex org-html-preamble
11462 @vindex org-html-postamble
11463 @vindex org-html-preamble-format
11464 @vindex org-html-postamble-format
11465 @vindex org-html-validation-link
11466 @vindex org-export-creator-string
11467 @vindex org-export-time-stamp-file
11469 The HTML exporter lets you define a preamble and a postamble.
11471 The default value for @code{org-html-preamble} is @code{t}, which means
11472 that the preamble is inserted depending on the relevant format string in
11473 @code{org-html-preamble-format}.
11475 Setting @code{org-html-preamble} to a string will override the default format
11476 string. If you set it to a function, it will insert the output of the
11477 function, which must be a string. Setting to @code{nil} will not insert any
11480 The default value for @code{org-html-postamble} is @code{'auto}, which means
11481 that the HTML exporter will look for information about the author, the email,
11482 the creator and the date, and build the postamble from these values. Setting
11483 @code{org-html-postamble} to @code{t} will insert the postamble from the
11484 relevant format string found in @code{org-html-postamble-format}. Setting it
11485 to @code{nil} will not insert any postamble.
11487 @node Quoting HTML tags
11488 @subsection Quoting HTML tags
11490 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11491 @samp{>} in HTML export. If you want to include raw HTML code, which
11492 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11493 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11494 that should be copied verbatim to the exported file use either
11497 @cindex #+BEGIN_EXPORT html
11499 #+HTML: Literal HTML code for export
11503 @cindex #+BEGIN_EXPORT html
11506 #+BEGIN_EXPORT html
11507 All lines between these markers are exported literally
11512 @node Links in HTML export
11513 @subsection Links in HTML export
11515 @cindex links, in HTML export
11516 @cindex internal links, in HTML export
11517 @cindex external links, in HTML export
11518 @vindex org-html-link-org-files-as-html
11519 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11520 includes automatic links created by radio targets (@pxref{Radio
11521 targets}). Links to external files will still work if the target file is on
11522 the same @i{relative} path as the published Org file. Links to other
11523 @file{.org} files will be translated into HTML links under the assumption
11524 that an HTML version also exists of the linked file, at the same relative
11525 path; setting @code{org-html-link-org-files-as-html} to @code{nil} disables
11526 this translation. @samp{id:} links can then be used to jump to specific
11527 entries across files. For information related to linking files while
11528 publishing them to a publishing directory see @ref{Publishing links}.
11530 If you want to specify attributes for links, you can do so using a special
11531 @code{#+ATTR_HTML} line to define attributes that will be added to the
11532 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11533 and @code{style} attributes for a link:
11535 @cindex #+ATTR_HTML
11537 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11538 [[http://orgmode.org]]
11541 @node Tables in HTML export
11542 @subsection Tables in HTML export
11543 @cindex tables, in HTML
11544 @vindex org-html-table-default-attributes
11546 Org mode tables are exported to HTML using the table attributes defined in
11547 @code{org-html-table-default-attributes}. The default setting makes tables
11548 without cell borders and frame. If you would like to change this for
11549 individual tables, place something like the following before the table:
11552 @cindex #+ATTR_HTML
11554 #+CAPTION: This is a table with lines around and between cells
11555 #+ATTR_HTML: :border 2 :rules all :frame border
11558 You can also group columns in the HTML output (@pxref{Column groups}).
11560 Below is a list of options for customizing tables HTML export.
11563 @vindex org-html-table-align-individual-fields
11564 @item org-html-table-align-individual-fields
11565 Non-@code{nil} means attach style attributes for alignment to each table field.
11567 @vindex org-html-table-caption-above
11568 @item org-html-table-caption-above
11569 When non-@code{nil}, place caption string at the beginning of the table.
11571 @vindex org-html-table-data-tags
11572 @item org-html-table-data-tags
11573 The opening and ending tags for table data fields.
11575 @vindex org-html-table-default-attributes
11576 @item org-html-table-default-attributes
11577 Default attributes and values which will be used in table tags.
11579 @vindex org-html-table-header-tags
11580 @item org-html-table-header-tags
11581 The opening and ending tags for table header fields.
11583 @vindex org-html-table-row-tags
11584 @item org-html-table-row-tags
11585 The opening and ending tags for table rows.
11587 @vindex org-html-table-use-header-tags-for-first-column
11588 @item org-html-table-use-header-tags-for-first-column
11589 Non-@code{nil} means format column one in tables with header tags.
11592 @node Images in HTML export
11593 @subsection Images in HTML export
11595 @cindex images, inline in HTML
11596 @cindex inlining images in HTML
11597 @vindex org-html-inline-images
11598 HTML export can inline images given as links in the Org file, and
11599 it can make an image the clickable part of a link. By
11600 default@footnote{But see the variable
11601 @code{org-html-inline-images}.}, images are inlined if a link does
11602 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11603 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11604 @samp{the image} that points to the image. If the description part
11605 itself is a @code{file:} link or a @code{http:} URL pointing to an
11606 image, this image will be inlined and activated so that clicking on the
11607 image will activate the link. For example, to include a thumbnail that
11608 will link to a high resolution version of the image, you could use:
11611 [[file:highres.jpg][file:thumb.jpg]]
11614 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11615 In the example below we specify the @code{alt} and @code{title} attributes to
11616 support text viewers and accessibility, and align it to the right.
11619 @cindex #+ATTR_HTML
11621 #+CAPTION: A black cat stalking a spider
11622 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11627 You could use @code{http} addresses just as well.
11629 @node Math formatting in HTML export
11630 @subsection Math formatting in HTML export
11634 @cindex imagemagick
11636 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11637 different ways on HTML pages. The default is to use
11638 @uref{http://www.mathjax.org, MathJax} which should work out of the box with
11639 Org@footnote{By default Org loads MathJax from
11640 @uref{http://docs.mathjax.org/en/latest/start.html#using-the-mathjax-content-delivery-network-cdn,
11641 MathJax.org}. A link to the terms of service of the MathJax CDN can be found
11642 in the docstring of @code{org-html-mathjax-options}.}. Some MathJax display
11643 options can be configured via @code{org-html-mathjax-options}, or in the
11644 buffer. For example, with the following settings,
11646 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
11648 equation labels will be displayed on the left marign and equations will be
11649 five ems from the left margin.
11651 @noindent See the docstring of
11652 @code{org-html-mathjax-options} for all supported variables. The MathJax
11653 template can be configure via @code{org-html-mathjax-template}.
11655 If you prefer, you can also request that @LaTeX{} fragments are processed
11656 into small images that will be inserted into the browser page. Before the
11657 availability of MathJax, this was the default method for Org files. This
11658 method requires that the @file{dvipng} program, @file{dvisvgm} or
11659 @file{imagemagick} suite is available on your system. You can still get
11660 this processing with
11663 #+OPTIONS: tex:dvipng
11667 #+OPTIONS: tex:dvisvgm
11673 #+OPTIONS: tex:imagemagick
11676 @node Text areas in HTML export
11677 @subsection Text areas in HTML export
11679 @cindex text areas, in HTML
11680 An alternative way to publish literal code examples in HTML is to use text
11681 areas, where the example can even be edited before pasting it into an
11682 application. It is triggered by @code{:textarea} attribute at an
11683 @code{example} or @code{src} block.
11685 You may also use @code{:height} and @code{:width} attributes to specify the
11686 height and width of the text area, which default to the number of lines in
11687 the example, and 80, respectively. For example
11690 #+ATTR_HTML: :textarea t :width 40
11692 (defun org-xor (a b)
11700 @subsection CSS support
11701 @cindex CSS, for HTML export
11702 @cindex HTML export, CSS
11704 @vindex org-html-todo-kwd-class-prefix
11705 @vindex org-html-tag-class-prefix
11706 You can modify the CSS style definitions for the exported file. The HTML
11707 exporter assigns the following special CSS classes@footnote{If the classes on
11708 TODO keywords and tags lead to conflicts, use the variables
11709 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11710 make them unique.} to appropriate parts of the document---your style
11711 specifications may change these, in addition to any of the standard classes
11712 like for headlines, tables, etc.
11714 p.author @r{author information, including email}
11715 p.date @r{publishing date}
11716 p.creator @r{creator info, about org mode version}
11717 .title @r{document title}
11718 .subtitle @r{document subtitle}
11719 .todo @r{TODO keywords, all not-done states}
11720 .done @r{the DONE keywords, all states that count as done}
11721 .WAITING @r{each TODO keyword also uses a class named after itself}
11722 .timestamp @r{timestamp}
11723 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11724 .timestamp-wrapper @r{span around keyword plus timestamp}
11725 .tag @r{tag in a headline}
11726 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11727 .target @r{target for links}
11728 .linenr @r{the line number in a code example}
11729 .code-highlighted @r{for highlighting referenced code lines}
11730 div.outline-N @r{div for outline level N (headline plus text))}
11731 div.outline-text-N @r{extra div for text at outline level N}
11732 .section-number-N @r{section number in headlines, different for each level}
11733 .figure-number @r{label like "Figure 1:"}
11734 .table-number @r{label like "Table 1:"}
11735 .listing-number @r{label like "Listing 1:"}
11736 div.figure @r{how to format an inlined image}
11737 pre.src @r{formatted source code}
11738 pre.example @r{normal example}
11739 p.verse @r{verse paragraph}
11740 div.footnotes @r{footnote section headline}
11741 p.footnote @r{footnote definition paragraph, containing a footnote}
11742 .footref @r{a footnote reference number (always a <sup>)}
11743 .footnum @r{footnote number in footnote definition (always <sup>)}
11744 .org-svg @r{default class for a linked @file{.svg} image}
11747 @vindex org-html-style-default
11748 @vindex org-html-head-include-default-style
11749 @vindex org-html-head
11750 @vindex org-html-head-extra
11751 @cindex #+HTML_INCLUDE_STYLE
11752 Each exported file contains a compact default style that defines these
11753 classes in a basic way@footnote{This style is defined in the constant
11754 @code{org-html-style-default}, which you should not modify. To turn
11755 inclusion of these defaults off, customize
11756 @code{org-html-head-include-default-style} or set @code{html-style} to
11757 @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or
11758 add to them by using the variables @code{org-html-head} and
11759 @code{org-html-head-extra}. You can override the global values of these
11760 variables for each file by using these keywords:
11762 @cindex #+HTML_HEAD
11763 @cindex #+HTML_HEAD_EXTRA
11765 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11766 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11770 For longer style definitions, you can use several such lines. You could also
11771 directly write a @code{<style>} @code{</style>} section in this way, without
11772 referring to an external file.
11774 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11775 property to assign a class to the tree. In order to specify CSS styles for a
11776 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11779 @c FIXME: More about header and footer styles
11780 @c FIXME: Talk about links and targets.
11782 @node JavaScript support
11783 @subsection JavaScript supported display of web pages
11785 @cindex Rose, Sebastian
11786 Sebastian Rose has written a JavaScript program especially designed to
11787 enhance the web viewing experience of HTML files created with Org. This
11788 program allows you to view large files in two different ways. The first one
11789 is an @emph{Info}-like mode where each section is displayed separately and
11790 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11791 as well, press @kbd{?} for an overview of the available keys). The second
11792 view type is a @emph{folding} view much like Org provides inside Emacs. The
11793 script is available at @url{http://orgmode.org/org-info.js} and you can find
11794 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11795 We host the script at our site, but if you use it a lot, you might not want
11796 to be dependent on @url{http://orgmode.org} and prefer to install a local
11797 copy on your own web server.
11799 All it then takes to use this program is adding a single line to the Org
11802 @cindex #+INFOJS_OPT
11804 #+INFOJS_OPT: view:info toc:nil
11808 If this line is found, the HTML header will automatically contain the code
11809 needed to invoke the script. Using the line above, you can set the following
11813 path: @r{The path to the script. The default is to grab the script from}
11814 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11815 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11816 view: @r{Initial view when the website is first shown. Possible values are:}
11817 info @r{Info-like interface with one section per page.}
11818 overview @r{Folding interface, initially showing only top-level.}
11819 content @r{Folding interface, starting with all headlines visible.}
11820 showall @r{Folding interface, all headlines and text visible.}
11821 sdepth: @r{Maximum headline level that will still become an independent}
11822 @r{section for info and folding modes. The default is taken from}
11823 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11824 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11825 @r{info/folding section can still contain child headlines.}
11826 toc: @r{Should the table of contents @emph{initially} be visible?}
11827 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11828 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11829 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11830 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11831 @r{If yes, the toc will never be displayed as a section.}
11832 ltoc: @r{Should there be short contents (children) in each section?}
11833 @r{Make this @code{above} if the section should be above initial text.}
11834 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11835 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11836 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11837 @r{default), only one such button will be present.}
11840 @vindex org-html-infojs-options
11841 @vindex org-html-use-infojs
11842 You can choose default values for these options by customizing the variable
11843 @code{org-html-infojs-options}. If you always want to apply the script to your
11844 pages, configure the variable @code{org-html-use-infojs}.
11846 @node @LaTeX{} export
11847 @section @LaTeX{} export
11848 @cindex @LaTeX{} export
11851 The @LaTeX{} exporter can produce an arbitrarily complex @LaTeX{} document of
11852 any standard or custom document class@footnote{The @LaTeX{} exporter can be
11853 configured to support alternative @LaTeX{} engines (see
11854 @code{org-latex-compiler}), build sequences (see
11855 @code{org-latex-pdf-process}), and packages, (see
11856 @code{org-latex-default-packages-alist} and
11857 @code{org-latex-packages-alist}).}. The Org @LaTeX{} exporter is geared
11858 towards producing fully-linked PDF output.
11860 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11861 will not be started if two contiguous syntactical elements are not separated
11865 * @LaTeX{} export commands:: How to export to @LaTeX{} and PDF
11866 * @LaTeX{} specific export settings:: Export settings for @LaTeX{}
11867 * @LaTeX{} header and sectioning:: Setting up the export file structure
11868 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11869 * Tables in @LaTeX{} export:: Specific attributes for tables
11870 * Images in @LaTeX{} export:: Specific attributes for images
11871 * Plain lists in @LaTeX{} export:: Specific attributes for plain lists
11872 * Source blocks in @LaTeX{} export:: Specific attributes for source blocks
11873 * Example blocks in @LaTeX{} export:: Specific attributes for example blocks
11874 * Special blocks in @LaTeX{} export:: Specific attributes for special blocks
11875 * Horizontal rules in @LaTeX{} export:: Specific attributes for horizontal rules
11878 @node @LaTeX{} export commands
11879 @subsection @LaTeX{} export commands
11882 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11883 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11884 file will be @file{myfile.tex}. The file will be overwritten without
11886 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11887 Export to a temporary buffer. Do not create a file.
11888 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11889 Export as @LaTeX{} and then process to PDF.
11891 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11894 @vindex org-latex-compiler
11895 @vindex org-latex-bibtex-compiler
11896 @vindex org-latex-default-packages-alist
11897 The exporter supports several @LaTeX{} engines, namely @samp{pdflatex},
11898 @samp{xelatex} and @samp{lualatex}. The default @LaTeX{} compiler can be set
11899 via @code{org-latex-compiler} or the @code{#+LATEX_COMPILER} keyword. It is
11900 possible to only load some packages with certain compilers (see the docstring
11901 of @code{org-latex-default-packages-alist}). The bibliography compiler may
11902 also be set via @code{org-latex-bibtex-compiler}@footnote{You cannot set the
11903 bibliography compiler on a file basis via a keyword. However, ``smart''
11904 @LaTeX{} compilation systems, such as @samp{latexmk}, are usually able to
11905 select the correct bibliography compiler.}.
11907 @node @LaTeX{} specific export settings
11908 @subsection @LaTeX{} specific export settings
11909 The @LaTeX{} exporter introduces a number of keywords, similar to the general
11910 options settings described in @ref{Export settings}.
11914 @cindex #+DESCRIPTION (@LaTeX{})
11915 The document description. By default these are inserted as metadata using
11916 @samp{hyperref}. Document metadata can be configured via
11917 @code{org-latex-hyperref-template}. Description can also be typeset as part
11918 of the front matter via @code{org-latex-title-command}. You can use several
11919 @code{#+DESCRIPTION} keywords if the description is is long.
11922 @cindex #+LATEX_CLASS
11923 @vindex org-latex-default-class
11924 @vindex org-latex-classes
11925 The predefined preamble and headline level mapping to use
11926 (@code{org-latex-default-class}). Must be an element in
11927 @code{org-latex-classes}.
11929 @item LATEX_CLASS_OPTIONS
11930 @cindex #+LATEX_CLASS_OPTIONS
11931 Options given to the @LaTeX{} document class.
11933 @item LATEX_COMPILER
11934 @cindex #+LATEX_COMPILER
11935 @vindex org-latex-compiler
11936 The compiler used to produce the PDF (@code{org-latex-compiler}).
11939 @cindex #+LATEX_HEADER
11940 @vindex org-latex-classes
11941 Arbitrary lines added to the preamble of the document, before the
11942 @samp{hyperref} settings. The location can be controlled via
11943 @code{org-latex-classes}.
11945 @item LATEX_HEADER_EXTRA
11946 @cindex #+LATEX_HEADER_EXTRA
11947 @vindex org-latex-classes
11948 Arbitrary lines added to the preamble of the document, before the
11949 @samp{hyperref} settings. The location can be controlled via
11950 @code{org-latex-classes}.
11953 @cindex #+KEYWORDS (@LaTeX{})
11954 The keywords defining the contents of the document. By default these are
11955 inserted as metadata using @samp{hyperref}. Document metadata can be
11956 configured via @code{org-latex-hyperref-template}. Description can also be
11957 typeset as part of the front matter via @code{org-latex-title-command}. You
11958 can use several @code{#+KEYWORDS} if the description is is long.
11961 @cindex #+SUBTITLE (@LaTeX{})
11962 @vindex org-latex-subtitle-separate
11963 @vindex org-latex-subtitle-format
11964 The document subtitle. This is typeset according to
11965 @code{org-latex-subtitle-format}. If @code{org-latex-subtitle-separate}
11966 is non-@code{nil} it is typed as part of the @samp{\title}-macro. It
11967 can also access via @code{org-latex-hyperref-template} or typeset as
11968 part of the front matter via @code{org-latex-title-command}.
11971 These keywords are treated in details in the following sections.
11973 @node @LaTeX{} header and sectioning
11974 @subsection @LaTeX{} header and sectioning structure
11975 @cindex @LaTeX{} class
11976 @cindex @LaTeX{} sectioning structure
11977 @cindex @LaTeX{} header
11978 @cindex header, for @LaTeX{} files
11979 @cindex sectioning structure, for @LaTeX{} export
11981 By default, the first three outline levels become headlines, defining a
11982 general document structure. Additional levels are exported as @code{itemize}
11983 or @code{enumerate} lists. The transition can also occur at a different
11984 level (@pxref{Export settings}).
11986 By default, the @LaTeX{} output uses the class @code{article}.
11988 @vindex org-latex-default-class
11989 @vindex org-latex-classes
11990 @vindex org-latex-default-packages-alist
11991 @vindex org-latex-packages-alist
11992 You can change this globally by setting a different value for
11993 @code{org-latex-default-class} or locally by adding an option like
11994 @code{#+LATEX_CLASS: myclass} in your file, or with
11995 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11996 containing only this (sub)tree. The class must be listed in
11997 @code{org-latex-classes}. This variable defines a header template for each
11998 class@footnote{Into which the values of
11999 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
12000 are spliced.}, and allows you to define the sectioning structure for each
12001 class. You can also define your own classes there.
12003 @cindex #+LATEX_CLASS
12004 @cindex #+LATEX_CLASS_OPTIONS
12005 @cindex property, EXPORT_LATEX_CLASS
12006 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
12007 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
12008 property can specify the options for the @code{\documentclass} macro. These
12009 options have to be provided, as expected by @LaTeX{}, within square brackets.
12011 @cindex #+LATEX_HEADER
12012 @cindex #+LATEX_HEADER_EXTRA
12013 You can also use the @code{LATEX_HEADER} and
12014 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
12015 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
12016 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
12017 to add lines to the header. See the docstring of @code{org-latex-classes} for
12020 An example is shown below.
12023 #+LATEX_CLASS: article
12024 #+LATEX_CLASS_OPTIONS: [a4paper]
12025 #+LATEX_HEADER: \usepackage@{xyz@}
12031 @node Quoting @LaTeX{} code
12032 @subsection Quoting @LaTeX{} code
12034 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
12035 inserted into the @LaTeX{} file. Furthermore, you can add special code that
12036 should only be present in @LaTeX{} export with the following constructs:
12039 @cindex #+BEGIN_EXPORT latex
12041 Code within @@@@latex:some code@@@@ a paragraph.
12043 #+LATEX: Literal @LaTeX{} code for export
12045 #+BEGIN_EXPORT latex
12046 All lines between these markers are exported literally
12050 @node Tables in @LaTeX{} export
12051 @subsection Tables in @LaTeX{} export
12052 @cindex tables, in @LaTeX{} export
12053 @cindex #+ATTR_LATEX, in tables
12055 For @LaTeX{} export of a table, you can specify a label and a caption
12056 (@pxref{Images and tables}). You can also use attributes to control table
12057 layout and contents. Valid @LaTeX{} attributes include:
12061 @vindex org-latex-default-table-mode
12062 Nature of table's contents. It can be set to @code{table}, @code{math},
12063 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
12064 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
12065 ignored and the table will be wrapped in a math environment. Also,
12066 contiguous tables sharing the same math mode will be wrapped within the same
12067 environment. Default mode is determined in
12068 @code{org-latex-default-table-mode}.
12070 @vindex org-latex-default-table-environment
12071 Environment used for the table. It can be set to any @LaTeX{} table
12072 environment, like @code{tabularx}@footnote{Requires adding the
12073 @code{tabularx} package to @code{org-latex-packages-alist}.},
12074 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
12075 @code{tabu} package to @code{org-latex-packages-alist}.},
12076 @code{bmatrix}@enddots{} It defaults to
12077 @code{org-latex-default-table-environment} value.
12079 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
12080 (@pxref{Images and tables}). If you need more advanced commands for that
12081 task, you can use @code{:caption} attribute instead. Its value should be raw
12082 @LaTeX{} code. It has precedence over @code{#+CAPTION}.
12085 The @code{:float} specifies the float environment for the table. Possible
12086 values are @code{sideways}@footnote{Formerly, the value was
12087 @code{sidewaystable}. This is deprecated since Org 8.3.},
12088 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
12089 a caption will have a @code{table} environment. Moreover, the
12090 @code{:placement} attribute can specify the positioning of the float. Note:
12091 @code{:placement} is ignored for @code{:float sideways} tables.
12095 Set, respectively, the alignment string of the table, its font size and its
12096 width. They only apply on regular tables.
12098 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
12099 only takes effect when used in conjunction with the @code{:width} attribute.
12100 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
12101 value of @code{:width}.
12105 @vindex org-latex-tables-booktabs
12106 @vindex org-latex-tables-centered
12107 They toggle, respectively, @code{booktabs} usage (assuming the package is
12108 properly loaded), table centering and removal of every horizontal rule but
12109 the first one (in a "table.el" table only). In particular,
12110 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
12111 activates the first (respectively second) attribute globally.
12113 @itemx :math-suffix
12114 @itemx :math-arguments
12115 A string that will be inserted, respectively, before the table within the
12116 math environment, after the table within the math environment, and between
12117 the macro name and the contents of the table. The @code{:math-arguments}
12118 attribute is used for matrix macros that require more than one argument
12119 (e.g., @code{qbordermatrix}).
12122 Thus, attributes can be used in a wide array of situations, like writing
12123 a table that will span over multiple pages, or a matrix product:
12126 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
12130 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
12133 #+ATTR_LATEX: :mode math :environment bmatrix
12138 In the example below, @LaTeX{} command
12139 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
12142 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12148 @node Images in @LaTeX{} export
12149 @subsection Images in @LaTeX{} export
12150 @cindex images, inline in @LaTeX{}
12151 @cindex inlining images in @LaTeX{}
12152 @cindex #+ATTR_LATEX, in images
12154 Images that are linked to without a description part in the link, like
12155 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
12156 output file resulting from @LaTeX{} processing. Org will use an
12157 @code{\includegraphics} macro to insert the image@footnote{In the case of
12158 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
12159 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
12161 You can specify image width or height with, respectively, @code{:width} and
12162 @code{:height} attributes. It is also possible to add any other option with
12163 the @code{:options} attribute, as shown in the following example:
12166 #+ATTR_LATEX: :width 5cm :options angle=90
12167 [[./img/sed-hr4049.pdf]]
12170 If you need a specific command for the caption, use @code{:caption}
12171 attribute. It will override standard @code{#+CAPTION} value, if any.
12174 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12175 [[./img/sed-hr4049.pdf]]
12178 If you have specified a caption as described in @ref{Images and tables}, the
12179 picture will be wrapped into a @code{figure} environment and thus become
12180 a floating element. You can also ask Org to export an image as a float
12181 without specifying caption by setting the @code{:float} attribute. You may
12185 @code{t}: if you want to use the standard @samp{figure} environment. It is
12186 used by default if you provide a caption to the image.
12188 @code{multicolumn}: if you wish to include an image which spans multiple
12189 columns in a page. This will export the image wrapped in a @code{figure*}
12192 @code{wrap}: if you would like to let text flow around the image. It will
12193 make the figure occupy the left half of the page.
12195 @code{sideways}: if you would like the image to appear alone on a separate
12196 page rotated ninety degrees using the @code{sidewaysfigure}
12197 environment. Setting this @code{:float} option will ignore the
12198 @code{:placement} setting.
12200 @code{nil}: if you need to avoid any floating environment, even when
12201 a caption is provided.
12204 To modify the placement option of any floating environment, set the
12205 @code{placement} attribute.
12208 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
12212 @vindex org-latex-images-centered
12213 @cindex center image (@LaTeX{} export)
12214 @cindex image, centering (@LaTeX{} export)
12215 Images are centered by default. However, one can disable this behavior by
12216 setting @code{:center} attribute to @code{nil}. To prevent any image from
12217 being centered throughout a document, set @code{org-latex-images-centered}
12220 Eventually, if the @code{:comment-include} attribute is set to
12221 a non-@code{nil} value, the @LaTeX{} @code{\includegraphics} macro will be
12224 @node Plain lists in @LaTeX{} export
12225 @subsection Plain lists in @LaTeX{} export
12226 @cindex plain lists, in @LaTeX{} export
12227 @cindex #+ATTR_LATEX, in plain lists
12229 Plain lists accept two optional attributes: @code{:environment} and
12230 @code{:options}. The first can be used to specify the environment. The
12231 second can be used to specifies additional arguments to the environment.
12232 Both attributes are illustrated in the following example:
12235 #+LATEX_HEADER: \usepackage[inline]@{enumitem@}
12236 Some ways to say "Hello":
12237 #+ATTR_LATEX: :environment itemize*
12238 #+ATTR_LATEX: :options [label=@{@}, itemjoin=@{,@}, itemjoin*=@{, and@}]
12244 By default, @LaTeX{} only supports four levels of nesting for lists. If
12245 deeper nesting is needed, the @samp{enumitem} @LaTeX{} package can be
12246 employed, as shown in this example:
12249 #+LATEX_HEADER: \usepackage@{enumitem@}
12250 #+LATEX_HEADER: \renewlist@{itemize@}@{itemize@}@{9@}
12251 #+LATEX_HEADER: \setlist[itemize]@{label=$\circ$@}
12259 @node Source blocks in @LaTeX{} export
12260 @subsection Source blocks in @LaTeX{} export
12261 @cindex source blocks, in @LaTeX{} export
12262 @cindex #+ATTR_LATEX, in source blocks
12264 In addition to syntax defined in @ref{Literal examples}, names and captions
12265 (@pxref{Images and tables}), source blocks also accept two additional
12266 attributes: @code{:float} and @code{:options}.
12268 You may set the former to
12271 @code{t}: if you want to make the source block a float. It is the default
12272 value when a caption is provided.
12274 @code{multicolumn}: if you wish to include a source block which spans multiple
12277 @code{nil}: if you need to avoid any floating environment, even when a caption
12278 is provided. It is useful for source code that may not fit in a single page.
12282 #+ATTR_LATEX: :float nil
12283 #+BEGIN_SRC emacs-lisp
12284 Code that may not fit in a single page.
12288 @vindex org-latex-listings-options
12289 @vindex org-latex-minted-options
12290 The latter allows to specify options relative to the package used to
12291 highlight code in the output (e.g., @code{listings}). This is the local
12292 counterpart to @code{org-latex-listings-options} and
12293 @code{org-latex-minted-options} variables, which see.
12296 #+ATTR_LATEX: :options commentstyle=\bfseries
12297 #+BEGIN_SRC emacs-lisp
12298 (defun Fib (n) ; Count rabbits.
12299 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
12303 @node Example blocks in @LaTeX{} export
12304 @subsection Example blocks in @LaTeX{} export
12305 @cindex example blocks, in @LaTeX{} export
12306 @cindex verbatim blocks, in @LaTeX{} export
12307 @cindex #+ATTR_LATEX, in example blocks
12309 By default, when exporting to @LaTeX{}, example blocks contents are wrapped
12310 in a @samp{verbatim} environment. It is possible to use a different
12311 environment globally using an appropriate export filter (@pxref{Advanced
12312 configuration}). You can also change this per block using
12313 @code{:environment} parameter.
12316 #+ATTR_LATEX: :environment myverbatim
12318 This sentence is false.
12322 @node Special blocks in @LaTeX{} export
12323 @subsection Special blocks in @LaTeX{} export
12324 @cindex special blocks, in @LaTeX{} export
12325 @cindex abstract, in @LaTeX{} export
12326 @cindex proof, in @LaTeX{} export
12327 @cindex #+ATTR_LATEX, in special blocks
12329 In @LaTeX{} back-end, special blocks become environments of the same name.
12330 Value of @code{:options} attribute will be appended as-is to that
12331 environment's opening string. For example:
12335 We demonstrate how to solve the Syracuse problem.
12338 #+ATTR_LATEX: :options [Proof of important theorem]
12341 Therefore, any even number greater than 2 is the sum of two primes.
12350 We demonstrate how to solve the Syracuse problem.
12353 \begin@{proof@}[Proof of important theorem]
12355 Therefore, any even number greater than 2 is the sum of two primes.
12359 If you need to insert a specific caption command, use @code{:caption}
12360 attribute. It will override standard @code{#+CAPTION} value, if any. For
12364 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12370 @node Horizontal rules in @LaTeX{} export
12371 @subsection Horizontal rules in @LaTeX{} export
12372 @cindex horizontal rules, in @LaTeX{} export
12373 @cindex #+ATTR_LATEX, in horizontal rules
12375 Width and thickness of a given horizontal rule can be controlled with,
12376 respectively, @code{:width} and @code{:thickness} attributes:
12379 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12383 @node Markdown export
12384 @section Markdown export
12385 @cindex Markdown export
12387 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12388 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12391 It is built over HTML back-end: any construct not supported by Markdown
12392 syntax (e.g., tables) will be controlled and translated by @code{html}
12393 back-end (@pxref{HTML export}).
12395 @subheading Markdown export commands
12398 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12399 Export as a text file written in Markdown syntax. For an Org file,
12400 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
12401 will be overwritten without warning.
12402 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12403 Export to a temporary buffer. Do not create a file.
12405 Export as a text file with Markdown syntax, then open it.
12408 @subheading Header and sectioning structure
12410 @vindex org-md-headline-style
12411 Markdown export can generate both @code{atx} and @code{setext} types for
12412 headlines, according to @code{org-md-headline-style}. The former introduces
12413 a hard limit of two levels, whereas the latter pushes it to six. Headlines
12414 below that limit are exported as lists. You can also set a soft limit before
12415 that one (@pxref{Export settings}).
12417 @c begin opendocument
12419 @node OpenDocument Text export
12420 @section OpenDocument Text export
12422 @cindex OpenDocument
12423 @cindex export, OpenDocument
12424 @cindex LibreOffice
12426 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12427 (ODT) format. Documents created by this exporter use the
12428 @cite{OpenDocument-v1.2
12429 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12430 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12431 are compatible with LibreOffice 3.4.
12434 * Pre-requisites for ODT export:: What packages ODT exporter relies on
12435 * ODT export commands:: How to invoke ODT export
12436 * ODT specific export settings:: Export settings for ODT
12437 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
12438 * Applying custom styles:: How to apply custom styles to the output
12439 * Links in ODT export:: How links will be interpreted and formatted
12440 * Tables in ODT export:: How Tables are exported
12441 * Images in ODT export:: How to insert images
12442 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
12443 * Labels and captions in ODT export:: How captions are rendered
12444 * Literal examples in ODT export:: How source and example blocks are formatted
12445 * Advanced topics in ODT export:: Read this if you are a power user
12448 @node Pre-requisites for ODT export
12449 @subsection Pre-requisites for ODT export
12451 The ODT exporter relies on the @file{zip} program to create the final
12452 output. Check the availability of this program before proceeding further.
12454 @node ODT export commands
12455 @subsection ODT export commands
12456 @anchor{x-export-to-odt}
12457 @cindex region, active
12458 @cindex active region
12459 @cindex transient-mark-mode
12461 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12462 @cindex property EXPORT_FILE_NAME
12464 Export as OpenDocument Text file.
12466 @vindex org-odt-preferred-output-format
12467 If @code{org-odt-preferred-output-format} is specified, automatically convert
12468 the exported file to that format. @xref{x-export-to-other-formats, ,
12469 Automatically exporting to other formats}.
12471 For an Org file @file{myfile.org}, the ODT file will be
12472 @file{myfile.odt}. The file will be overwritten without warning. If there
12473 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12474 turned on} only the region will be exported. If the selected region is a
12475 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12476 tree head will become the document title. If the tree head entry has, or
12477 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12481 Export as an OpenDocument Text file and open the resulting file.
12483 @vindex org-odt-preferred-output-format
12484 If @code{org-odt-preferred-output-format} is specified, open the converted
12485 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
12489 @node ODT specific export settings
12490 @subsection ODT specific export settings
12491 The ODT exporter introduces a number of keywords, similar to the general
12492 options settings described in @ref{Export settings}.
12496 @cindex #+DESCRIPTION (ODT)
12497 The document description. These are inserted as document metadata. You can
12498 use several such keywords if the list is long.
12501 @cindex #+KEYWORDS (ODT)
12502 The keywords defining the contents of the document. These are inserted as
12503 document metadata. You can use several such keywords if the list is long.
12505 @item ODT_STYLES_FILE
12506 @cindex ODT_STYLES_FILE
12507 @vindex org-odt-styles-file
12508 The style file of the document (@code{org-odt-styles-file}). See
12509 @ref{Applying custom styles} for details.
12512 @cindex SUBTITLE (ODT)
12513 The document subtitle.
12516 @node Extending ODT export
12517 @subsection Extending ODT export
12519 The ODT exporter can interface with a variety of document
12520 converters and supports popular converters out of the box. As a result, you
12521 can use it to export to formats like @samp{doc} or convert a document from
12522 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12524 @cindex @file{unoconv}
12525 @cindex LibreOffice
12526 If you have a working installation of LibreOffice, a document converter is
12527 pre-configured for you and you can use it right away. If you would like to
12528 use @file{unoconv} as your preferred converter, customize the variable
12529 @code{org-odt-convert-process} to point to @code{unoconv}. You can
12530 also use your own favorite converter or tweak the default settings of the
12531 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
12532 document converter}.
12534 @subsubheading Automatically exporting to other formats
12535 @anchor{x-export-to-other-formats}
12537 @vindex org-odt-preferred-output-format
12538 Very often, you will find yourself exporting to ODT format, only to
12539 immediately save the exported document to other formats like @samp{doc},
12540 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
12541 preferred output format by customizing the variable
12542 @code{org-odt-preferred-output-format}. This way, the export commands
12543 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12544 format that is of immediate interest to you.
12546 @subsubheading Converting between document formats
12547 @anchor{x-convert-to-other-formats}
12549 There are many document converters in the wild which support conversion to
12550 and from various file formats, including, but not limited to the
12551 ODT format. LibreOffice converter, mentioned above, is one such
12552 converter. Once a converter is configured, you can interact with it using
12553 the following command.
12555 @vindex org-odt-convert
12558 @item M-x org-odt-convert RET
12559 Convert an existing document from one format to another. With a prefix
12560 argument, also open the newly produced file.
12563 @node Applying custom styles
12564 @subsection Applying custom styles
12565 @cindex styles, custom
12566 @cindex template, custom
12568 The ODT exporter ships with a set of OpenDocument styles
12569 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12570 output. These factory styles, however, may not cater to your specific
12571 tastes. To customize the output, you can either modify the above styles
12572 files directly, or generate the required styles using an application like
12573 LibreOffice. The latter method is suitable for expert and non-expert
12574 users alike, and is described here.
12576 @subsubheading Applying custom styles: the easy way
12580 Create a sample @file{example.org} file with the below settings and export it
12584 #+OPTIONS: H:10 num:t
12588 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
12589 to locate the target styles---these typically have the @samp{Org} prefix---and
12590 modify those to your taste. Save the modified file either as an
12591 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12594 @cindex #+ODT_STYLES_FILE
12595 @vindex org-odt-styles-file
12596 Customize the variable @code{org-odt-styles-file} and point it to the
12597 newly created file. For additional configuration options
12598 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12600 If you would like to choose a style on a per-file basis, you can use the
12601 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
12604 #+ODT_STYLES_FILE: "/path/to/example.ott"
12610 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12615 @subsubheading Using third-party styles and templates
12617 You can use third-party styles and templates for customizing your output.
12618 This will produce the desired output only if the template provides all
12619 style names that the @samp{ODT} exporter relies on. Unless this condition is
12620 met, the output is going to be less than satisfactory. So it is highly
12621 recommended that you only work with templates that are directly derived from
12622 the factory settings.
12624 @node Links in ODT export
12625 @subsection Links in ODT export
12626 @cindex links, in ODT export
12628 ODT exporter creates native cross-references for internal links. It creates
12629 Internet-style links for all other links.
12631 A link with no description and destined to a regular (un-itemized) outline
12632 heading is replaced with a cross-reference and section number of the heading.
12634 A @samp{\ref@{label@}}-style reference to an image, table etc.@: is replaced
12635 with a cross-reference and sequence number of the labeled entity.
12636 @xref{Labels and captions in ODT export}.
12638 @node Tables in ODT export
12639 @subsection Tables in ODT export
12640 @cindex tables, in ODT export
12642 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12643 tables is supported. However, export of complex @file{table.el} tables---tables
12644 that have column or row spans---is not supported. Such tables are
12645 stripped from the exported document.
12647 By default, a table is exported with top and bottom frames and with rules
12648 separating row and column groups (@pxref{Column groups}). Furthermore, all
12649 tables are typeset to occupy the same width. If the table specifies
12650 alignment and relative width for its columns (@pxref{Column width and
12651 alignment}) then these are honored on export.@footnote{The column widths are
12652 interpreted as weighted ratios with the default weight being 1}
12655 You can control the width of the table by specifying @code{:rel-width}
12656 property using an @code{#+ATTR_ODT} line.
12658 For example, consider the following table which makes use of all the rules
12662 #+ATTR_ODT: :rel-width 50
12663 | Area/Month | Jan | Feb | Mar | Sum |
12664 |---------------+-------+-------+-------+-------|
12666 | <l13> | <r5> | <r5> | <r5> | <r6> |
12667 | North America | 1 | 21 | 926 | 948 |
12668 | Middle East | 6 | 75 | 844 | 925 |
12669 | Asia Pacific | 9 | 27 | 790 | 826 |
12670 |---------------+-------+-------+-------+-------|
12671 | Sum | 16 | 123 | 2560 | 2699 |
12674 On export, the table will occupy 50% of text area. The columns will be sized
12675 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12676 and rest of the columns will be right-aligned. There will be vertical rules
12677 after separating the header and last columns from other columns. There will
12678 be horizontal rules separating the header and last rows from other rows.
12680 If you are not satisfied with the above formatting options, you can create
12681 custom table styles and associate them with a table using the
12682 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12684 @node Images in ODT export
12685 @subsection Images in ODT export
12686 @cindex images, embedding in ODT
12687 @cindex embedding images in ODT
12689 @subsubheading Embedding images
12690 You can embed images within the exported document by providing a link to the
12691 desired image file with no link description. For example, to embed
12692 @samp{img.png} do either of the following:
12702 @subsubheading Embedding clickable images
12703 You can create clickable images by providing a link whose description is a
12704 link to an image file. For example, to embed a image
12705 @file{org-mode-unicorn.png} which when clicked jumps to
12706 @uref{http://Orgmode.org} website, do the following
12709 [[http://orgmode.org][./org-mode-unicorn.png]]
12712 @subsubheading Sizing and scaling of embedded images
12715 You can control the size and scale of the embedded images using the
12716 @code{#+ATTR_ODT} attribute.
12718 @cindex identify, ImageMagick
12719 @vindex org-odt-pixels-per-inch
12720 The exporter specifies the desired size of the image in the final document in
12721 units of centimeters. In order to scale the embedded images, the exporter
12722 queries for pixel dimensions of the images using one of a) ImageMagick's
12723 @file{identify} program or b) Emacs @code{create-image} and @code{image-size}
12724 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12725 routinely produce documents that have large images or you export your Org
12726 files that has images using a Emacs batch script, then the use of
12727 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12728 converted in to units of centimeters using
12729 @code{org-odt-pixels-per-inch}. The default value of this variable is
12730 set to @code{display-pixels-per-inch}. You can tweak this variable to
12731 achieve the best results.
12733 The examples below illustrate the various possibilities.
12736 @item Explicitly size the image
12737 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12740 #+ATTR_ODT: :width 10 :height 10
12744 @item Scale the image
12745 To embed @file{img.png} at half its size, do the following:
12748 #+ATTR_ODT: :scale 0.5
12752 @item Scale the image to a specific width
12753 To embed @file{img.png} with a width of 10 cm while retaining the original
12754 height:width ratio, do the following:
12757 #+ATTR_ODT: :width 10
12761 @item Scale the image to a specific height
12762 To embed @file{img.png} with a height of 10 cm while retaining the original
12763 height:width ratio, do the following
12766 #+ATTR_ODT: :height 10
12771 @subsubheading Anchoring of images
12774 You can control the manner in which an image is anchored by setting the
12775 @code{:anchor} property of its @code{#+ATTR_ODT} line. You can specify one
12776 of the following three values for the @code{:anchor} property:
12777 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12779 To create an image that is anchored to a page, do the following:
12781 #+ATTR_ODT: :anchor "page"
12785 @node Math formatting in ODT export
12786 @subsection Math formatting in ODT export
12788 The ODT exporter has special support for handling math.
12791 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12792 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12795 @node Working with @LaTeX{} math snippets
12796 @subsubheading Working with @LaTeX{} math snippets
12798 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12799 document in one of the following ways:
12805 This option is activated on a per-file basis with
12811 With this option, @LaTeX{} fragments are first converted into MathML
12812 fragments using an external @LaTeX{}-to-MathML converter program. The
12813 resulting MathML fragments are then embedded as an OpenDocument Formula in
12814 the exported document.
12816 @vindex org-latex-to-mathml-convert-command
12817 @vindex org-latex-to-mathml-jar-file
12819 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12820 @code{org-latex-to-mathml-convert-command} and
12821 @code{org-latex-to-mathml-jar-file}.
12823 To use MathToWeb@footnote{See
12824 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}.} as your
12825 converter, you can configure the above variables as
12828 (setq org-latex-to-mathml-convert-command
12829 "java -jar %j -unicode -force -df %o %I"
12830 org-latex-to-mathml-jar-file
12831 "/path/to/mathtoweb.jar")
12833 To use @LaTeX{}ML@footnote{See @uref{http://dlmf.nist.gov/LaTeXML/}.} use
12835 (setq org-latex-to-mathml-convert-command
12836 "latexmlmath \"%i\" --presentationmathml=%o")
12839 You can use the following commands to quickly verify the reliability of
12840 the @LaTeX{}-to-MathML converter.
12843 @item M-x org-odt-export-as-odf RET
12844 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12846 @item M-x org-odt-export-as-odf-and-open RET
12847 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12848 and open the formula file with the system-registered application.
12853 @cindex imagemagick
12856 This option is activated on a per-file basis with
12859 #+OPTIONS: tex:dvipng
12863 #+OPTIONS: tex:dvisvgm
12869 #+OPTIONS: tex:imagemagick
12872 With this option, @LaTeX{} fragments are processed into PNG or SVG images and
12873 the resulting images are embedded in the exported document. This method requires
12874 that the @file{dvipng} program, @file{dvisvgm} or @file{imagemagick} suite be
12875 available on your system.
12878 @node Working with MathML or OpenDocument formula files
12879 @subsubheading Working with MathML or OpenDocument formula files
12881 For various reasons, you may find embedding @LaTeX{} math snippets in an
12882 ODT document less than reliable. In that case, you can embed a
12883 math equation by linking to its MathML (@file{.mml}) source or its
12884 OpenDocument formula (@file{.odf}) file as shown below:
12896 @node Labels and captions in ODT export
12897 @subsection Labels and captions in ODT export
12899 You can label and caption various category of objects---an inline image, a
12900 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12901 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12902 each labeled or captioned object of a given category separately. As a
12903 result, each such object is assigned a sequence number based on order of its
12904 appearance in the Org file.
12906 In the exported document, a user-provided caption is augmented with the
12907 category and sequence number. Consider the following inline image in an Org
12911 #+CAPTION: Bell curve
12912 #+LABEL: fig:SED-HR4049
12916 It could be rendered as shown below in the exported document.
12919 Figure 2: Bell curve
12922 @vindex org-odt-category-map-alist
12923 You can modify the category component of the caption by customizing the
12924 option @code{org-odt-category-map-alist}. For example, to tag all embedded
12925 images with the string @samp{Illustration} (instead of the default
12926 @samp{Figure}) use the following setting:
12929 (setq org-odt-category-map-alist
12930 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12933 With this, previous image will be captioned as below in the exported
12937 Illustration 2: Bell curve
12940 @node Literal examples in ODT export
12941 @subsection Literal examples in ODT export
12943 Export of literal examples (@pxref{Literal examples}) with full fontification
12944 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
12945 generate all style definitions needed for a fancy listing. The
12946 auto-generated styles have @samp{OrgSrc} as prefix and inherit their color
12947 from the faces used by Emacs @code{font-lock} library for the source
12950 @vindex org-odt-fontify-srcblocks
12951 If you prefer to use your own custom styles for fontification, you can do
12952 so by customizing the option
12953 @code{org-odt-create-custom-styles-for-srcblocks}.
12955 @vindex org-odt-create-custom-styles-for-srcblocks
12956 You can turn off fontification of literal examples by customizing the
12957 option @code{org-odt-fontify-srcblocks}.
12959 @node Advanced topics in ODT export
12960 @subsection Advanced topics in ODT export
12962 If you rely heavily on ODT export, you may want to exploit the full
12963 set of features that the exporter offers. This section describes features
12964 that would be of interest to power users.
12967 * Configuring a document converter:: How to register a document converter
12968 * Working with OpenDocument style files:: Explore the internals
12969 * Creating one-off styles:: How to produce custom highlighting etc
12970 * Customizing tables in ODT export:: How to define and use Table templates
12971 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
12974 @node Configuring a document converter
12975 @subsubheading Configuring a document converter
12977 @cindex doc, docx, rtf
12980 The ODT exporter can work with popular converters with little or no
12981 extra configuration from your side. @xref{Extending ODT export}.
12982 If you are using a converter that is not supported by default or if you would
12983 like to tweak the default converter settings, proceed as below.
12986 @item Register the converter
12988 @vindex org-odt-convert-processes
12989 Name your converter and add it to the list of known converters by
12990 customizing the option @code{org-odt-convert-processes}. Also specify how
12991 the converter can be invoked via command-line to effect the conversion.
12993 @item Configure its capabilities
12995 @vindex org-odt-convert-capabilities
12996 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12997 converter can handle by customizing the variable
12998 @code{org-odt-convert-capabilities}. Use the default value for this
12999 variable as a guide for configuring your converter. As suggested by the
13000 default setting, you can specify the full set of formats supported by the
13001 converter and not limit yourself to specifying formats that are related to
13002 just the OpenDocument Text format.
13004 @item Choose the converter
13006 @vindex org-odt-convert-process
13007 Select the newly added converter as the preferred one by customizing the
13008 option @code{org-odt-convert-process}.
13011 @node Working with OpenDocument style files
13012 @subsubheading Working with OpenDocument style files
13013 @cindex styles, custom
13014 @cindex template, custom
13016 This section explores the internals of the ODT exporter and the
13017 means by which it produces styled documents. Read this section if you are
13018 interested in exploring the automatic and custom OpenDocument styles used by
13021 @anchor{x-factory-styles}
13022 @subsubheading a) Factory styles
13024 The ODT exporter relies on two files for generating its output.
13025 These files are bundled with the distribution under the directory pointed to
13026 by the variable @code{org-odt-styles-dir}. The two files are:
13029 @anchor{x-orgodtstyles-xml}
13031 @file{OrgOdtStyles.xml}
13033 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
13034 document. This file gets modified for the following purposes:
13038 To control outline numbering based on user settings.
13041 To add styles generated by @file{htmlfontify.el} for fontification of code
13045 @anchor{x-orgodtcontenttemplate-xml}
13047 @file{OrgOdtContentTemplate.xml}
13049 This file contributes to the @file{content.xml} file of the final @samp{ODT}
13050 document. The contents of the Org outline are inserted between the
13051 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
13053 Apart from serving as a template file for the final @file{content.xml}, the
13054 file serves the following purposes:
13058 It contains automatic styles for formatting of tables which are referenced by
13062 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
13063 elements that control how various entities---tables, images, equations,
13064 etc.---are numbered.
13068 @anchor{x-overriding-factory-styles}
13069 @subsubheading b) Overriding factory styles
13070 The following two variables control the location from which the ODT
13071 exporter picks up the custom styles and content template files. You can
13072 customize these variables to override the factory styles used by the
13076 @anchor{x-org-odt-styles-file}
13078 @code{org-odt-styles-file}
13080 Use this variable to specify the @file{styles.xml} that will be used in the
13081 final output. You can specify one of the following values:
13084 @item A @file{styles.xml} file
13086 Use this file instead of the default @file{styles.xml}
13088 @item A @file{.odt} or @file{.ott} file
13090 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13093 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
13095 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13096 Template file. Additionally extract the specified member files and embed
13097 those within the final @samp{ODT} document.
13099 Use this option if the @file{styles.xml} file references additional files
13100 like header and footer images.
13104 Use the default @file{styles.xml}
13107 @anchor{x-org-odt-content-template-file}
13109 @code{org-odt-content-template-file}
13111 Use this variable to specify the blank @file{content.xml} that will be used
13112 in the final output.
13115 @node Creating one-off styles
13116 @subsubheading Creating one-off styles
13118 There are times when you would want one-off formatting in the exported
13119 document. You can achieve this by embedding raw OpenDocument XML in the Org
13120 file. The use of this feature is better illustrated with couple of examples.
13123 @item Embedding ODT tags as part of regular text
13125 You can inline OpenDocument syntax by enclosing it within
13126 @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do
13130 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
13131 text</text:span>@@@@. But this is a regular text.
13134 @strong{Hint:} To see the above example in action, edit your
13135 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13136 custom @samp{Highlight} style as shown below.
13139 <style:style style:name="Highlight" style:family="text">
13140 <style:text-properties fo:background-color="#ff0000"/>
13144 @item Embedding a one-line OpenDocument XML
13146 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
13147 directive. For example, to force a page break do the following:
13150 #+ODT: <text:p text:style-name="PageBreak"/>
13153 @strong{Hint:} To see the above example in action, edit your
13154 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13155 custom @samp{PageBreak} style as shown below.
13158 <style:style style:name="PageBreak" style:family="paragraph"
13159 style:parent-style-name="Text_20_body">
13160 <style:paragraph-properties fo:break-before="page"/>
13164 @item Embedding a block of OpenDocument XML
13166 You can add a large block of OpenDocument XML using the @code{#+BEGIN_EXPORT
13167 odt}@dots{}@code{#+END_EXPORT} construct.
13169 For example, to create a one-off paragraph that uses bold text, do the
13174 <text:p text:style-name="Text_20_body_20_bold">
13175 This paragraph is specially formatted and uses bold text.
13182 @node Customizing tables in ODT export
13183 @subsubheading Customizing tables in ODT export
13184 @cindex tables, in ODT export
13187 You can override the default formatting of the table by specifying a custom
13188 table style with the @code{#+ATTR_ODT} line. For a discussion on default
13189 formatting of tables @pxref{Tables in ODT export}.
13191 This feature closely mimics the way table templates are defined in the
13193 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
13194 OpenDocument-v1.2 Specification}}
13196 @vindex org-odt-table-styles
13197 To have a quick preview of this feature, install the below setting and
13198 export the table that follows:
13201 (setq org-odt-table-styles
13202 (append org-odt-table-styles
13203 '(("TableWithHeaderRowAndColumn" "Custom"
13204 ((use-first-row-styles . t)
13205 (use-first-column-styles . t)))
13206 ("TableWithFirstRowandLastRow" "Custom"
13207 ((use-first-row-styles . t)
13208 (use-last-row-styles . t))))))
13212 #+ATTR_ODT: :style TableWithHeaderRowAndColumn
13213 | Name | Phone | Age |
13214 | Peter | 1234 | 17 |
13215 | Anna | 4321 | 25 |
13218 In the above example, you used a template named @samp{Custom} and installed
13219 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
13220 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
13221 styles needed for producing the above template have been pre-defined for
13222 you. These styles are available under the section marked @samp{Custom
13223 Table Template} in @file{OrgOdtContentTemplate.xml}
13224 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
13225 additional templates you have to define these styles yourselves.
13227 To use this feature proceed as follows:
13231 Create a table template@footnote{See the @code{<table:table-template>}
13232 element of the OpenDocument-v1.2 specification}
13234 A table template is nothing but a set of @samp{table-cell} and
13235 @samp{paragraph} styles for each of the following table cell categories:
13249 The names for the above styles must be chosen based on the name of the table
13250 template using a well-defined convention.
13252 The naming convention is better illustrated with an example. For a table
13253 template with the name @samp{Custom}, the needed style names are listed in
13254 the following table.
13256 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
13257 @headitem Table cell type
13258 @tab @code{table-cell} style
13259 @tab @code{paragraph} style
13264 @tab @samp{CustomTableCell}
13265 @tab @samp{CustomTableParagraph}
13267 @tab @samp{CustomFirstColumnTableCell}
13268 @tab @samp{CustomFirstColumnTableParagraph}
13270 @tab @samp{CustomLastColumnTableCell}
13271 @tab @samp{CustomLastColumnTableParagraph}
13273 @tab @samp{CustomFirstRowTableCell}
13274 @tab @samp{CustomFirstRowTableParagraph}
13276 @tab @samp{CustomLastRowTableCell}
13277 @tab @samp{CustomLastRowTableParagraph}
13279 @tab @samp{CustomEvenRowTableCell}
13280 @tab @samp{CustomEvenRowTableParagraph}
13282 @tab @samp{CustomOddRowTableCell}
13283 @tab @samp{CustomOddRowTableParagraph}
13285 @tab @samp{CustomEvenColumnTableCell}
13286 @tab @samp{CustomEvenColumnTableParagraph}
13288 @tab @samp{CustomOddColumnTableCell}
13289 @tab @samp{CustomOddColumnTableParagraph}
13292 To create a table template with the name @samp{Custom}, define the above
13294 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
13295 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
13299 Define a table style@footnote{See the attributes @code{table:template-name},
13300 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
13301 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
13302 @code{table:use-banding-rows-styles}, and
13303 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
13304 the OpenDocument-v1.2 specification}
13306 @vindex org-odt-table-styles
13307 To define a table style, create an entry for the style in the variable
13308 @code{org-odt-table-styles} and specify the following:
13311 @item the name of the table template created in step (1)
13312 @item the set of cell styles in that template that are to be activated
13315 For example, the entry below defines two different table styles
13316 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
13317 based on the same template @samp{Custom}. The styles achieve their intended
13318 effect by selectively activating the individual cell styles in that template.
13321 (setq org-odt-table-styles
13322 (append org-odt-table-styles
13323 '(("TableWithHeaderRowAndColumn" "Custom"
13324 ((use-first-row-styles . t)
13325 (use-first-column-styles . t)))
13326 ("TableWithFirstRowandLastRow" "Custom"
13327 ((use-first-row-styles . t)
13328 (use-last-row-styles . t))))))
13332 Associate a table with the table style
13334 To do this, specify the table style created in step (2) as part of
13335 the @code{ATTR_ODT} line as shown below.
13338 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
13339 | Name | Phone | Age |
13340 | Peter | 1234 | 17 |
13341 | Anna | 4321 | 25 |
13345 @node Validating OpenDocument XML
13346 @subsubheading Validating OpenDocument XML
13348 Occasionally, you will discover that the document created by the
13349 ODT exporter cannot be opened by your favorite application. One of
13350 the common reasons for this is that the @file{.odt} file is corrupt. In such
13351 cases, you may want to validate the document against the OpenDocument RELAX
13352 NG Compact Syntax (RNC) schema.
13354 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
13355 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
13356 general help with validation (and schema-sensitive editing) of XML files:
13357 @inforef{Introduction,,nxml-mode}.
13359 @vindex org-odt-schema-dir
13360 If you have ready access to OpenDocument @file{.rnc} files and the needed
13361 schema-locating rules in a single folder, you can customize the variable
13362 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
13363 will take care of updating the @code{rng-schema-locating-files} for you.
13365 @c end opendocument
13368 @section Org export
13371 @code{org} export back-end creates a normalized version of the Org document
13372 in current buffer. In particular, it evaluates Babel code (@pxref{Evaluating
13373 code blocks}) and removes other back-ends specific contents.
13375 @subheading Org export commands
13378 @orgcmd{C-c C-e O o,org-org-export-to-org}
13379 Export as an Org document. For an Org file, @file{myfile.org}, the resulting
13380 file will be @file{myfile.org.org}. The file will be overwritten without
13382 @orgcmd{C-c C-e O O,org-org-export-as-org}
13383 Export to a temporary buffer. Do not create a file.
13385 Export to an Org file, then open it.
13388 @node Texinfo export
13389 @section Texinfo export
13390 @cindex Texinfo export
13392 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13396 * Texinfo export commands:: How to invoke Texinfo export
13397 * Texinfo specific export settings:: Export settings for Texinfo
13398 * Texinfo file header:: Generating the begining of a Texinfo file
13399 * Texinfo title and copyright page:: Creating title and copyright pages
13400 * Texinfo @samp{Top} node:: Installing a manual in Info Top node
13401 * Headings and sectioning structure:: Building document structure
13402 * Indices:: Creating indices
13403 * Quoting Texinfo code:: Incorporating literal Texinfo code
13404 * Plain lists in Texinfo export:: Specific attributes for plain lists
13405 * Tables in Texinfo export:: Specific attributes for tables
13406 * Images in Texinfo export:: Specific attributes for images
13407 * Special blocks in Texinfo export:: Specific attributes for special blocks
13408 * A Texinfo example:: Illustrating Org to Texinfo process
13411 @node Texinfo export commands
13412 @subsection Texinfo export commands
13414 @vindex org-texinfo-info-process
13416 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13417 Export as a Texinfo file. For an Org file, @file{myfile.org}, the resulting
13418 file will be @file{myfile.texi}. The file will be overwritten without
13420 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13421 Export to Texinfo and then process to an Info file@footnote{By setting
13422 @code{org-texinfo-info-process}, it is possible to generate other formats,
13423 including DocBook.}.
13426 @node Texinfo specific export settings
13427 @subsection Texinfo specific export settings
13428 The Texinfo exporter introduces a number of keywords, similar to the general
13429 options settings described in @ref{Export settings}.
13434 @cindex #+SUBTITLE (Texinfo)
13435 The document subtitle.
13438 @cindex #+SUBAUTHOR
13439 The document subauthor.
13441 @item TEXINFO_FILENAME
13442 @cindex #+TEXINFO_FILENAME
13443 The Texinfo filename.
13445 @item TEXINFO_CLASS
13446 @cindex #+TEXINFO_CLASS
13447 @vindex org-texinfo-default-class
13448 The class of the document (@code{org-texinfo-default-class}). This must be a
13449 member of @code{org-texinfo-classes}.
13451 @item TEXINFO_HEADER
13452 @cindex #+TEXINFO_HEADER
13453 Arbitrary lines inserted at the end of the header.
13455 @item TEXINFO_POST_HEADER
13456 @cindex #+TEXINFO_POST_HEADER
13457 Arbitrary lines inserted after the end of the header.
13459 @item TEXINFO_DIR_CATEGORY
13460 @cindex #+TEXINFO_DIR_CATEGORY
13461 The directory category of the document.
13463 @item TEXINFO_DIR_TITLE
13464 @cindex #+TEXINFO_DIR_TITLE
13465 The directory title of the document.
13467 @item TEXINFO_DIR_DESC
13468 @cindex #+TEXINFO_DIR_DESC
13469 The directory description of the document.
13471 @item TEXINFO_PRINTED_TITLE
13472 @cindex #+TEXINFO_PRINTED_TITLE
13473 The printed title of the document.
13476 @node Texinfo file header
13477 @subsection Texinfo file header
13479 @cindex #+TEXINFO_FILENAME
13480 Upon creating the header of a Texinfo file, the back-end guesses a name for
13481 the Info file to be compiled. This may not be a sensible choice, e.g., if
13482 you want to produce the final document in a different directory. Specify an
13483 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13486 @vindex org-texinfo-coding-system
13487 @vindex org-texinfo-classes
13488 @cindex #+TEXINFO_HEADER
13489 @cindex #+TEXINFO_CLASS
13490 Along with the output file name, the header contains information about the
13491 language (@pxref{Export settings}) and current encoding used@footnote{See
13492 @code{org-texinfo-coding-system} for more information.}. Insert
13493 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13494 @@code@{@@synindex@}.
13496 If you happen to regularly install the same set of commands, it may be easier
13497 to define your own class in @code{org-texinfo-classes}. Set
13498 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13500 @node Texinfo title and copyright page
13501 @subsection Texinfo title and copyright page
13503 @cindex #+TEXINFO_PRINTED_TITLE
13504 The default template includes a title page for hard copy output. The title
13505 and author displayed on this page are extracted from, respectively,
13506 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}). It is
13507 also possible to print a different, more specific, title with
13508 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13509 @code{#+SUBTITLE} keyword. Both expect raw Texinfo code in their value.
13511 @cindex #+SUBAUTHOR
13512 Likewise, information brought by @code{#+AUTHOR} may not be enough. You can
13513 include other authors with several @code{#+SUBAUTHOR} keywords. Values are
13514 also expected to be written in Texinfo code.
13517 #+AUTHOR: Jane Smith
13518 #+SUBAUTHOR: John Doe
13519 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13522 @cindex property, COPYING
13523 Copying material is defined in a dedicated headline with a non-@code{nil}
13524 @code{:COPYING:} property. The contents are inserted within
13525 a @code{@@copying} command at the beginning of the document whereas the
13526 heading itself does not appear in the structure of the document.
13528 Copyright information is printed on the back of the title page.
13536 This is a short example of a complete Texinfo file, version 1.0.
13538 Copyright \copy 2016 Free Software Foundation, Inc.
13541 @node Texinfo @samp{Top} node
13542 @subsection Texinfo @samp{Top} node
13544 @cindex #+TEXINFO_DIR_CATEGORY
13545 @cindex #+TEXINFO_DIR_TITLE
13546 @cindex #+TEXINFO_DIR_DESC
13547 You may ultimately want to install your new Info file in your system. You
13548 can write an appropriate entry in the top level directory specifying its
13549 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13550 @code{#+TEXINFO_DIR_TITLE}. Optionally, you can add a short description
13551 using @code{#+TEXINFO_DIR_DESC}. The following example would write an entry
13552 similar to Org's in the @samp{Top} node.
13555 #+TEXINFO_DIR_CATEGORY: Emacs
13556 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13557 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13560 @node Headings and sectioning structure
13561 @subsection Headings and sectioning structure
13563 @vindex org-texinfo-classes
13564 @vindex org-texinfo-default-class
13565 @cindex #+TEXINFO_CLASS
13566 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13567 Texinfo structuring commands. For example, a top level headline appears as
13568 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13569 otherwise. If you need to use a different set of commands, e.g., to start
13570 with @code{@@part} instead of @code{@@chapter}, install a new class in
13571 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13572 keyword. Export process defaults to @code{org-texinfo-default-class} when
13573 there is no such keyword in the document.
13575 If a headline's level has no associated structuring command, or is below
13576 a certain threshold (@pxref{Export settings}), that headline becomes a list
13579 @cindex property, APPENDIX
13580 As an exception, a headline with a non-@code{nil} @code{:APPENDIX:} property becomes
13581 an appendix, independently on its level and the class used.
13583 @cindex property, DESCRIPTION
13584 Each regular sectioning structure creates a menu entry, named after the
13585 heading. You can provide a different, e.g., shorter, title in
13586 @code{:ALT_TITLE:} property (@pxref{Table of contents}). Optionally, you can
13587 specify a description for the item in @code{:DESCRIPTION:} property. E.g.,
13590 * Controlling Screen Display
13592 :ALT_TITLE: Display
13593 :DESCRIPTION: Controlling Screen Display
13598 @subsection Indices
13606 Index entries are created using dedicated keywords. @samp{texinfo} back-end
13607 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13608 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}. For
13609 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13613 #+CINDEX: Defining indexing entries
13616 @cindex property, INDEX
13617 To generate an index, you need to set the @code{:INDEX:} property of
13618 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13619 The headline is then exported as an unnumbered chapter or section command and
13620 the index is inserted after its contents.
13629 @node Quoting Texinfo code
13630 @subsection Quoting Texinfo code
13632 It is possible to insert raw Texinfo code using any of the following
13636 @cindex #+BEGIN_EXPORT texinfo
13638 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13640 #+TEXINFO: @@need800
13641 This paragraph is preceded by...
13643 #+BEGIN_EXPORT texinfo
13644 @@auindex Johnson, Mark
13645 @@auindex Lakoff, George
13649 @node Plain lists in Texinfo export
13650 @subsection Plain lists in Texinfo export
13651 @cindex #+ATTR_TEXINFO, in plain lists
13653 In Texinfo output, description lists appear as two-column tables, using the
13654 default command @code{@@table}. You can use @code{@@ftable} or
13655 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13656 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13658 @vindex org-texinfo-def-table-markup
13659 In any case, these constructs require a highlighting command for entries in
13660 the list. You can provide one with @code{:indic} attribute. If you do not,
13661 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13665 #+ATTR_TEXINFO: :indic @@asis
13666 - foo :: This is the text for /foo/, with no highlighting.
13669 @node Tables in Texinfo export
13670 @subsection Tables in Texinfo export
13671 @cindex #+ATTR_TEXINFO, in tables
13673 When exporting a table, column widths are deduced from the longest cell in
13674 each column. You can also define them explicitly as fractions of the line
13675 length, using @code{:columns} attribute.
13678 #+ATTR_TEXINFO: :columns .5 .5
13679 | a cell | another cell |
13682 @node Images in Texinfo export
13683 @subsection Images in Texinfo export
13684 @cindex #+ATTR_TEXINFO, in images
13686 Images are links to files with a supported image extension and no
13687 description. Image scaling is set with @code{:width} and @code{:height}
13688 attributes. You can also use @code{:alt} to specify alternate text, as
13692 #+ATTR_TEXINFO: :width 1in :alt Alternate @@i@{text@}
13696 @node Special blocks in Texinfo export
13697 @subsection Special blocks
13698 @cindex #+ATTR_TEXINFO, in special blocks
13700 In Texinfo output, special blocks become commands of the same name. Value of
13701 @code{:options} attribute is added right after the beginning of the command.
13705 #+attr_texinfo: :options org-org-export-to-org ...
13707 A somewhat obsessive function.
13715 @@defun org-org-export-to-org ...
13716 A somewhat obsessive function.
13720 @node A Texinfo example
13721 @subsection A Texinfo example
13723 Here is a thorough example. @inforef{GNU Sample Texts,,texinfo} for an
13724 equivalent Texinfo code.
13727 #+MACRO: version 2.0
13728 #+MACRO: updated last updated 4 March 2014
13730 #+OPTIONS: ':t toc:t author:t email:t
13731 #+TITLE: GNU Sample @{@{@{version@}@}@}
13732 #+AUTHOR: A.U. Thor
13733 #+EMAIL: bug-sample@@gnu.org
13736 #+TEXINFO_FILENAME: sample.info
13737 #+TEXINFO_HEADER: @@syncodeindex pg cp
13739 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13740 #+TEXINFO_DIR_TITLE: sample: (sample)
13741 #+TEXINFO_DIR_DESC: Invoking sample
13743 #+TEXINFO_PRINTED_TITLE: GNU Sample
13744 #+SUBTITLE: for version @{@{@{version@}@}@}, @{@{@{updated@}@}@}
13751 This manual is for GNU Sample (version @{@{@{version@}@}@},
13752 @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13754 Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13758 Permission is granted to copy, distribute and/or modify this
13759 document under the terms of the GNU Free Documentation License,
13760 Version 1.3 or any later version published by the Free Software
13761 Foundation; with no Invariant Sections, with no Front-Cover Texts,
13762 and with no Back-Cover Texts. A copy of the license is included in
13763 the section entitled "GNU Free Documentation License".
13769 #+CINDEX: invoking @@command@{sample@}
13771 This is a sample manual. There is no sample program to invoke, but
13772 if there were, you could see its basic usage and command line
13775 * GNU Free Documentation License
13780 #+TEXINFO: @@include fdl.texi
13788 @node iCalendar export
13789 @section iCalendar export
13790 @cindex iCalendar export
13792 @vindex org-icalendar-include-todo
13793 @vindex org-icalendar-use-deadline
13794 @vindex org-icalendar-use-scheduled
13795 @vindex org-icalendar-categories
13796 @vindex org-icalendar-alarm-time
13797 Some people use Org mode for keeping track of projects, but still prefer a
13798 standard calendar application for anniversaries and appointments. In this
13799 case it can be useful to show deadlines and other time-stamped items in Org
13800 files in the calendar application. Org mode can export calendar information
13801 in the standard iCalendar format. If you also want to have TODO entries
13802 included in the export, configure the variable
13803 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
13804 and TODO items as VTODO@. It will also create events from deadlines that are
13805 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
13806 to set the start and due dates for the TODO entry@footnote{See the variables
13807 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13808 As categories, it will use the tags locally defined in the heading, and the
13809 file/tree category@footnote{To add inherited tags or the TODO state,
13810 configure the variable @code{org-icalendar-categories}.}. See the variable
13811 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13814 @vindex org-icalendar-store-UID
13815 @cindex property, ID
13816 The iCalendar standard requires each entry to have a globally unique
13817 identifier (UID). Org creates these identifiers during export. If you set
13818 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13819 @code{:ID:} property of the entry and re-used next time you report this
13820 entry. Since a single entry can give rise to multiple iCalendar entries (as
13821 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13822 prefixes to the UID, depending on what triggered the inclusion of the entry.
13823 In this way the UID remains unique, but a synchronization program can still
13824 figure out from which entry all the different instances originate.
13827 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13828 Create iCalendar entries for the current buffer and store them in the same
13829 directory, using a file extension @file{.ics}.
13830 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13831 @vindex org-agenda-files
13832 Like @kbd{C-c C-e c f}, but do this for all files in
13833 @code{org-agenda-files}. For each of these files, a separate iCalendar
13834 file will be written.
13835 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13836 @vindex org-icalendar-combined-agenda-file
13837 Create a single large iCalendar file from all files in
13838 @code{org-agenda-files} and write it to the file given by
13839 @code{org-icalendar-combined-agenda-file}.
13842 @vindex org-use-property-inheritance
13843 @vindex org-icalendar-include-body
13844 @cindex property, SUMMARY
13845 @cindex property, DESCRIPTION
13846 @cindex property, LOCATION
13847 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13848 property can be inherited from higher in the hierarchy if you configure
13849 @code{org-use-property-inheritance} accordingly.} properties if the selected
13850 entries have them. If not, the summary will be derived from the headline,
13851 and the description from the body (limited to
13852 @code{org-icalendar-include-body} characters).
13854 How this calendar is best read and updated, depends on the application
13855 you are using. The FAQ covers this issue.
13857 @node Other built-in back-ends
13858 @section Other built-in back-ends
13859 @cindex export back-ends, built-in
13860 @vindex org-export-backends
13862 On top of the aforementioned back-ends, Org comes with other built-in ones:
13865 @item @file{ox-man.el}: export to a man page.
13868 To activate these export back-end, customize @code{org-export-backends} or
13869 load them directly with e.g., @code{(require 'ox-man)}. This will add new
13870 keys in the export dispatcher (@pxref{The export dispatcher}).
13872 See the comment section of these files for more information on how to use
13875 @node Advanced configuration
13876 @section Advanced configuration
13880 @vindex org-export-before-processing-hook
13881 @vindex org-export-before-parsing-hook
13882 Two hooks are run during the first steps of the export process. The first
13883 one, @code{org-export-before-processing-hook} is called before expanding
13884 macros, Babel code and include keywords in the buffer. The second one,
13885 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13886 before parsing the buffer. Their main use is for heavy duties, that is
13887 duties involving structural modifications of the document. For example, one
13888 may want to remove every headline in the buffer during export. The following
13889 code can achieve this:
13893 (defun my-headline-removal (backend)
13894 "Remove all headlines in the current buffer.
13895 BACKEND is the export back-end being used, as a symbol."
13897 (lambda () (delete-region (point) (progn (forward-line) (point))))))
13899 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13903 Note that functions used in these hooks require a mandatory argument,
13904 a symbol representing the back-end used.
13906 @subheading Filters
13908 @cindex Filters, exporting
13909 Filters are lists of functions applied on a specific part of the output from
13910 a given back-end. More explicitly, each time a back-end transforms an Org
13911 object or element into another language, all functions within a given filter
13912 type are called in turn on the string produced. The string returned by the
13913 last function will be the one used in the final output.
13915 There are filter sets for each type of element or object, for plain text,
13916 for the parse tree, for the export options and for the final output. They
13917 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13918 where @code{TYPE} is the type targeted by the filter. Valid types are:
13920 @multitable @columnfractions .33 .33 .33
13933 @item export-snippet
13936 @item footnote-definition
13937 @tab footnote-reference
13939 @item horizontal-rule
13940 @tab inline-babel-call
13941 @tab inline-src-block
13946 @tab latex-environment
13947 @tab latex-fragment
13957 @item property-drawer
13963 @item statistics-cookie
13964 @tab strike-through
13977 For example, the following snippet allows me to use non-breaking spaces in
13978 the Org buffer and get them translated into @LaTeX{} without using the
13979 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13983 (defun my-latex-filter-nobreaks (text backend info)
13984 "Ensure \"_\" are properly handled in LaTeX export."
13985 (when (org-export-derived-backend-p backend 'latex)
13986 (replace-regexp-in-string "_" "~" text)))
13988 (add-to-list 'org-export-filter-plain-text-functions
13989 'my-latex-filter-nobreaks)
13993 Three arguments must be provided to a filter: the code being changed, the
13994 back-end used, and some information about the export process. You can safely
13995 ignore the third argument for most purposes. Note the use of
13996 @code{org-export-derived-backend-p}, which ensures that the filter will only
13997 be applied when using @code{latex} back-end or any other back-end derived
13998 from it (e.g., @code{beamer}).
14000 @subheading Defining filters for individual files
14002 You can customize the export for just a specific file by binding export
14003 filter variables using @code{#+BIND}. Here is an example where we introduce
14004 two filters, one to remove brackets from time stamps, and one to entirely
14005 remove any strike-through text. The functions doing the filtering are
14006 defined in an src block that allows the filter function definitions to exist
14007 in the file itself and ensures that the functions will be there when needed.
14010 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
14011 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
14012 #+begin_src emacs-lisp :exports results :results none
14013 (defun tmp-f-timestamp (s backend info)
14014 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
14015 (defun tmp-f-strike-through (s backend info) "")
14019 @subheading Extending an existing back-end
14021 This is obviously the most powerful customization, since the changes happen
14022 at the parser level. Indeed, some export back-ends are built as extensions
14023 of other ones (e.g., Markdown back-end an extension of HTML back-end).
14025 Extending a back-end means that if an element type is not transcoded by the
14026 new back-end, it will be handled by the original one. Hence you can extend
14027 specific parts of a back-end without too much work.
14029 As an example, imagine we want the @code{ascii} back-end to display the
14030 language used in a source block, when it is available, but only when some
14031 attribute is non-@code{nil}, like the following:
14034 #+ATTR_ASCII: :language t
14037 Because that back-end is lacking in that area, we are going to create a new
14038 back-end, @code{my-ascii} that will do the job.
14042 (defun my-ascii-src-block (src-block contents info)
14043 "Transcode a SRC-BLOCK element from Org to ASCII.
14044 CONTENTS is nil. INFO is a plist used as a communication
14046 (if (not (org-export-read-attribute :attr_ascii src-block :language))
14047 (org-export-with-backend 'ascii src-block contents info)
14049 (format ",--[ %s ]--\n%s`----"
14050 (org-element-property :language src-block)
14051 (replace-regexp-in-string
14053 (org-element-normalize-string
14054 (org-export-format-code-default src-block info)))))))
14056 (org-export-define-derived-backend 'my-ascii 'ascii
14057 :translate-alist '((src-block . my-ascii-src-block)))
14061 The @code{my-ascii-src-block} function looks at the attribute above the
14062 element. If it isn't true, it gives hand to the @code{ascii} back-end.
14063 Otherwise, it creates a box around the code, leaving room for the language.
14064 A new back-end is then created. It only changes its behavior when
14065 translating @code{src-block} type element. Now, all it takes to use the new
14066 back-end is calling the following from an Org buffer:
14069 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
14072 It is obviously possible to write an interactive function for this, install
14073 it in the export dispatcher menu, and so on.
14075 @node Export in foreign buffers
14076 @section Export in foreign buffers
14078 Most built-in back-ends come with a command to convert the selected region
14079 into a selected format and replace this region by the exported output. Here
14080 is a list of such conversion commands:
14083 @item org-html-convert-region-to-html
14084 Convert the selected region into HTML.
14085 @item org-latex-convert-region-to-latex
14086 Convert the selected region into @LaTeX{}.
14087 @item org-texinfo-convert-region-to-texinfo
14088 Convert the selected region into @code{Texinfo}.
14089 @item org-md-convert-region-to-md
14090 Convert the selected region into @code{MarkDown}.
14093 This is particularly useful for converting tables and lists in foreign
14094 buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
14095 use Org commands for editing a list, and finally select and convert the list
14096 with @code{M-x org-html-convert-region-to-html RET}.
14100 @chapter Publishing
14103 Org includes a publishing management system that allows you to configure
14104 automatic HTML conversion of @emph{projects} composed of interlinked org
14105 files. You can also configure Org to automatically upload your exported HTML
14106 pages and related attachments, such as images and source code files, to a web
14109 You can also use Org to convert files into PDF, or even combine HTML and PDF
14110 conversion so that files are available in both formats on the server.
14112 Publishing has been contributed to Org by David O'Toole.
14115 * Configuration:: Defining projects
14116 * Uploading files:: How to get files up on the server
14117 * Sample configuration:: Example projects
14118 * Triggering publication:: Publication commands
14121 @node Configuration
14122 @section Configuration
14124 Publishing needs significant configuration to specify files, destination
14125 and many other properties of a project.
14128 * Project alist:: The central configuration variable
14129 * Sources and destinations:: From here to there
14130 * Selecting files:: What files are part of the project?
14131 * Publishing action:: Setting the function doing the publishing
14132 * Publishing options:: Tweaking HTML/@LaTeX{} export
14133 * Publishing links:: Which links keep working after publishing?
14134 * Sitemap:: Generating a list of all pages
14135 * Generating an index:: An index that reaches across pages
14138 @node Project alist
14139 @subsection The variable @code{org-publish-project-alist}
14140 @cindex org-publish-project-alist
14141 @cindex projects, for publishing
14143 @vindex org-publish-project-alist
14144 Publishing is configured almost entirely through setting the value of one
14145 variable, called @code{org-publish-project-alist}. Each element of the list
14146 configures one project, and may be in one of the two following forms:
14149 ("project-name" :property value :property value ...)
14150 @r{i.e., a well-formed property list with alternating keys and values}
14152 ("project-name" :components ("project-name" "project-name" ...))
14156 In both cases, projects are configured by specifying property values. A
14157 project defines the set of files that will be published, as well as the
14158 publishing configuration to use when publishing those files. When a project
14159 takes the second form listed above, the individual members of the
14160 @code{:components} property are taken to be sub-projects, which group
14161 together files requiring different publishing options. When you publish such
14162 a ``meta-project'', all the components will also be published, in the
14165 @node Sources and destinations
14166 @subsection Sources and destinations for files
14167 @cindex directories, for publishing
14169 Most properties are optional, but some should always be set. In
14170 particular, Org needs to know where to look for source files,
14171 and where to put published files.
14173 @multitable @columnfractions 0.3 0.7
14174 @item @code{:base-directory}
14175 @tab Directory containing publishing source files
14176 @item @code{:publishing-directory}
14177 @tab Directory where output files will be published. You can directly
14178 publish to a web server using a file name syntax appropriate for
14179 the Emacs @file{tramp} package. Or you can publish to a local directory and
14180 use external tools to upload your website (@pxref{Uploading files}).
14181 @item @code{:preparation-function}
14182 @tab Function or list of functions to be called before starting the
14183 publishing process, for example, to run @code{make} for updating files to be
14184 published. Each preparation function is called with a single argument, the
14185 project property list.
14186 @item @code{:completion-function}
14187 @tab Function or list of functions called after finishing the publishing
14188 process, for example, to change permissions of the resulting files. Each
14189 completion function is called with a single argument, the project property
14194 @node Selecting files
14195 @subsection Selecting files
14196 @cindex files, selecting for publishing
14198 By default, all files with extension @file{.org} in the base directory
14199 are considered part of the project. This can be modified by setting the
14201 @multitable @columnfractions 0.25 0.75
14202 @item @code{:base-extension}
14203 @tab Extension (without the dot!) of source files. This actually is a
14204 regular expression. Set this to the symbol @code{any} if you want to get all
14205 files in @code{:base-directory}, even without extension.
14207 @item @code{:exclude}
14208 @tab Regular expression to match file names that should not be
14209 published, even though they have been selected on the basis of their
14212 @item @code{:include}
14213 @tab List of files to be included regardless of @code{:base-extension}
14214 and @code{:exclude}.
14216 @item @code{:recursive}
14217 @tab non-@code{nil} means, check base-directory recursively for files to publish.
14220 @node Publishing action
14221 @subsection Publishing action
14222 @cindex action, for publishing
14224 Publishing means that a file is copied to the destination directory and
14225 possibly transformed in the process. The default transformation is to export
14226 Org files as HTML files, and this is done by the function
14227 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
14228 export}). But you also can publish your content as PDF files using
14229 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
14230 using the corresponding functions.
14232 If you want to publish the Org file as an @code{.org} file but with the
14233 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
14234 function @code{org-org-publish-to-org}. This will produce @file{file.org}
14235 and put it in the publishing directory. If you want a htmlized version of
14236 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
14237 produce @file{file.org.html} in the publishing directory@footnote{If the
14238 publishing directory is the same than the source directory, @file{file.org}
14239 will be exported as @file{file.org.org}, so probably don't want to do this.}.
14241 Other files like images only need to be copied to the publishing destination.
14242 For this you can use @code{org-publish-attachment}. For non-org files, you
14243 always need to specify the publishing function:
14245 @multitable @columnfractions 0.3 0.7
14246 @item @code{:publishing-function}
14247 @tab Function executing the publication of a file. This may also be a
14248 list of functions, which will all be called in turn.
14249 @item @code{:htmlized-source}
14250 @tab non-@code{nil} means, publish htmlized source.
14253 The function must accept three arguments: a property list containing at least
14254 a @code{:publishing-directory} property, the name of the file to be published
14255 and the path to the publishing directory of the output file. It should take
14256 the specified file, make the necessary transformation (if any) and place the
14257 result into the destination folder.
14259 @node Publishing options
14260 @subsection Options for the exporters
14261 @cindex options, for publishing
14263 The property list can be used to set export options during the publishing
14264 process. In most cases, these properties correspond to user variables in
14265 Org. While some properties are available for all export back-ends, most of
14266 them are back-end specific. The following sections list properties along
14267 with the variable they belong to. See the documentation string of these
14268 options for details.
14270 @vindex org-publish-project-alist
14271 When a property is given a value in @code{org-publish-project-alist}, its
14272 setting overrides the value of the corresponding user variable (if any)
14273 during publishing. Options set within a file (@pxref{Export settings}),
14274 however, override everything.
14276 @subsubheading Generic properties
14278 @multitable {@code{:with-sub-superscript}} {@code{org-export-with-sub-superscripts}}
14279 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
14280 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
14281 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
14282 @item @code{:language} @tab @code{org-export-default-language}
14283 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
14284 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
14285 @item @code{:select-tags} @tab @code{org-export-select-tags}
14286 @item @code{:with-author} @tab @code{org-export-with-author}
14287 @item @code{:with-broken-links} @tab @code{org-export-with-broken-links}
14288 @item @code{:with-clocks} @tab @code{org-export-with-clocks}
14289 @item @code{:with-creator} @tab @code{org-export-with-creator}
14290 @item @code{:with-date} @tab @code{org-export-with-date}
14291 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
14292 @item @code{:with-email} @tab @code{org-export-with-email}
14293 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
14294 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
14295 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
14296 @item @code{:with-latex} @tab @code{org-export-with-latex}
14297 @item @code{:with-planning} @tab @code{org-export-with-planning}
14298 @item @code{:with-priority} @tab @code{org-export-with-priority}
14299 @item @code{:with-properties} @tab @code{org-export-with-properties}
14300 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
14301 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
14302 @item @code{:with-tables} @tab @code{org-export-with-tables}
14303 @item @code{:with-tags} @tab @code{org-export-with-tags}
14304 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
14305 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
14306 @item @code{:with-title} @tab @code{org-export-with-title}
14307 @item @code{:with-toc} @tab @code{org-export-with-toc}
14308 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
14311 @subsubheading ASCII specific properties
14313 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
14314 @item @code{:ascii-bullets} @tab @code{org-ascii-bullets}
14315 @item @code{:ascii-caption-above} @tab @code{org-ascii-caption-above}
14316 @item @code{:ascii-charset} @tab @code{org-ascii-charset}
14317 @item @code{:ascii-global-margin} @tab @code{org-ascii-global-margin}
14318 @item @code{:ascii-format-drawer-function} @tab @code{org-ascii-format-drawer-function}
14319 @item @code{:ascii-format-inlinetask-function} @tab @code{org-ascii-format-inlinetask-function}
14320 @item @code{:ascii-headline-spacing} @tab @code{org-ascii-headline-spacing}
14321 @item @code{:ascii-indented-line-width} @tab @code{org-ascii-indented-line-width}
14322 @item @code{:ascii-inlinetask-width} @tab @code{org-ascii-inlinetask-width}
14323 @item @code{:ascii-inner-margin} @tab @code{org-ascii-inner-margin}
14324 @item @code{:ascii-links-to-notes} @tab @code{org-ascii-links-to-notes}
14325 @item @code{:ascii-list-margin} @tab @code{org-ascii-list-margin}
14326 @item @code{:ascii-paragraph-spacing} @tab @code{org-ascii-paragraph-spacing}
14327 @item @code{:ascii-quote-margin} @tab @code{org-ascii-quote-margin}
14328 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
14329 @item @code{:ascii-table-use-ascii-art} @tab @code{org-ascii-table-use-ascii-art}
14330 @item @code{:ascii-table-widen-columns} @tab @code{org-ascii-table-widen-columns}
14331 @item @code{:ascii-text-width} @tab @code{org-ascii-text-width}
14332 @item @code{:ascii-underline} @tab @code{org-ascii-underline}
14333 @item @code{:ascii-verbatim-format} @tab @code{org-ascii-verbatim-format}
14336 @subsubheading Beamer specific properties
14338 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
14339 @item @code{:beamer-theme} @tab @code{org-beamer-theme}
14340 @item @code{:beamer-column-view-format} @tab @code{org-beamer-column-view-format}
14341 @item @code{:beamer-environments-extra} @tab @code{org-beamer-environments-extra}
14342 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
14343 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
14344 @item @code{:beamer-outline-frame-title} @tab @code{org-beamer-outline-frame-title}
14345 @item @code{:beamer-subtitle-format} @tab @code{org-beamer-subtitle-format}
14348 @subsubheading HTML specific properties
14350 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
14351 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
14352 @item @code{:html-checkbox-type} @tab @code{org-html-checkbox-type}
14353 @item @code{:html-container} @tab @code{org-html-container-element}
14354 @item @code{:html-divs} @tab @code{org-html-divs}
14355 @item @code{:html-doctype} @tab @code{org-html-doctype}
14356 @item @code{:html-extension} @tab @code{org-html-extension}
14357 @item @code{:html-footnote-format} @tab @code{org-html-footnote-format}
14358 @item @code{:html-footnote-separator} @tab @code{org-html-footnote-separator}
14359 @item @code{:html-footnotes-section} @tab @code{org-html-footnotes-section}
14360 @item @code{:html-format-drawer-function} @tab @code{org-html-format-drawer-function}
14361 @item @code{:html-format-headline-function} @tab @code{org-html-format-headline-function}
14362 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
14363 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
14364 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
14365 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
14366 @item @code{:html-head} @tab @code{org-html-head}
14367 @item @code{:html-home/up-format} @tab @code{org-html-home/up-format}
14368 @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy}
14369 @item @code{:html-indent} @tab @code{org-html-indent}
14370 @item @code{:html-infojs-options} @tab @code{org-html-infojs-options}
14371 @item @code{:html-infojs-template} @tab @code{org-html-infojs-template}
14372 @item @code{:html-inline-image-rules} @tab @code{org-html-inline-image-rules}
14373 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
14374 @item @code{:html-link-home} @tab @code{org-html-link-home}
14375 @item @code{:html-link-org-files-as-html} @tab @code{org-html-link-org-files-as-html}
14376 @item @code{:html-link-up} @tab @code{org-html-link-up}
14377 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
14378 @item @code{:html-mathjax-options} @tab @code{org-html-mathjax-options}
14379 @item @code{:html-mathjax-template} @tab @code{org-html-mathjax-template}
14380 @item @code{:html-metadata-timestamp-format} @tab @code{org-html-metadata-timestamp-format}
14381 @item @code{:html-postamble-format} @tab @code{org-html-postamble-format}
14382 @item @code{:html-postamble} @tab @code{org-html-postamble}
14383 @item @code{:html-preamble-format} @tab @code{org-html-preamble-format}
14384 @item @code{:html-preamble} @tab @code{org-html-preamble}
14385 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
14386 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
14387 @item @code{:html-table-caption-above} @tab @code{org-html-table-caption-above}
14388 @item @code{:html-table-data-tags} @tab @code{org-html-table-data-tags}
14389 @item @code{:html-table-header-tags} @tab @code{org-html-table-header-tags}
14390 @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags}
14391 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
14392 @item @code{:html-tag-class-prefix} @tab @code{org-html-tag-class-prefix}
14393 @item @code{:html-text-markup-alist} @tab @code{org-html-text-markup-alist}
14394 @item @code{:html-todo-kwd-class-prefix} @tab @code{org-html-todo-kwd-class-prefix}
14395 @item @code{:html-toplevel-hlevel} @tab @code{org-html-toplevel-hlevel}
14396 @item @code{:html-use-infojs} @tab @code{org-html-use-infojs}
14397 @item @code{:html-validation-link} @tab @code{org-html-validation-link}
14398 @item @code{:html-viewport} @tab @code{org-html-viewport}
14399 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
14402 @subsubheading @LaTeX{} specific properties
14404 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}}
14405 @item @code{:latex-active-timestamp-format} @tab @code{org-latex-active-timestamp-format}
14406 @item @code{:latex-caption-above} @tab @code{org-latex-caption-above}
14407 @item @code{:latex-classes} @tab @code{org-latex-classes}
14408 @item @code{:latex-class} @tab @code{org-latex-default-class}
14409 @item @code{:latex-compiler} @tab @code{org-latex-compiler}
14410 @item @code{:latex-default-figure-position} @tab @code{org-latex-default-figure-position}
14411 @item @code{:latex-default-table-environment} @tab @code{org-latex-default-table-environment}
14412 @item @code{:latex-default-table-mode} @tab @code{org-latex-default-table-mode}
14413 @item @code{:latex-diary-timestamp-format} @tab @code{org-latex-diary-timestamp-format}
14414 @item @code{:latex-footnote-defined-format} @tab @code{org-latex-footnote-defined-format}
14415 @item @code{:latex-footnote-separator} @tab @code{org-latex-footnote-separator}
14416 @item @code{:latex-format-drawer-function} @tab @code{org-latex-format-drawer-function}
14417 @item @code{:latex-format-headline-function} @tab @code{org-latex-format-headline-function}
14418 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
14419 @item @code{:latex-hyperref-template} @tab @code{org-latex-hyperref-template}
14420 @item @code{:latex-image-default-height} @tab @code{org-latex-image-default-height}
14421 @item @code{:latex-image-default-option} @tab @code{org-latex-image-default-option}
14422 @item @code{:latex-image-default-width} @tab @code{org-latex-image-default-width}
14423 @item @code{:latex-images-centered} @tab @code{org-latex-images-centered}
14424 @item @code{:latex-inactive-timestamp-format} @tab @code{org-latex-inactive-timestamp-format}
14425 @item @code{:latex-inline-image-rules} @tab @code{org-latex-inline-image-rules}
14426 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
14427 @item @code{:latex-listings-langs} @tab @code{org-latex-listings-langs}
14428 @item @code{:latex-listings-options} @tab @code{org-latex-listings-options}
14429 @item @code{:latex-listings} @tab @code{org-latex-listings}
14430 @item @code{:latex-minted-langs} @tab @code{org-latex-minted-langs}
14431 @item @code{:latex-minted-options} @tab @code{org-latex-minted-options}
14432 @item @code{:latex-prefer-user-labels} @tab @code{org-latex-prefer-user-labels}
14433 @item @code{:latex-subtitle-format} @tab @code{org-latex-subtitle-format}
14434 @item @code{:latex-subtitle-separate} @tab @code{org-latex-subtitle-separate}
14435 @item @code{:latex-table-scientific-notation} @tab @code{org-latex-table-scientific-notation}
14436 @item @code{:latex-tables-booktabs} @tab @code{org-latex-tables-booktabs}
14437 @item @code{:latex-tables-centered} @tab @code{org-latex-tables-centered}
14438 @item @code{:latex-text-markup-alist} @tab @code{org-latex-text-markup-alist}
14439 @item @code{:latex-title-command} @tab @code{org-latex-title-command}
14440 @item @code{:latex-toc-command} @tab @code{org-latex-toc-command}
14443 @subsubheading Markdown specific properties
14445 @multitable {@code{:md-footnotes-section}} {@code{org-md-footnotes-section}}
14446 @item @code{:md-footnote-format} @tab @code{org-md-footnote-format}
14447 @item @code{:md-footnotes-section} @tab @code{org-md-footnotes-section}
14448 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
14451 @subsubheading ODT specific properties
14453 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
14454 @item @code{:odt-content-template-file} @tab @code{org-odt-content-template-file}
14455 @item @code{:odt-display-outline-level} @tab @code{org-odt-display-outline-level}
14456 @item @code{:odt-fontify-srcblocks} @tab @code{org-odt-fontify-srcblocks}
14457 @item @code{:odt-format-drawer-function} @tab @code{org-odt-format-drawer-function}
14458 @item @code{:odt-format-headline-function} @tab @code{org-odt-format-headline-function}
14459 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
14460 @item @code{:odt-inline-formula-rules} @tab @code{org-odt-inline-formula-rules}
14461 @item @code{:odt-inline-image-rules} @tab @code{org-odt-inline-image-rules}
14462 @item @code{:odt-pixels-per-inch} @tab @code{org-odt-pixels-per-inch}
14463 @item @code{:odt-styles-file} @tab @code{org-odt-styles-file}
14464 @item @code{:odt-table-styles} @tab @code{org-odt-table-styles}
14465 @item @code{:odt-use-date-fields} @tab @code{org-odt-use-date-fields}
14468 @subsubheading Texinfo specific properties
14470 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14471 @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format}
14472 @item @code{:texinfo-classes} @tab @code{org-texinfo-classes}
14473 @item @code{:texinfo-class} @tab @code{org-texinfo-default-class}
14474 @item @code{:texinfo-def-table-markup} @tab @code{org-texinfo-def-table-markup}
14475 @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format}
14476 @item @code{:texinfo-filename} @tab @code{org-texinfo-filename}
14477 @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function}
14478 @item @code{:texinfo-format-headline-function} @tab @code{org-texinfo-format-headline-function}
14479 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14480 @item @code{:texinfo-inactive-timestamp-format} @tab @code{org-texinfo-inactive-timestamp-format}
14481 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14482 @item @code{:texinfo-node-description-column} @tab @code{org-texinfo-node-description-column}
14483 @item @code{:texinfo-table-scientific-notation} @tab @code{org-texinfo-table-scientific-notation}
14484 @item @code{:texinfo-tables-verbatim} @tab @code{org-texinfo-tables-verbatim}
14485 @item @code{:texinfo-text-markup-alist} @tab @code{org-texinfo-text-markup-alist}
14488 @node Publishing links
14489 @subsection Links between published files
14490 @cindex links, publishing
14492 To create a link from one Org file to another, you would use something like
14493 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org}
14494 (@pxref{External links}). When published, this link becomes a link to
14495 @file{foo.html}. You can thus interlink the pages of your ``org web''
14496 project and the links will work as expected when you publish them to HTML.
14497 If you also publish the Org source file and want to link to it, use an
14498 @code{http:} link instead of a @code{file:} link, because @code{file:} links
14499 are converted to link to the corresponding @file{html} file.
14501 You may also link to related files, such as images. Provided you are careful
14502 with relative file names, and provided you have also configured Org to upload
14503 the related files, these links will work too. See @ref{Complex example}, for
14504 an example of this usage.
14506 Eventually, links between published documents can contain some search options
14507 (@pxref{Search options}), which will be resolved to the appropriate location
14508 in the linked file. For example, once published to HTML, the following links
14509 all point to a dedicated anchor in @file{foo.html}.
14512 [[file:foo.org::*heading]]
14513 [[file:foo.org::#custom-id]]
14514 [[file:foo.org::target]]
14518 @subsection Generating a sitemap
14519 @cindex sitemap, of published pages
14521 The following properties may be used to control publishing of
14522 a map of files for a given project.
14524 @multitable @columnfractions 0.35 0.65
14525 @item @code{:auto-sitemap}
14526 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14527 or @code{org-publish-all}.
14529 @item @code{:sitemap-filename}
14530 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
14531 becomes @file{sitemap.html}).
14533 @item @code{:sitemap-title}
14534 @tab Title of sitemap page. Defaults to name of file.
14536 @item @code{:sitemap-function}
14537 @tab Plug-in function to use for generation of the sitemap.
14538 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14539 of links to all files in the project.
14541 @item @code{:sitemap-sort-folders}
14542 @tab Where folders should appear in the sitemap. Set this to @code{first}
14543 (default) or @code{last} to display folders first or last,
14544 respectively. Any other value will mix files and folders.
14546 @item @code{:sitemap-sort-files}
14547 @tab How the files are sorted in the site map. Set this to
14548 @code{alphabetically} (default), @code{chronologically} or
14549 @code{anti-chronologically}. @code{chronologically} sorts the files with
14550 older date first while @code{anti-chronologically} sorts the files with newer
14551 date first. @code{alphabetically} sorts the files alphabetically. The date of
14552 a file is retrieved with @code{org-publish-find-date}.
14554 @item @code{:sitemap-ignore-case}
14555 @tab Should sorting be case-sensitive? Default @code{nil}.
14557 @item @code{:sitemap-file-entry-format}
14558 @tab With this option one can tell how a sitemap's entry is formatted in the
14559 sitemap. This is a format string with some escape sequences: @code{%t} stands
14560 for the title of the file, @code{%a} stands for the author of the file and
14561 @code{%d} stands for the date of the file. The date is retrieved with the
14562 @code{org-publish-find-date} function and formatted with
14563 @code{org-publish-sitemap-date-format}. Default @code{%t}.
14565 @item @code{:sitemap-date-format}
14566 @tab Format string for the @code{format-time-string} function that tells how
14567 a sitemap entry's date is to be formatted. This property bypasses
14568 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14570 @item @code{:sitemap-sans-extension}
14571 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14572 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14573 Defaults to @code{nil}.
14577 @node Generating an index
14578 @subsection Generating an index
14579 @cindex index, in a publishing project
14581 Org mode can generate an index across the files of a publishing project.
14583 @multitable @columnfractions 0.25 0.75
14584 @item @code{:makeindex}
14585 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14586 publish it as @file{theindex.html}.
14589 The file will be created when first publishing a project with the
14590 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
14591 "theindex.inc"}. You can then build around this include statement by adding
14592 a title, style information, etc.
14595 Index entries are specified with @code{#+INDEX} keyword. An entry that
14596 contains an exclamation mark will create a sub item.
14601 #+INDEX: Application!CV
14604 @node Uploading files
14605 @section Uploading files
14609 For those people already utilizing third party sync tools such as
14610 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14611 @i{remote} publishing facilities of Org mode which rely heavily on
14612 Tramp. Tramp, while very useful and powerful, tends not to be
14613 so efficient for multiple file transfer and has been known to cause problems
14616 Specialized synchronization utilities offer several advantages. In addition
14617 to timestamp comparison, they also do content and permissions/attribute
14618 checks. For this reason you might prefer to publish your web to a local
14619 directory (possibly even @i{in place} with your Org files) and then use
14620 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14622 Since Unison (for example) can be configured as to which files to transfer to
14623 a certain remote destination, it can greatly simplify the project publishing
14624 definition. Simply keep all files in the correct location, process your Org
14625 files with @code{org-publish} and let the synchronization tool do the rest.
14626 You do not need, in this scenario, to include attachments such as @file{jpg},
14627 @file{css} or @file{gif} files in the project definition since the 3rd party
14630 Publishing to a local directory is also much faster than to a remote one, so
14631 that you can afford more easily to republish entire projects. If you set
14632 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14633 benefit of re-including any changed external files such as source example
14634 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
14635 Org is not smart enough to detect if included files have been modified.
14637 @node Sample configuration
14638 @section Sample configuration
14640 Below we provide two example configurations. The first one is a simple
14641 project publishing only a set of Org files. The second example is
14642 more complex, with a multi-component project.
14645 * Simple example:: One-component publishing
14646 * Complex example:: A multi-component publishing example
14649 @node Simple example
14650 @subsection Example: simple publishing configuration
14652 This example publishes a set of Org files to the @file{public_html}
14653 directory on the local machine.
14656 (setq org-publish-project-alist
14658 :base-directory "~/org/"
14659 :publishing-directory "~/public_html"
14660 :section-numbers nil
14662 :html-head "<link rel=\"stylesheet\"
14663 href=\"../other/mystyle.css\"
14664 type=\"text/css\"/>")))
14667 @node Complex example
14668 @subsection Example: complex publishing configuration
14670 This more complicated example publishes an entire website, including
14671 Org files converted to HTML, image files, Emacs Lisp source code, and
14672 style sheets. The publishing directory is remote and private files are
14675 To ensure that links are preserved, care should be taken to replicate
14676 your directory structure on the web server, and to use relative file
14677 paths. For example, if your Org files are kept in @file{~/org} and your
14678 publishable images in @file{~/images}, you would link to an image with
14681 file:../images/myimage.png
14684 On the web server, the relative path to the image should be the
14685 same. You can accomplish this by setting up an "images" folder in the
14686 right place on the web server, and publishing images to it.
14689 (setq org-publish-project-alist
14691 :base-directory "~/org/"
14692 :base-extension "org"
14693 :publishing-directory "/ssh:user@@host:~/html/notebook/"
14694 :publishing-function org-html-publish-to-html
14695 :exclude "PrivatePage.org" ;; regexp
14697 :section-numbers nil
14699 :html-head "<link rel=\"stylesheet\"
14700 href=\"../other/mystyle.css\" type=\"text/css\"/>"
14704 :base-directory "~/images/"
14705 :base-extension "jpg\\|gif\\|png"
14706 :publishing-directory "/ssh:user@@host:~/html/images/"
14707 :publishing-function org-publish-attachment)
14710 :base-directory "~/other/"
14711 :base-extension "css\\|el"
14712 :publishing-directory "/ssh:user@@host:~/html/other/"
14713 :publishing-function org-publish-attachment)
14714 ("website" :components ("orgfiles" "images" "other"))))
14717 @node Triggering publication
14718 @section Triggering publication
14720 Once properly configured, Org can publish with the following commands:
14723 @orgcmd{C-c C-e P x,org-publish}
14724 Prompt for a specific project and publish all files that belong to it.
14725 @orgcmd{C-c C-e P p,org-publish-current-project}
14726 Publish the project containing the current file.
14727 @orgcmd{C-c C-e P f,org-publish-current-file}
14728 Publish only the current file.
14729 @orgcmd{C-c C-e P a,org-publish-all}
14730 Publish every project.
14733 @vindex org-publish-use-timestamps-flag
14734 Org uses timestamps to track when a file has changed. The above functions
14735 normally only publish changed files. You can override this and force
14736 publishing of all files by giving a prefix argument to any of the commands
14737 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14738 This may be necessary in particular if files include other files via
14739 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14742 @node Working with source code
14743 @chapter Working with source code
14744 @cindex Schulte, Eric
14745 @cindex Davison, Dan
14746 @cindex source code, working with
14748 Source code can be included in Org mode documents using a @samp{src} block,
14752 #+BEGIN_SRC emacs-lisp
14753 (defun org-xor (a b)
14759 Org mode provides a number of features for working with live source code,
14760 including editing of code blocks in their native major-mode, evaluation of
14761 code blocks, converting code blocks into source files (known as @dfn{tangling}
14762 in literate programming), and exporting code blocks and their
14763 results in several formats. This functionality was contributed by Eric
14764 Schulte and Dan Davison, and was originally named Org-babel.
14766 The following sections describe Org mode's code block handling facilities.
14769 * Structure of code blocks:: Code block syntax described
14770 * Editing source code:: Language major-mode editing
14771 * Exporting code blocks:: Export contents and/or results
14772 * Extracting source code:: Create pure source code files
14773 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
14774 * Library of Babel:: Use and contribute to a library of useful code blocks
14775 * Languages:: List of supported code block languages
14776 * Header arguments:: Configure code block functionality
14777 * Results of evaluation:: How evaluation results are handled
14778 * Noweb reference syntax:: Literate programming in Org mode
14779 * Key bindings and useful functions:: Work quickly with code blocks
14780 * Batch execution:: Call functions from the command line
14784 @node Structure of code blocks
14785 @section Structure of code blocks
14786 @cindex code block, structure
14787 @cindex source code, block structure
14789 @cindex #+BEGIN_SRC
14791 Live code blocks can be specified with a @samp{src} block or
14792 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14793 @ref{Easy templates} system} The structure of a @samp{src} block is
14797 #+BEGIN_SRC <language> <switches> <header arguments>
14802 The @code{#+NAME:} line is optional, and can be used to name the code
14803 block. Live code blocks require that a language be specified on the
14804 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
14805 @cindex source code, inline
14807 Live code blocks can also be specified inline using
14810 src_<language>@{<body>@}
14816 src_<language>[<header arguments>]@{<body>@}
14820 @item <#+NAME: name>
14821 This line associates a name with the code block. This is similar to the
14822 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14823 files. Referencing the name of a code block makes it possible to evaluate
14824 the block from other places in the file, from other files, or from Org mode
14825 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
14826 and the behavior of Org mode when two or more blocks share the same name is
14830 The language of the code in the block (see @ref{Languages}).
14831 @cindex source code, language
14833 Optional switches control code block export (see the discussion of switches in
14834 @ref{Literal examples})
14835 @cindex source code, switches
14836 @item <header arguments>
14837 Optional header arguments control many aspects of evaluation, export and
14838 tangling of code blocks (see @ref{Header arguments}).
14839 Header arguments can also be set on a per-buffer or per-subtree
14840 basis using properties.
14841 @item source code, header arguments
14843 Source code in the specified language.
14847 @node Editing source code
14848 @section Editing source code
14849 @cindex code block, editing
14850 @cindex source code, editing
14852 @vindex org-edit-src-auto-save-idle-delay
14853 @vindex org-edit-src-turn-on-auto-save
14855 Use @kbd{C-c '} to edit the current code block. This brings up a language
14856 major-mode edit buffer containing the body of the code block. Manually
14857 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14858 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14859 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14860 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14861 Use @kbd{C-c '} again to exit.
14863 The @code{org-src-mode} minor mode will be active in the edit buffer. The
14864 following variables can be used to configure the behavior of the edit
14865 buffer. See also the customization group @code{org-edit-structure} for
14866 further configuration options.
14869 @item org-src-lang-modes
14870 If an Emacs major-mode named @code{<lang>-mode} exists, where
14871 @code{<lang>} is the language named in the header line of the code block,
14872 then the edit buffer will be placed in that major-mode. This variable
14873 can be used to map arbitrary language names to existing major modes.
14874 @item org-src-window-setup
14875 Controls the way Emacs windows are rearranged when the edit buffer is created.
14876 @item org-src-preserve-indentation
14877 @cindex indentation, in source blocks
14878 By default, the value is @code{nil}, which means that code blocks evaluated
14879 during export or tangled are indented according to context, possibly altering
14880 leading sequences of spaces and tab characters in the process. When
14881 non-@code{nil}, indentation is relative to left column, and therefore, not
14882 modified during export or tangling. This variable is especially useful for
14883 tangling languages such as Python, in which whitespace indentation in the
14884 output is critical.
14885 @item org-src-ask-before-returning-to-edit-buffer
14886 By default, Org will ask before returning to an open edit buffer. Set this
14887 variable to @code{nil} to switch without asking.
14890 To turn on native code fontification in the @emph{Org} buffer, configure the
14891 variable @code{org-src-fontify-natively}. You can also change the appearance
14892 of source blocks by customizing the @code{org-block} face or for specific
14893 languages, by defining @code{org-block-LANGUAGE} faces. The following
14894 example shades the background of ``ordinary'' blocks while allowing Emacs
14895 Lisp source blocks to have a special color.
14898 (set-face-attribute 'org-block nil :background
14900 (face-attribute 'default :background) 3))
14902 (defface org-block-emacs-lisp
14903 '((t (:background "#EEE2FF")))
14904 "Face for Emacs Lisp src blocks")
14907 @node Exporting code blocks
14908 @section Exporting code blocks
14909 @cindex code block, exporting
14910 @cindex source code, exporting
14912 It is possible to export the @emph{code} of code blocks, the @emph{results}
14913 of code block evaluation, @emph{both} the code and the results of code block
14914 evaluation, or @emph{none}. For most languages, the default exports code.
14915 However, for some languages (e.g., @code{ditaa}) the default exports the
14916 results of code block evaluation. For information on exporting code block
14917 bodies, see @ref{Literal examples}. For information on exporting
14918 parts of Org documents, see @ref{Exporting}.
14920 The @code{:exports} header argument can be used to specify export
14921 behavior (note that these arguments are only relevant for code blocks, not
14924 @subsubheading Header arguments:
14927 @cindex @code{:exports}, src header argument
14928 @item :exports code
14929 The default in most languages. The body of the code block is exported, as
14930 described in @ref{Literal examples}.
14931 @item :exports results
14932 The code block will be evaluated each time to buffer is exported, and the
14933 results will be placed in the Org mode buffer for export, either updating
14934 previous results of the code block located anywhere in the buffer or, if no
14935 previous results exist, placing the results immediately after the code block.
14936 The body of the code block will not be exported.
14937 @item :exports both
14938 Both the code block and its results will be exported.
14939 @item :exports none
14940 Neither the code block nor its results will be exported.
14943 It is possible to inhibit the evaluation of code blocks during export.
14944 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14945 ensure that no code blocks are evaluated as part of the export process. This
14946 can be useful in situations where potentially untrusted Org mode files are
14947 exported in an automated fashion, for example when Org mode is used as the
14948 markup language for a wiki. It is also possible to set this variable to
14949 @code{inline-only}. In that case, only inline code blocks will be
14950 evaluated, in order to insert their results. Non-inline code blocks are
14951 assumed to have their results already inserted in the buffer by manual
14952 evaluation. This setting is useful to avoid expensive recalculations during
14953 export, not to provide security.
14955 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
14956 on export. However, code blocks in subtrees excluded from export
14957 (@pxref{Export settings}) may be evaluated on export.
14959 @node Extracting source code
14960 @section Extracting source code
14962 @cindex source code, extracting
14963 @cindex code block, extracting source code
14965 Creating pure source code files by extracting code from source blocks is
14966 referred to as ``tangling''---a term adopted from the literate programming
14967 community. During ``tangling'' of code blocks their bodies are expanded
14968 using @code{org-babel-expand-src-block} which can expand both variable and
14969 ``noweb'' style references (see @ref{Noweb reference syntax}).
14971 @subsubheading Header arguments
14974 @cindex @code{:tangle}, src header argument
14976 The default. The code block is not included in the tangled output.
14978 Include the code block in the tangled output. The output file name is the
14979 name of the org file with the extension @samp{.org} replaced by the extension
14980 for the block language.
14981 @item :tangle filename
14982 Include the code block in the tangled output to file @samp{filename}.
14986 @subsubheading Functions
14989 @item org-babel-tangle
14990 Tangle the current file. Bound to @kbd{C-c C-v t}.
14992 With prefix argument only tangle the current code block.
14993 @item org-babel-tangle-file
14994 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
14997 @subsubheading Hooks
15000 @item org-babel-post-tangle-hook
15001 This hook is run from within code files tangled by @code{org-babel-tangle}.
15002 Example applications could include post-processing, compilation or evaluation
15003 of tangled code files.
15006 @subsubheading Jumping between code and Org
15008 When tangling code from an Org-mode buffer to a source code file, you'll
15009 frequently find yourself viewing the file of tangled source code (e.g., many
15010 debuggers point to lines of the source code file). It is useful to be able
15011 to navigate from the tangled source to the Org-mode buffer from which the
15014 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
15015 code to Org-mode functionality. Two header arguments are required for
15016 jumping to work, first the @code{padline} (@ref{padline}) option must be set
15017 to true (the default setting), second the @code{comments} (@ref{comments})
15018 header argument must be set to @code{link}, which will insert comments into
15019 the source code buffer which point back to the original Org-mode file.
15021 @node Evaluating code blocks
15022 @section Evaluating code blocks
15023 @cindex code block, evaluating
15024 @cindex source code, evaluating
15027 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
15028 potential for that code to do harm. Org mode provides safeguards to ensure
15029 that code is only evaluated after explicit confirmation from the user. For
15030 information on these safeguards (and on how to disable them) see @ref{Code
15031 evaluation security}.} and the results of evaluation optionally placed in the
15032 Org mode buffer. The results of evaluation are placed following a line that
15033 begins by default with @code{#+RESULTS} and optionally a cache identifier
15034 and/or the name of the evaluated code block. The default value of
15035 @code{#+RESULTS} can be changed with the customizable variable
15036 @code{org-babel-results-keyword}.
15038 By default, the evaluation facility is only enabled for Lisp code blocks
15039 specified as @code{emacs-lisp}. See @ref{Languages} to enable other
15040 supported languages. See @ref{Structure of code blocks} for information on
15041 the syntax used to define a code block.
15044 There are a number of ways to evaluate code blocks. The simplest is to press
15045 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
15046 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
15047 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
15048 @code{org-babel-execute-src-block} function to evaluate the block and insert
15049 its results into the Org mode buffer.
15052 It is also possible to evaluate named code blocks from
15053 anywhere@footnote{Actually, the constructs call_<name>() and src_<lang>@{@}
15054 are not evaluated when they appear in a keyword line (i.e. lines starting
15055 with @code{#+KEYWORD:}, @pxref{In-buffer settings}).} in an Org mode buffer
15056 or an Org mode table. These named code blocks can be located in the current
15057 Org mode buffer or in the ``Library of Babel'' (@pxref{Library of Babel}).
15058 Named code blocks can be evaluated with a separate @code{#+CALL:} line or
15059 inline within a block of text. In both cases the result is wrapped according
15060 to the value of @code{org-babel-inline-result-wrap}, which by default is
15061 @code{"=%s="} for markup that produces verbatim text.
15063 The syntax of the @code{#+CALL:} line is
15066 #+CALL: <name>(<arguments>)
15067 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
15070 The syntax for inline evaluation of named code blocks is
15073 ... call_<name>(<arguments>) ...
15074 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
15079 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
15081 Arguments specified in this section will be passed to the code block. These
15082 arguments use standard function call syntax, rather than
15083 header argument syntax. For example, a @code{#+CALL:} line that passes the
15084 number four to a code block named @code{double}, which declares the header
15085 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
15086 @item <inside header arguments>
15087 Inside header arguments are passed through and applied to the named code
15088 block. These arguments use header argument syntax rather than standard
15089 function call syntax. Inside header arguments affect how the code block is
15090 evaluated. For example, @code{[:results output]} will collect the results of
15091 everything printed to @code{STDOUT} during execution of the code block.
15092 @item <end header arguments>
15093 End header arguments are applied to the calling instance and do not affect
15094 evaluation of the named code block. They affect how the results are
15095 incorporated into the Org mode buffer and how the call line is exported. For
15096 example, @code{:results html} will insert the results of the call line
15097 evaluation in the Org buffer, wrapped in a @code{BEGIN_EXPORT html} block.
15099 For more examples of passing header arguments to @code{#+CALL:} lines see
15100 @ref{Header arguments in function calls}.
15103 @node Library of Babel
15104 @section Library of Babel
15105 @cindex babel, library of
15106 @cindex source code, library
15107 @cindex code block, library
15109 The ``Library of Babel'' consists of code blocks that can be called from any
15110 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
15111 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
15112 code blocks} for information on the syntax of remote code block evaluation).
15114 The central repository of code blocks in the ``Library of Babel'' is housed
15115 in an Org mode file located in the @samp{doc} directory of Org mode.
15117 Users can add code blocks they believe to be generally useful to their
15118 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
15119 then loaded into the library with @code{org-babel-lob-ingest}.
15122 Code blocks located in any Org mode file can be loaded into the ``Library of
15123 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
15128 @cindex babel, languages
15129 @cindex source code, languages
15130 @cindex code block, languages
15132 Code blocks in the following languages are supported.
15134 @multitable @columnfractions 0.25 0.25 0.25 0.25
15135 @headitem @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
15136 @item Asymptote @tab asymptote @tab Awk @tab awk
15137 @item C @tab C @tab C++ @tab C++
15138 @item Clojure @tab clojure @tab CSS @tab css
15139 @item D @tab d @tab ditaa @tab ditaa
15140 @item Graphviz @tab dot @tab Emacs Calc @tab calc
15141 @item Emacs Lisp @tab emacs-lisp @tab Fortran @tab fortran
15142 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
15143 @item Java @tab java @tab Javascript @tab js
15144 @item LaTeX @tab latex @tab Ledger @tab ledger
15145 @item Lisp @tab lisp @tab Lilypond @tab lilypond
15146 @item Lua @tab lua @tab MATLAB @tab matlab
15147 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
15148 @item Octave @tab octave @tab Org mode @tab org
15149 @item Oz @tab oz @tab Perl @tab perl
15150 @item Plantuml @tab plantuml @tab Processing.js @tab processing
15151 @item Python @tab python @tab R @tab R
15152 @item Ruby @tab ruby @tab Sass @tab sass
15153 @item Scheme @tab scheme @tab GNU Screen @tab screen
15154 @item Sed @tab sed @tab shell @tab sh
15155 @item SQL @tab sql @tab SQLite @tab sqlite
15158 Language-specific documentation is available for some languages. If
15159 available, it can be found at
15160 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
15162 The option @code{org-babel-load-languages} controls which languages are
15163 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
15164 variable can be set using the customization interface or by adding code like
15165 the following to your emacs configuration.
15167 The following disables @code{emacs-lisp} evaluation and enables evaluation of
15168 @code{R} code blocks.
15171 (org-babel-do-load-languages
15172 'org-babel-load-languages
15173 '((emacs-lisp . nil)
15177 It is also possible to enable support for a language by loading the related
15178 elisp file with @code{require}.
15180 The following adds support for evaluating @code{clojure} code blocks.
15183 (require 'ob-clojure)
15186 @node Header arguments
15187 @section Header arguments
15188 @cindex code block, header arguments
15189 @cindex source code, block header arguments
15191 Code block functionality can be configured with header arguments. This
15192 section provides an overview of the use of header arguments, and then
15193 describes each header argument in detail.
15196 * Using header arguments:: Different ways to set header arguments
15197 * Specific header arguments:: List of header arguments
15200 @node Using header arguments
15201 @subsection Using header arguments
15203 The values of header arguments can be set in several way. When the header
15204 arguments in each layer have been determined, they are combined in order from
15205 the first, least specific (having the lowest priority) up to the last, most
15206 specific (having the highest priority). A header argument with a higher
15207 priority replaces the same header argument specified at lower priority.
15209 * System-wide header arguments:: Set global default values
15210 * Language-specific header arguments:: Set default values by language
15211 * Header arguments in Org mode properties:: Set default values for a buffer or heading
15212 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
15213 * Code block specific header arguments:: The most common way to set values
15214 * Header arguments in function calls:: The most specific level
15218 @node System-wide header arguments
15219 @subsubheading System-wide header arguments
15220 @vindex org-babel-default-header-args
15221 System-wide values of header arguments can be specified by adapting the
15222 @code{org-babel-default-header-args} variable:
15224 @cindex @code{:session}, src header argument
15225 @cindex @code{:results}, src header argument
15226 @cindex @code{:exports}, src header argument
15227 @cindex @code{:cache}, src header argument
15228 @cindex @code{:noweb}, src header argument
15231 :results => "replace"
15237 For example, the following example could be used to set the default value of
15238 @code{:noweb} header arguments to @code{yes}. This would have the effect of
15239 expanding @code{:noweb} references by default when evaluating source code
15243 (setq org-babel-default-header-args
15244 (cons '(:noweb . "yes")
15245 (assq-delete-all :noweb org-babel-default-header-args)))
15248 @node Language-specific header arguments
15249 @subsubheading Language-specific header arguments
15250 Each language can define its own set of default header arguments in variable
15251 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
15252 of the language. See the language-specific documentation available online at
15253 @uref{http://orgmode.org/worg/org-contrib/babel}.
15255 @node Header arguments in Org mode properties
15256 @subsubheading Header arguments in Org mode properties
15258 Buffer-wide header arguments may be specified as properties through the use
15259 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
15260 @ref{Property syntax}).
15262 For example the following would set @code{session} to @code{*R*} (only for R
15263 code blocks), and @code{results} to @code{silent} for every code block in the
15264 buffer, ensuring that all execution took place in the same session, and no
15265 results would be inserted into the buffer.
15268 #+PROPERTY: header-args:R :session *R*
15269 #+PROPERTY: header-args :results silent
15272 Header arguments read from Org mode properties can also be set on a
15273 per-subtree basis using property drawers (see @ref{Property syntax}).
15274 @vindex org-use-property-inheritance
15275 When properties are used to set default header arguments, they are always
15276 looked up with inheritance, regardless of the value of
15277 @code{org-use-property-inheritance}. Properties are evaluated as seen by the
15278 outermost call or source block.
15280 In the following example the value of
15281 the @code{:cache} header argument will default to @code{yes} in all code
15282 blocks in the subtree rooted at the following heading:
15287 :header-args: :cache yes
15292 @vindex org-babel-default-header-args
15293 Properties defined in this way override the properties set in
15294 @code{org-babel-default-header-args} and are applied for all activated
15295 languages. It is convenient to use the @code{org-set-property} function
15296 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
15298 @node Language-specific header arguments in Org mode properties
15299 @subsubheading Language-specific header arguments in Org mode properties
15301 Language-specific header arguments are also read from properties
15302 @code{header-args:<lang>} where @code{<lang>} is the name of the language
15303 targeted. As an example
15308 :header-args:clojure: :session *clojure-1*
15309 :header-args:R: :session *R*
15313 :header-args:clojure: :session *clojure-2*
15317 would independently set a default session header argument for R and clojure
15318 for calls and source blocks under subtree ``Heading'' and change to a
15319 different clojure setting for evaluations under subtree ``Subheading'', while
15320 the R session is inherited from ``Heading'' and therefore unchanged.
15322 @node Code block specific header arguments
15323 @subsubheading Code block specific header arguments
15325 The most common way to assign values to header arguments is at the
15326 code block level. This can be done by listing a sequence of header
15327 arguments and their values as part of the @code{#+BEGIN_SRC} line.
15328 Properties set in this way override both the values of
15329 @code{org-babel-default-header-args} and header arguments specified as
15330 properties. In the following example, the @code{:results} header argument
15331 is set to @code{silent}, meaning the results of execution will not be
15332 inserted in the buffer, and the @code{:exports} header argument is set to
15333 @code{code}, meaning only the body of the code block will be
15334 preserved on export to HTML or @LaTeX{}.
15338 #+BEGIN_SRC haskell :results silent :exports code :var n=0
15340 fac n = n * fac (n-1)
15343 Similarly, it is possible to set header arguments for inline code blocks
15346 src_haskell[:exports both]@{fac 5@}
15349 Code block header arguments can span multiple lines using @code{#+HEADER:} or
15350 @code{#+HEADERS:} lines preceding a code block or nested between the
15351 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
15355 Multi-line header arguments on an un-named code block:
15358 #+HEADERS: :var data1=1
15359 #+BEGIN_SRC emacs-lisp :var data2=2
15360 (message "data1:%S, data2:%S" data1 data2)
15367 Multi-line header arguments on a named code block:
15370 #+NAME: named-block
15371 #+HEADER: :var data=2
15372 #+BEGIN_SRC emacs-lisp
15373 (message "data:%S" data)
15376 #+RESULTS: named-block
15380 @node Header arguments in function calls
15381 @subsubheading Header arguments in function calls
15383 At the most specific level, header arguments for ``Library of Babel'' or
15384 @code{#+CALL:} lines can be set as shown in the two examples below. For more
15385 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
15388 The following will apply the @code{:exports results} header argument to the
15389 evaluation of the @code{#+CALL:} line.
15392 #+CALL: factorial(n=5) :exports results
15395 The following will apply the @code{:session special} header argument to the
15396 evaluation of the @code{factorial} code block.
15399 #+CALL: factorial[:session special](n=5)
15402 @node Specific header arguments
15403 @subsection Specific header arguments
15404 Header arguments consist of an initial colon followed by the name of the
15405 argument in lowercase letters. The following header arguments are defined:
15408 * var:: Pass arguments to code blocks
15409 * results:: Specify the type of results and how they will
15410 be collected and handled
15411 * file:: Specify a path for file output
15412 * file-desc:: Specify a description for file results
15413 * file-ext:: Specify an extension for file output
15414 * output-dir:: Specify a directory to write file output to
15415 * dir:: Specify the default (possibly remote)
15416 directory for code block execution
15417 * exports:: Export code and/or results
15418 * tangle:: Toggle tangling and specify file name
15419 * mkdirp:: Toggle creation of parent directories of target
15420 files during tangling
15421 * comments:: Toggle insertion of comments in tangled
15423 * padline:: Control insertion of padding lines in tangled
15425 * no-expand:: Turn off variable assignment and noweb
15426 expansion during tangling
15427 * session:: Preserve the state of code evaluation
15428 * noweb:: Toggle expansion of noweb references
15429 * noweb-ref:: Specify block's noweb reference resolution target
15430 * noweb-sep:: String used to separate noweb references
15431 * cache:: Avoid re-evaluating unchanged code blocks
15432 * sep:: Delimiter for writing tabular results outside Org
15433 * hlines:: Handle horizontal lines in tables
15434 * colnames:: Handle column names in tables
15435 * rownames:: Handle row names in tables
15436 * shebang:: Make tangled files executable
15437 * tangle-mode:: Set permission of tangled files
15438 * eval:: Limit evaluation of specific code blocks
15439 * wrap:: Mark source block evaluation results
15440 * post:: Post processing of code block results
15441 * prologue:: Text to prepend to code block body
15442 * epilogue:: Text to append to code block body
15445 Additional header arguments are defined on a language-specific basis, see
15449 @subsubsection @code{:var}
15450 @cindex @code{:var}, src header argument
15451 The @code{:var} header argument is used to pass arguments to code blocks.
15452 The specifics of how arguments are included in a code block vary by language;
15453 these are addressed in the language-specific documentation. However, the
15454 syntax used to specify arguments is the same across all languages. In every
15455 case, variables require a default value when they are declared.
15457 The values passed to arguments can either be literal values, references, or
15458 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
15459 References include anything in the Org mode file that takes a @code{#+NAME:}
15460 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
15461 other code blocks and the results of other code blocks.
15463 Note: When a reference is made to another code block, the referenced block
15464 will be evaluated unless it has current cached results (see @ref{cache}).
15466 Argument values can be indexed in a manner similar to arrays (see @ref{var,
15467 Indexable variable values}).
15469 The following syntax is used to pass arguments to code blocks using the
15470 @code{:var} header argument.
15476 The argument, @code{assign}, can either be a literal value, such as a string
15477 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
15478 literal example, another code block (with or without arguments), or the
15479 results of evaluating another code block.
15481 Here are examples of passing values by reference:
15486 an Org mode table named with either a @code{#+NAME:} line
15489 #+NAME: example-table
15495 #+NAME: table-length
15496 #+BEGIN_SRC emacs-lisp :var table=example-table
15500 #+RESULTS: table-length
15505 a simple list named with a @code{#+NAME:} line (note that nesting is not
15506 carried through to the source code block)
15509 #+NAME: example-list
15515 #+BEGIN_SRC emacs-lisp :var x=example-list
15523 @item code block without arguments
15524 a code block name (from the example above), as assigned by @code{#+NAME:},
15525 optionally followed by parentheses
15528 #+BEGIN_SRC emacs-lisp :var length=table-length()
15536 @item code block with arguments
15537 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15538 optional arguments passed within the parentheses following the
15539 code block name using standard function call syntax
15543 #+BEGIN_SRC emacs-lisp :var input=8
15551 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15559 @item literal example
15560 a literal example block named with a @code{#+NAME:} line
15563 #+NAME: literal-example
15569 #+NAME: read-literal-example
15570 #+BEGIN_SRC emacs-lisp :var x=literal-example
15571 (concatenate 'string x " for you.")
15574 #+RESULTS: read-literal-example
15575 : A literal example
15576 : on two lines for you.
15582 @subsubheading Indexable variable values
15583 It is possible to reference portions of variable values by ``indexing'' into
15584 the variables. Indexes are 0 based with negative values counting back from
15585 the end. If an index is separated by @code{,}s then each subsequent section
15586 will index into the next deepest nesting or dimension of the value. Note
15587 that this indexing occurs @emph{before} other table related header arguments
15588 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
15589 following example assigns the last cell of the first row the table
15590 @code{example-table} to the variable @code{data}:
15593 #+NAME: example-table
15599 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15607 Ranges of variable values can be referenced using two integers separated by a
15608 @code{:}, in which case the entire inclusive range is referenced. For
15609 example the following assigns the middle three rows of @code{example-table}
15613 #+NAME: example-table
15620 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15630 Additionally, an empty index, or the single character @code{*}, are both
15631 interpreted to mean the entire range and as such are equivalent to
15632 @code{0:-1}, as shown in the following example in which the entire first
15633 column is referenced.
15636 #+NAME: example-table
15642 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15650 It is possible to index into the results of code blocks as well as tables.
15651 Any number of dimensions can be indexed. Dimensions are separated from one
15652 another by commas, as shown in the following example.
15656 #+BEGIN_SRC emacs-lisp
15657 '(((1 2 3) (4 5 6) (7 8 9))
15658 ((10 11 12) (13 14 15) (16 17 18))
15659 ((19 20 21) (22 23 24) (25 26 27)))
15662 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15670 @subsubheading Emacs Lisp evaluation of variables
15672 Emacs lisp code can be used to initialize variable values. When a variable
15673 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15674 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15675 the variable value. The following example demonstrates use of this
15676 evaluation to reliably pass the file-name of the Org mode buffer to a code
15677 block---note that evaluation of header arguments is guaranteed to take place
15678 in the original Org mode file, while there is no such guarantee for
15679 evaluation of the code block body.
15682 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15687 Note that values read from tables and lists will not be evaluated as
15688 Emacs Lisp, as shown in the following example.
15694 #+HEADERS: :var data=table[0,0]
15704 @subsubsection @code{:results}
15705 @cindex @code{:results}, src header argument
15707 There are four classes of @code{:results} header argument. Only one option
15708 per class may be supplied per code block.
15712 @b{collection} header arguments specify how the results should be collected
15713 from the code block
15715 @b{type} header arguments specify what type of result the code block will
15716 return---which has implications for how they will be processed before
15717 insertion into the Org mode buffer
15719 @b{format} header arguments specify what type of result the code block will
15720 return---which has implications for how they will be inserted into the
15723 @b{handling} header arguments specify how the results of evaluating the code
15724 block should be handled.
15727 @subsubheading Collection
15728 The following options are mutually exclusive, and specify how the results
15729 should be collected from the code block.
15733 This is the default. The result is the value of the last statement in the
15734 code block. This header argument places the evaluation in functional
15735 mode. Note that in some languages, e.g., Python, use of this result type
15736 requires that a @code{return} statement be included in the body of the source
15737 code block. E.g., @code{:results value}.
15738 @item @code{output}
15739 The result is the collection of everything printed to STDOUT during the
15740 execution of the code block. This header argument places the
15741 evaluation in scripting mode. E.g., @code{:results output}.
15744 @subsubheading Type
15746 The following options are mutually exclusive and specify what type of results
15747 the code block will return. By default, results are inserted as either a
15748 table or scalar depending on their value.
15751 @item @code{table}, @code{vector}
15752 The results should be interpreted as an Org mode table. If a single value is
15753 returned, it will be converted into a table with one row and one column.
15754 E.g., @code{:results value table}.
15756 The results should be interpreted as an Org mode list. If a single scalar
15757 value is returned it will be converted into a list with only one element.
15758 @item @code{scalar}, @code{verbatim}
15759 The results should be interpreted literally---they will not be
15760 converted into a table. The results will be inserted into the Org mode
15761 buffer as quoted text. E.g., @code{:results value verbatim}.
15763 The results will be interpreted as the path to a file, and will be inserted
15764 into the Org mode buffer as a file link. E.g., @code{:results value file}.
15767 @subsubheading Format
15769 The following options are mutually exclusive and specify what type of results
15770 the code block will return. By default, results are inserted according to the
15771 type as specified above.
15775 The results are interpreted as raw Org mode code and are inserted directly
15776 into the buffer. If the results look like a table they will be aligned as
15777 such by Org mode. E.g., @code{:results value raw}.
15779 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15780 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15781 in the block and/or if you export the file. E.g., @code{:results value org}.
15783 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_EXPORT
15784 html} block. E.g., @code{:results value html}.
15786 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_EXPORT
15787 latex} block. E.g., @code{:results value latex}.
15789 Result are assumed to be parsable code and are enclosed in a code block.
15790 E.g., @code{:results value code}.
15792 The result is converted to pretty-printed code and is enclosed in a code
15793 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
15794 @code{:results value pp}.
15795 @item @code{drawer}
15796 The result is wrapped in a RESULTS drawer. This can be useful for
15797 inserting @code{raw} or @code{org} syntax results in such a way that their
15798 extent is known and they can be automatically removed or replaced.
15801 @subsubheading Handling
15802 The following results options indicate what happens with the
15803 results once they are collected.
15806 @item @code{silent}
15807 The results will be echoed in the minibuffer but will not be inserted into
15808 the Org mode buffer. E.g., @code{:results output silent}.
15809 @item @code{replace}
15810 The default value. Any existing results will be removed, and the new results
15811 will be inserted into the Org mode buffer in their place. E.g.,
15812 @code{:results output replace}.
15813 @item @code{append}
15814 If there are pre-existing results of the code block then the new results will
15815 be appended to the existing results. Otherwise the new results will be
15816 inserted as with @code{replace}.
15817 @item @code{prepend}
15818 If there are pre-existing results of the code block then the new results will
15819 be prepended to the existing results. Otherwise the new results will be
15820 inserted as with @code{replace}.
15824 @subsubsection @code{:file}
15825 @cindex @code{:file}, src header argument
15827 The header argument @code{:file} is used to specify an external file in which
15828 to save code block results. After code block evaluation an Org mode style
15829 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15830 into the Org mode buffer. Some languages including R, gnuplot, dot, and
15831 ditaa provide special handling of the @code{:file} header argument
15832 automatically wrapping the code block body in the boilerplate code required
15833 to save output to the specified file. This is often useful for saving
15834 graphical output of a code block to the specified file.
15836 The argument to @code{:file} should be either a string specifying the path to
15837 a file, or a list of two strings in which case the first element of the list
15838 should be the path to a file and the second a description for the link.
15841 @subsubsection @code{:file-desc}
15843 The value of the @code{:file-desc} header argument is used to provide a
15844 description for file code block results which are inserted as Org mode links
15845 (see @ref{Link format}). If the @code{:file-desc} header argument is given
15846 with no value the link path will be placed in both the ``link'' and the
15847 ``description'' portion of the Org mode link.
15850 @subsubsection @code{:file-ext}
15851 @cindex @code{:file-ext}, src header argument
15853 The value of the @code{:file-ext} header argument is used to provide an
15854 extension to write the file output to. It is combined with the
15855 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15856 header argument to generate a complete file name.
15858 This header arg will be overridden by @code{:file}, and thus has no effect
15859 when the latter is specified.
15862 @subsubsection @code{:output-dir}
15863 @cindex @code{:output-dir}, src header argument
15865 The value of the @code{:output-dir} header argument is used to provide a
15866 directory to write the file output to. It may specify an absolute directory
15867 (beginning with @code{/}) or a relative directory (without @code{/}). It can
15868 be combined with the @code{#+NAME:} of the source block and the value of the
15869 @ref{file-ext} header argument to generate a complete file name, or used
15870 along with a @ref{file} header arg.
15873 @subsubsection @code{:dir} and remote execution
15874 @cindex @code{:dir}, src header argument
15876 While the @code{:file} header argument can be used to specify the path to the
15877 output file, @code{:dir} specifies the default directory during code block
15878 execution. If it is absent, then the directory associated with the current
15879 buffer is used. In other words, supplying @code{:dir path} temporarily has
15880 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15881 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
15882 the value of the Emacs variable @code{default-directory}.
15884 When using @code{:dir}, you should supply a relative path for file output
15885 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15886 case that path will be interpreted relative to the default directory.
15888 In other words, if you want your plot to go into a folder called @file{Work}
15889 in your home directory, you could use
15892 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15893 matplot(matrix(rnorm(100), 10), type="l")
15897 @subsubheading Remote execution
15898 A directory on a remote machine can be specified using tramp file syntax, in
15899 which case the code will be evaluated on the remote machine. An example is
15902 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15903 plot(1:10, main=system("hostname", intern=TRUE))
15907 Text results will be returned to the local Org mode buffer as usual, and file
15908 output will be created on the remote machine with relative paths interpreted
15909 relative to the remote directory. An Org mode link to the remote file will be
15912 So, in the above example a plot will be created on the remote machine,
15913 and a link of the following form will be inserted in the org buffer:
15916 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15919 Most of this functionality follows immediately from the fact that @code{:dir}
15920 sets the value of the Emacs variable @code{default-directory}, thanks to
15923 @subsubheading Further points
15927 If @code{:dir} is used in conjunction with @code{:session}, although it will
15928 determine the starting directory for a new session as expected, no attempt is
15929 currently made to alter the directory associated with an existing session.
15931 @code{:dir} should typically not be used to create files during export with
15932 @code{:exports results} or @code{:exports both}. The reason is that, in order
15933 to retain portability of exported material between machines, during export
15934 links inserted into the buffer will @emph{not} be expanded against @code{default
15935 directory}. Therefore, if @code{default-directory} is altered using
15936 @code{:dir}, it is probable that the file will be created in a location to
15937 which the link does not point.
15941 @subsubsection @code{:exports}
15942 @cindex @code{:exports}, src header argument
15944 The @code{:exports} header argument specifies what should be included in HTML
15945 or @LaTeX{} exports of the Org mode file. Note that the @code{:exports}
15946 option is only relevant for code blocks, not inline code.
15950 The default. The body of code is included into the exported file. E.g.,
15951 @code{:exports code}.
15952 @item @code{results}
15953 The result of evaluating the code is included in the exported file. E.g.,
15954 @code{:exports results}.
15956 Both the code and results are included in the exported file. E.g.,
15957 @code{:exports both}.
15959 Nothing is included in the exported file. E.g., @code{:exports none}.
15963 @subsubsection @code{:tangle}
15964 @cindex @code{:tangle}, src header argument
15966 The @code{:tangle} header argument specifies whether or not the code
15967 block should be included in tangled extraction of source code files.
15970 @item @code{tangle}
15971 The code block is exported to a source code file named after the full path
15972 (including the directory) and file name (w/o extension) of the Org mode file.
15973 E.g., @code{:tangle yes}.
15975 The default. The code block is not exported to a source code file.
15976 E.g., @code{:tangle no}.
15978 Any other string passed to the @code{:tangle} header argument is interpreted
15979 as a path (directory and file name relative to the directory of the Org mode
15980 file) to which the block will be exported. E.g., @code{:tangle path}.
15984 @subsubsection @code{:mkdirp}
15985 @cindex @code{:mkdirp}, src header argument
15987 The @code{:mkdirp} header argument can be used to create parent directories
15988 of tangled files when missing. This can be set to @code{yes} to enable
15989 directory creation or to @code{no} to inhibit directory creation.
15992 @subsubsection @code{:comments}
15993 @cindex @code{:comments}, src header argument
15994 By default code blocks are tangled to source-code files without any insertion
15995 of comments beyond those which may already exist in the body of the code
15996 block. The @code{:comments} header argument can be set as follows to control
15997 the insertion of extra comments into the tangled code file.
16001 The default. No extra comments are inserted during tangling.
16003 The code block is wrapped in comments which contain pointers back to the
16004 original Org file from which the code was tangled.
16006 A synonym for ``link'' to maintain backwards compatibility.
16008 Include text from the Org mode file as a comment.
16009 The text is picked from the leading context of the tangled code and is
16010 limited by the nearest headline or source block as the case may be.
16012 Turns on both the ``link'' and ``org'' comment options.
16014 Turns on the ``link'' comment option, and additionally wraps expanded noweb
16015 references in the code block body in link comments.
16019 @subsubsection @code{:padline}
16020 @cindex @code{:padline}, src header argument
16021 Control in insertion of padding lines around code block bodies in tangled
16022 code files. The default value is @code{yes} which results in insertion of
16023 newlines before and after each tangled code block. The following arguments
16028 Insert newlines before and after each code block body in tangled code files.
16030 Do not insert any newline padding in tangled output.
16034 @subsubsection @code{:no-expand}
16035 @cindex @code{:no-expand}, src header argument
16037 By default, code blocks are expanded with @code{org-babel-expand-src-block}
16038 during tangling. This has the effect of assigning values to variables
16039 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
16040 references (see @ref{Noweb reference syntax}) with their targets. The
16041 @code{:no-expand} header argument can be used to turn off this behavior.
16042 Note: The @code{:no-expand} header argument has no impact on export,
16043 i.e. code blocks will irrespective of this header argument expanded for
16047 @subsubsection @code{:session}
16048 @cindex @code{:session}, src header argument
16050 The @code{:session} header argument starts a (possibly named) session for an
16051 interpreted language where the interpreter’s state is preserved. All code
16052 blocks sharing the same name are exectuted by the same interpreter process.
16053 By default, a session is not started.
16057 The default. Each block is evaluated in its own interpreter process, which
16058 is terminated after the evaluation.
16060 Any other string passed to the @code{:session} header argument will give the
16061 session a name. For example, @code{:session mysession}. If @code{:session}
16062 is given but no name string is specified, the session is named according to
16063 the language used in the block. All blocks with the same session name share
16064 the same session. Using different session names enables concurrent sessions
16065 (even for the same interpreted language, if the language supports multiple
16071 @subsubsection @code{:noweb}
16072 @cindex @code{:noweb}, src header argument
16074 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
16075 references (see @ref{Noweb reference syntax}) when the code block is
16076 evaluated, tangled, or exported. The @code{:noweb} header argument can have
16077 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
16078 @code{no-export} @code{strip-export}.
16082 The default. ``Noweb'' syntax references in the body of the code block will
16083 not be expanded before the code block is evaluated, tangled or exported.
16085 ``Noweb'' syntax references in the body of the code block will be
16086 expanded before the code block is evaluated, tangled or exported.
16087 @item @code{tangle}
16088 ``Noweb'' syntax references in the body of the code block will be expanded
16089 before the code block is tangled. However, ``noweb'' syntax references will
16090 not be expanded when the code block is evaluated or exported.
16091 @item @code{no-export}
16092 ``Noweb'' syntax references in the body of the code block will be expanded
16093 before the block is evaluated or tangled. However, ``noweb'' syntax
16094 references will not be expanded when the code block is exported.
16095 @item @code{strip-export}
16096 ``Noweb'' syntax references in the body of the code block will be expanded
16097 before the block is evaluated or tangled. However, ``noweb'' syntax
16098 references will be removed when the code block is exported.
16100 ``Noweb'' syntax references in the body of the code block will only be
16101 expanded before the block is evaluated.
16104 @subsubheading Noweb prefix lines
16105 Noweb insertions are now placed behind the line prefix of the
16106 @code{<<reference>>}.
16107 This behavior is illustrated in the following example. Because the
16108 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
16109 each line of the expanded noweb reference will be commented.
16121 -- multi-line body of example
16124 Note that noweb replacement text that does not contain any newlines will not
16125 be affected by this change, so it is still possible to use inline noweb
16129 @subsubsection @code{:noweb-ref}
16130 @cindex @code{:noweb-ref}, src header argument
16131 When expanding ``noweb'' style references, the bodies of all code block with
16132 @emph{either} a block name matching the reference name @emph{or} a
16133 @code{:noweb-ref} header argument matching the reference name will be
16134 concatenated together to form the replacement text.
16136 By setting this header argument at the subtree or file level, simple code
16137 block concatenation may be achieved. For example, when tangling the
16138 following Org mode file, the bodies of code blocks will be concatenated into
16139 the resulting pure code file@footnote{(The example needs property inheritance
16140 to be turned on for the @code{noweb-ref} property, see @ref{Property
16144 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
16147 * the mount point of the fullest disk
16149 :noweb-ref: fullest-disk
16152 ** query all mounted disks
16157 ** strip the header row
16162 ** sort by the percent full
16164 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
16167 ** extract the mount point
16169 |awk '@{print $2@}'
16173 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
16174 used to separate accumulate noweb references like those above. By default a
16178 @subsubsection @code{:noweb-sep}
16179 @cindex @code{:noweb-sep}, src header argument
16181 The @code{:noweb-sep} header argument holds the string used to separate
16182 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
16186 @subsubsection @code{:cache}
16187 @cindex @code{:cache}, src header argument
16189 The @code{:cache} header argument controls the use of in-buffer caching of
16190 the results of evaluating code blocks. It can be used to avoid re-evaluating
16191 unchanged code blocks. When the cache is active, a source block is not
16192 re-evaluated if a result for it is present in the buffer and neither the
16193 header arguments (including the value of @code{:var} references) nor the text
16194 of the block itself has changed since the result was computed. The feature
16195 helps avoid re-running long calculations. However, there are edge cases and
16196 you should not rely on the cache to behave reliably in all circumstances.
16198 The caching feature works best when a babel block is a pure function of its
16199 arguments (@pxref{var}). That is, the function always returns the same
16200 results when given the same arguments, and does not touch external resources
16201 (like the filesystem or the language’s RNG) in any way.@footnote{The
16202 documentation of the knitr reproducible research package for the R language
16203 has some good discussion of issues that may arise when using the cache in
16204 such a context. See @uref{http://yihui.name/knitr/demo/cache/}, especially
16205 the sections ``Even more stuff for cache?'' and ``Reproducibility with RNG''.
16206 (Obviously, you will have to abstract away from the knitr implementation
16207 details which the documentation also discusses.)}
16209 Note that the @code{:cache} header argument will attempt to cache results
16210 when the @code{:session} header argument is used, even though the results of
16211 the code block execution stored in the session may lead to unexpected
16214 Noweb references (@pxref{Noweb reference syntax}) are currently not expanded
16215 when calculating whether the text of the code block has changed. Perhaps in
16216 principle they ought to be, but this could introduce unexpected complexity.
16217 See @uref{http://thread.gmane.org/gmane.emacs.orgmode/79046}.
16219 The @code{:cache} header argument can have one of two values: @code{yes} or
16224 The default. No caching takes place, and the code block will be evaluated
16225 every time it is called.
16227 Every time the code block is run a SHA1 hash of the code and arguments
16228 passed to the block will be generated. This hash is packed into the
16229 @code{#+RESULTS:} line and will be checked on subsequent
16230 executions of the code block. If the code block has not
16231 changed since the last time it was evaluated, it will not be re-evaluated.
16234 Code block caches notice if the value of a variable argument
16235 to the code block has changed. If this is the case, the cache is
16236 invalidated and the code block is re-run. In the following example,
16237 @code{caller} will not be re-run unless the results of @code{random} have
16238 changed since it was last run.
16242 #+BEGIN_SRC R :cache yes
16246 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
16250 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
16254 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
16259 @subsubsection @code{:sep}
16260 @cindex @code{:sep}, src header argument
16262 The @code{:sep} header argument can be used to control the delimiter used
16263 when writing tabular results out to files external to Org mode. This is used
16264 either when opening tabular results of a code block by calling the
16265 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
16266 or when writing code block results to an external file (see @ref{file})
16269 By default, when @code{:sep} is not specified output tables are tab
16273 @subsubsection @code{:hlines}
16274 @cindex @code{:hlines}, src header argument
16276 Tables are frequently represented with one or more horizontal lines, or
16277 hlines. The @code{:hlines} argument to a code block accepts the
16278 values @code{yes} or @code{no}, with a default value of @code{no}.
16282 Strips horizontal lines from the input table. In most languages this is the
16283 desired effect because an @code{hline} symbol is interpreted as an unbound
16284 variable and raises an error. Setting @code{:hlines no} or relying on the
16285 default value yields the following results.
16296 #+BEGIN_SRC python :var tab=many-cols
16300 #+RESULTS: echo-table
16307 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
16318 #+BEGIN_SRC python :var tab=many-cols :hlines yes
16322 #+RESULTS: echo-table
16332 @subsubsection @code{:colnames}
16333 @cindex @code{:colnames}, src header argument
16335 The @code{:colnames} header argument accepts the values @code{yes},
16336 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
16337 Note that the behavior of the @code{:colnames} header argument may differ
16342 If an input table looks like it has column names
16343 (because its second row is an hline), then the column
16344 names will be removed from the table before
16345 processing, then reapplied to the results.
16354 #+NAME: echo-table-again
16355 #+BEGIN_SRC python :var tab=less-cols
16356 return [[val + '*' for val in row] for row in tab]
16359 #+RESULTS: echo-table-again
16366 Please note that column names are not removed before the table is indexed
16367 using variable indexing @xref{var, Indexable variable values}.
16370 No column name pre-processing takes place
16373 Column names are removed and reapplied as with @code{nil} even if the table
16374 does not ``look like'' it has column names (i.e., the second row is not an
16379 @subsubsection @code{:rownames}
16380 @cindex @code{:rownames}, src header argument
16382 The @code{:rownames} header argument can take on the values @code{yes} or
16383 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
16384 blocks ignore the @code{:rownames} header argument entirely given the ease
16385 with which tables with row names may be handled directly in Emacs Lisp.
16389 No row name pre-processing will take place.
16392 The first column of the table is removed from the table before processing,
16393 and is then reapplied to the results.
16396 #+NAME: with-rownames
16397 | one | 1 | 2 | 3 | 4 | 5 |
16398 | two | 6 | 7 | 8 | 9 | 10 |
16400 #+NAME: echo-table-once-again
16401 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
16402 return [[val + 10 for val in row] for row in tab]
16405 #+RESULTS: echo-table-once-again
16406 | one | 11 | 12 | 13 | 14 | 15 |
16407 | two | 16 | 17 | 18 | 19 | 20 |
16410 Please note that row names are not removed before the table is indexed using
16411 variable indexing @xref{var, Indexable variable values}.
16416 @subsubsection @code{:shebang}
16417 @cindex @code{:shebang}, src header argument
16419 Setting the @code{:shebang} header argument to a string value
16420 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
16421 first line of any tangled file holding the code block, and the file
16422 permissions of the tangled file are set to make it executable.
16426 @subsubsection @code{:tangle-mode}
16427 @cindex @code{:tangle-mode}, src header argument
16429 The @code{tangle-mode} header argument controls the permission set on tangled
16430 files. The value of this header argument will be passed to
16431 @code{set-file-modes}. For example, to set a tangled file as read only use
16432 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
16433 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
16434 (@ref{shebang}) header arguments will automatically be made executable unless
16435 the @code{tangle-mode} header argument is also used. The behavior is
16436 undefined if multiple code blocks with different values for the
16437 @code{tangle-mode} header argument are tangled to the same file.
16440 @subsubsection @code{:eval}
16441 @cindex @code{:eval}, src header argument
16442 The @code{:eval} header argument can be used to limit the evaluation of
16443 specific code blocks. The @code{:eval} header argument can be useful for
16444 protecting against the evaluation of dangerous code blocks or to ensure that
16445 evaluation will require a query regardless of the value of the
16446 @code{org-confirm-babel-evaluate} variable. The possible values of
16447 @code{:eval} and their effects are shown below.
16451 The code block will not be evaluated under any circumstances.
16453 Evaluation of the code block will require a query.
16454 @item never-export or no-export
16455 The code block will not be evaluated during export but may still be called
16458 Evaluation of the code block during export will require a query.
16461 If this header argument is not set then evaluation is determined by the value
16462 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
16466 @subsubsection @code{:wrap}
16467 @cindex @code{:wrap}, src header argument
16468 The @code{:wrap} header argument is used to mark the results of source block
16469 evaluation. The header argument can be passed a string that will be appended
16470 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
16471 results. If not string is specified then the results will be wrapped in a
16472 @code{#+BEGIN/END_RESULTS} block.
16475 @subsubsection @code{:post}
16476 @cindex @code{:post}, src header argument
16477 The @code{:post} header argument is used to post-process the results of a
16478 code block execution. When a post argument is given, the results of the code
16479 block will temporarily be bound to the @code{*this*} variable. This variable
16480 may then be included in header argument forms such as those used in @ref{var}
16481 header argument specifications allowing passing of results to other code
16482 blocks, or direct execution via Emacs Lisp. Additional header arguments may
16483 be passed to the @code{:post}-function.
16485 The following two examples illustrate the usage of the @code{:post} header
16486 argument. The first example shows how to attach a attribute-line via @code{:post}.
16490 #+begin_src sh :var data="" :var width="\\textwidth" :results output
16491 echo "#+ATTR_LATEX: :width $width"
16495 #+header: :file /tmp/it.png
16496 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
16506 #+ATTR_LATEX :width 5cm
16507 [[file:/tmp/it.png]]
16511 The second examples shows how to use @code{:post} together with the
16512 @code{:colnames} header argument.
16515 #+begin_src emacs-lisp :var tbl="" fmt="%.3f"
16516 (mapcar (lambda (row)
16517 (mapcar (lambda (cell)
16525 #+begin_src R :colnames yes :post round-tbl[:colnames yes](*this*)
16527 data.frame(foo=rnorm(1))
16537 @subsubsection @code{:prologue}
16538 @cindex @code{:prologue}, src header argument
16539 The value of the @code{prologue} header argument will be prepended to the
16540 code block body before execution. For example, @code{:prologue "reset"} may
16541 be used to reset a gnuplot session before execution of a particular code
16542 block, or the following configuration may be used to do this for all gnuplot
16543 code blocks. Also see @ref{epilogue}.
16546 (add-to-list 'org-babel-default-header-args:gnuplot
16547 '((:prologue . "reset")))
16551 @subsubsection @code{:epilogue}
16552 @cindex @code{:epilogue}, src header argument
16553 The value of the @code{epilogue} header argument will be appended to the code
16554 block body before execution. Also see @ref{prologue}.
16556 @node Results of evaluation
16557 @section Results of evaluation
16558 @cindex code block, results of evaluation
16559 @cindex source code, results of evaluation
16561 The way in which results are handled depends on whether a session is invoked,
16562 as well as on whether @code{:results value} or @code{:results output} is
16563 used. The following table shows the table possibilities. For a full listing
16564 of the possible results header arguments see @ref{results}.
16566 @multitable @columnfractions 0.26 0.33 0.41
16567 @item @tab @b{Non-session} @tab @b{Session}
16568 @item @code{:results value} @tab value of last expression @tab value of last expression
16569 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16572 Note: With @code{:results value}, the result in both @code{:session} and
16573 non-session is returned to Org mode as a table (a one- or two-dimensional
16574 vector of strings or numbers) when appropriate.
16576 @subsection Non-session
16577 @subsubsection @code{:results value}
16578 @cindex @code{:results}, src header argument
16579 This is the default. Internally, the value is obtained by wrapping the code
16580 in a function definition in the external language, and evaluating that
16581 function. Therefore, code should be written as if it were the body of such a
16582 function. In particular, note that Python does not automatically return a
16583 value from a function unless a @code{return} statement is present, and so a
16584 @samp{return} statement will usually be required in Python.
16586 This is the only one of the four evaluation contexts in which the code is
16587 automatically wrapped in a function definition.
16589 @subsubsection @code{:results output}
16590 @cindex @code{:results}, src header argument
16591 The code is passed to the interpreter as an external process, and the
16592 contents of the standard output stream are returned as text. (In certain
16593 languages this also contains the error output stream; this is an area for
16596 @subsection Session
16597 @subsubsection @code{:results value}
16598 @cindex @code{:results}, src header argument
16599 The code is passed to an interpreter running as an interactive Emacs inferior
16600 process. Only languages which provide tools for interactive evaluation of
16601 code have session support, so some language (e.g., C and ditaa) do not
16602 support the @code{:session} header argument, and in other languages (e.g.,
16603 Python and Haskell) which have limitations on the code which may be entered
16604 into interactive sessions, those limitations apply to the code in code blocks
16605 using the @code{:session} header argument as well.
16607 Unless the @code{:results output} option is supplied (see below) the result
16608 returned is the result of the last evaluation performed by the
16609 interpreter. (This is obtained in a language-specific manner: the value of
16610 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16613 @subsubsection @code{:results output}
16614 @cindex @code{:results}, src header argument
16615 The code is passed to the interpreter running as an interactive Emacs
16616 inferior process. The result returned is the concatenation of the sequence of
16617 (text) output from the interactive interpreter. Notice that this is not
16618 necessarily the same as what would be sent to @code{STDOUT} if the same code
16619 were passed to a non-interactive interpreter running as an external
16620 process. For example, compare the following two blocks:
16623 #+BEGIN_SRC python :results output
16634 In non-session mode, the ``2'' is not printed and does not appear.
16637 #+BEGIN_SRC python :results output :session
16649 But in @code{:session} mode, the interactive interpreter receives input ``2''
16650 and prints out its value, ``2''. (Indeed, the other print statements are
16653 @node Noweb reference syntax
16654 @section Noweb reference syntax
16655 @cindex code block, noweb reference
16656 @cindex syntax, noweb
16657 @cindex source code, noweb reference
16659 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16660 Programming system allows named blocks of code to be referenced by using the
16661 familiar Noweb syntax:
16664 <<code-block-name>>
16667 When a code block is tangled or evaluated, whether or not ``noweb''
16668 references are expanded depends upon the value of the @code{:noweb} header
16669 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
16670 evaluation. If @code{:noweb no}, the default, then the reference is not
16671 expanded before evaluation. See the @ref{noweb-ref} header argument for
16672 a more flexible way to resolve noweb references.
16674 It is possible to include the @emph{results} of a code block rather than the
16675 body. This is done by appending parenthesis to the code block name which may
16676 optionally contain arguments to the code block as shown below.
16679 <<code-block-name(optional arguments)>>
16682 Note: the default value, @code{:noweb no}, was chosen to ensure that
16683 correct code is not broken in a language, such as Ruby, where
16684 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
16685 syntactically valid in languages that you use, then please consider setting
16688 Note: if noweb tangling is slow in large Org mode files consider setting the
16689 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16690 This will result in faster noweb reference resolution at the expense of not
16691 correctly resolving inherited values of the @code{:noweb-ref} header
16694 @node Key bindings and useful functions
16695 @section Key bindings and useful functions
16696 @cindex code block, key bindings
16698 Many common Org mode key sequences are re-bound depending on
16701 Within a code block, the following key bindings
16704 @multitable @columnfractions 0.25 0.75
16706 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16708 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16710 @item @kbd{M-@key{up}} @tab @code{org-babel-load-in-session}
16712 @item @kbd{M-@key{down}} @tab @code{org-babel-switch-to-session}
16715 In an Org mode buffer, the following key bindings are active:
16717 @multitable @columnfractions 0.45 0.55
16719 @kindex C-c C-v C-p
16720 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16722 @kindex C-c C-v C-n
16723 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16725 @kindex C-c C-v C-e
16726 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16728 @kindex C-c C-v C-o
16729 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16731 @kindex C-c C-v C-v
16732 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16734 @kindex C-c C-v C-u
16735 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16737 @kindex C-c C-v C-g
16738 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16740 @kindex C-c C-v C-r
16741 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16743 @kindex C-c C-v C-b
16744 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16746 @kindex C-c C-v C-s
16747 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16749 @kindex C-c C-v C-d
16750 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16752 @kindex C-c C-v C-t
16753 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16755 @kindex C-c C-v C-f
16756 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16758 @kindex C-c C-v C-c
16759 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16761 @kindex C-c C-v C-j
16762 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16764 @kindex C-c C-v C-l
16765 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16767 @kindex C-c C-v C-i
16768 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16770 @kindex C-c C-v C-I
16771 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16773 @kindex C-c C-v C-z
16774 @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}
16776 @kindex C-c C-v C-a
16777 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16779 @kindex C-c C-v C-h
16780 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16782 @kindex C-c C-v C-x
16783 @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}
16786 @c When possible these key bindings were extended to work when the control key is
16787 @c kept pressed, resulting in the following additional key bindings.
16789 @c @multitable @columnfractions 0.25 0.75
16790 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16791 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16792 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16793 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16794 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16795 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16796 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16797 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16800 @node Batch execution
16801 @section Batch execution
16802 @cindex code block, batch execution
16803 @cindex source code, batch execution
16805 It is possible to call functions from the command line. This shell
16806 script calls @code{org-babel-tangle} on every one of its arguments.
16808 Be sure to adjust the paths to fit your system.
16812 # -*- mode: shell-script -*-
16814 # tangle files with org-mode
16819 # wrap each argument in the code required to call tangle on it
16821 FILES="$FILES \"$i\""
16826 (require 'org)(require 'ob)(require 'ob-tangle)
16827 (mapc (lambda (file)
16828 (find-file (expand-file-name file \"$DIR\"))
16830 (kill-buffer)) '($FILES)))" 2>&1 |grep -i tangled
16833 @node Miscellaneous
16834 @chapter Miscellaneous
16837 * Completion:: M-TAB knows what you need
16838 * Easy templates:: Quick insertion of structural elements
16839 * Speed keys:: Electric commands at the beginning of a headline
16840 * Code evaluation security:: Org mode files evaluate inline code
16841 * Customization:: Adapting Org to your taste
16842 * In-buffer settings:: Overview of the #+KEYWORDS
16843 * The very busy C-c C-c key:: When in doubt, press C-c C-c
16844 * Clean view:: Getting rid of leading stars in the outline
16845 * TTY keys:: Using Org on a tty
16846 * Interaction:: Other Emacs packages
16847 * org-crypt:: Encrypting Org files
16852 @section Completion
16853 @cindex completion, of @TeX{} symbols
16854 @cindex completion, of TODO keywords
16855 @cindex completion, of dictionary words
16856 @cindex completion, of option keywords
16857 @cindex completion, of tags
16858 @cindex completion, of property keys
16859 @cindex completion, of link abbreviations
16860 @cindex @TeX{} symbol completion
16861 @cindex TODO keywords completion
16862 @cindex dictionary word completion
16863 @cindex option keyword completion
16864 @cindex tag completion
16865 @cindex link abbreviations, completion of
16867 Org supports in-buffer completion. This type of completion does
16868 not make use of the minibuffer. You simply type a few letters into
16869 the buffer and use the key to complete text right there.
16872 @kindex M-@key{TAB}
16874 Complete word at point
16877 At the beginning of a headline, complete TODO keywords.
16879 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16881 After @samp{*}, complete headlines in the current buffer so that they
16882 can be used in search links like @samp{[[*find this headline]]}.
16884 After @samp{:} in a headline, complete tags. The list of tags is taken
16885 from the variable @code{org-tag-alist} (possibly set through the
16886 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16887 dynamically from all tags used in the current buffer.
16889 After @samp{:} and not in a headline, complete property keys. The list
16890 of keys is constructed dynamically from all keys used in the current
16893 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16895 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16896 @samp{OPTIONS} which set file-specific options for Org mode. When the
16897 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16898 will insert example settings for this keyword.
16900 In the line after @samp{#+STARTUP: }, complete startup keywords,
16901 i.e., valid keys for this line.
16903 Elsewhere, complete dictionary words using Ispell.
16907 @node Easy templates
16908 @section Easy templates
16909 @cindex template insertion
16910 @cindex insertion, of templates
16912 Org mode supports insertion of empty structural elements (like
16913 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16914 strokes. This is achieved through a native template expansion mechanism.
16915 Note that Emacs has several other template mechanisms which could be used in
16916 a similar way, for example @file{yasnippet}.
16918 To insert a structural element, type a @samp{<}, followed by a template
16919 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
16920 keystrokes are typed on a line by itself.
16922 The following template selectors are currently supported.
16924 @multitable @columnfractions 0.1 0.9
16925 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
16926 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16927 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
16928 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
16929 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
16930 @item @kbd{l} @tab @code{#+BEGIN_EXPORT latex ... #+END_EXPORT}
16931 @item @kbd{L} @tab @code{#+LATEX:}
16932 @item @kbd{h} @tab @code{#+BEGIN_EXPORT html ... #+END_EXPORT}
16933 @item @kbd{H} @tab @code{#+HTML:}
16934 @item @kbd{a} @tab @code{#+BEGIN_EXPORT ascii ... #+END_EXPORT}
16935 @item @kbd{A} @tab @code{#+ASCII:}
16936 @item @kbd{i} @tab @code{#+INDEX:} line
16937 @item @kbd{I} @tab @code{#+INCLUDE:} line
16940 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16941 into a complete EXAMPLE template.
16943 You can install additional templates by customizing the variable
16944 @code{org-structure-template-alist}. See the docstring of the variable for
16945 additional details.
16948 @section Speed keys
16950 @vindex org-use-speed-commands
16951 @vindex org-speed-commands-user
16953 Single keys can be made to execute commands when the cursor is at the
16954 beginning of a headline, i.e., before the first star. Configure the variable
16955 @code{org-use-speed-commands} to activate this feature. There is a
16956 pre-defined list of commands, and you can add more such commands using the
16957 variable @code{org-speed-commands-user}. Speed keys not only speed up
16958 navigation and other commands, but they also provide an alternative way to
16959 execute commands bound to keys that are not or not easily available on a TTY,
16960 or on a small mobile device with a limited keyboard.
16962 To see which commands are available, activate the feature and press @kbd{?}
16963 with the cursor at the beginning of a headline.
16965 @node Code evaluation security
16966 @section Code evaluation and security issues
16968 Org provides tools to work with code snippets, including evaluating them.
16970 Running code on your machine always comes with a security risk. Badly
16971 written or malicious code can be executed on purpose or by accident. Org has
16972 default settings which will only evaluate such code if you give explicit
16973 permission to do so, and as a casual user of these features you should leave
16974 these precautions intact.
16976 For people who regularly work with such code, the confirmation prompts can
16977 become annoying, and you might want to turn them off. This can be done, but
16978 you must be aware of the risks that are involved.
16980 Code evaluation can happen under the following circumstances:
16983 @item Source code blocks
16984 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16985 C-c} in the block. The most important thing to realize here is that Org mode
16986 files which contain code snippets are, in a certain sense, like executable
16987 files. So you should accept them and load them into Emacs only from trusted
16988 sources---just like you would do with a program you install on your computer.
16990 Make sure you know what you are doing before customizing the variables
16991 which take off the default security brakes.
16993 @defopt org-confirm-babel-evaluate
16994 When t (the default), the user is asked before every code block evaluation.
16995 When @code{nil}, the user is not asked. When set to a function, it is called with
16996 two arguments (language and body of the code block) and should return t to
16997 ask and @code{nil} not to ask.
17000 For example, here is how to execute "ditaa" code (which is considered safe)
17004 (defun my-org-confirm-babel-evaluate (lang body)
17005 (not (string= lang "ditaa"))) ; don't ask for ditaa
17006 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
17009 @item Following @code{shell} and @code{elisp} links
17010 Org has two link types that can directly evaluate code (@pxref{External
17011 links}). These links can be problematic because the code to be evaluated is
17014 @defopt org-confirm-shell-link-function
17015 Function to queries user about shell link execution.
17017 @defopt org-confirm-elisp-link-function
17018 Functions to query user for Emacs Lisp link execution.
17021 @item Formulas in tables
17022 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
17023 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
17026 @node Customization
17027 @section Customization
17028 @cindex customization
17029 @cindex options, for customization
17030 @cindex variables, for customization
17032 There are more than 500 variables that can be used to customize
17033 Org. For the sake of compactness of the manual, I am not
17034 describing the variables here. A structured overview of customization
17035 variables is available with @kbd{M-x org-customize RET}. Or select
17036 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
17037 settings can also be activated on a per-file basis, by putting special
17038 lines into the buffer (@pxref{In-buffer settings}).
17040 @node In-buffer settings
17041 @section Summary of in-buffer settings
17042 @cindex in-buffer settings
17043 @cindex special keywords
17045 Org mode uses special lines in the buffer to define settings on a
17046 per-file basis. These lines start with a @samp{#+} followed by a
17047 keyword, a colon, and then individual words defining a setting. Several
17048 setting words can be in the same line, but you can also have multiple
17049 lines for the keyword. While these settings are described throughout
17050 the manual, here is a summary. After changing any of these lines in the
17051 buffer, press @kbd{C-c C-c} with the cursor still in the line to
17052 activate the changes immediately. Otherwise they become effective only
17053 when the file is visited again in a new Emacs session.
17055 @vindex org-archive-location
17057 @item #+ARCHIVE: %s_done::
17058 This line sets the archive location for the agenda file. It applies for
17059 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
17060 of the file. The first such line also applies to any entries before it.
17061 The corresponding variable is @code{org-archive-location}.
17063 This line sets the category for the agenda file. The category applies to the
17065 @item #+COLUMNS: %25ITEM ...
17066 @cindex property, COLUMNS
17067 Set the default format for columns view. This format applies when
17068 columns view is invoked in locations where no @code{COLUMNS} property
17070 @item #+CONSTANTS: name1=value1 ...
17071 @vindex org-table-formula-constants
17072 @vindex org-table-formula
17073 Set file-local values for constants to be used in table formulas. This
17074 line sets the local variable @code{org-table-formula-constants-local}.
17075 The global version of this variable is
17076 @code{org-table-formula-constants}.
17077 @item #+FILETAGS: :tag1:tag2:tag3:
17078 Set tags that can be inherited by any entry in the file, including the
17080 @item #+LINK: linkword replace
17081 @vindex org-link-abbrev-alist
17082 These lines (several are allowed) specify link abbreviations.
17083 @xref{Link abbreviations}. The corresponding variable is
17084 @code{org-link-abbrev-alist}.
17085 @item #+PRIORITIES: highest lowest default
17086 @vindex org-highest-priority
17087 @vindex org-lowest-priority
17088 @vindex org-default-priority
17089 This line sets the limits and the default for the priorities. All three
17090 must be either letters A--Z or numbers 0--9. The highest priority must
17091 have a lower ASCII number than the lowest priority.
17092 @item #+PROPERTY: Property_Name Value
17093 This line sets a default inheritance value for entries in the current
17094 buffer, most useful for specifying the allowed values of a property.
17095 @cindex #+SETUPFILE
17096 @item #+SETUPFILE: file
17097 This line defines a file that holds more in-buffer setup. Normally this is
17098 entirely ignored. Only when the buffer is parsed for option-setting lines
17099 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
17100 settings line, or when exporting), then the contents of this file are parsed
17101 as if they had been included in the buffer. In particular, the file can be
17102 any other Org mode file with internal setup. You can visit the file the
17103 cursor is in the line with @kbd{C-c '}.
17106 This line sets options to be used at startup of Org mode, when an
17107 Org file is being visited.
17109 The first set of options deals with the initial visibility of the outline
17110 tree. The corresponding variable for global default settings is
17111 @code{org-startup-folded}, with a default value @code{t}, which means
17113 @vindex org-startup-folded
17114 @cindex @code{overview}, STARTUP keyword
17115 @cindex @code{content}, STARTUP keyword
17116 @cindex @code{showall}, STARTUP keyword
17117 @cindex @code{showeverything}, STARTUP keyword
17119 overview @r{top-level headlines only}
17120 content @r{all headlines}
17121 showall @r{no folding of any entries}
17122 showeverything @r{show even drawer contents}
17125 @vindex org-startup-indented
17126 @cindex @code{indent}, STARTUP keyword
17127 @cindex @code{noindent}, STARTUP keyword
17128 Dynamic virtual indentation is controlled by the variable
17129 @code{org-startup-indented}
17131 indent @r{start with @code{org-indent-mode} turned on}
17132 noindent @r{start with @code{org-indent-mode} turned off}
17135 @vindex org-startup-align-all-tables
17136 Then there are options for aligning tables upon visiting a file. This
17137 is useful in files containing narrowed table columns. The corresponding
17138 variable is @code{org-startup-align-all-tables}, with a default value
17140 @cindex @code{align}, STARTUP keyword
17141 @cindex @code{noalign}, STARTUP keyword
17143 align @r{align all tables}
17144 noalign @r{don't align tables on startup}
17147 @vindex org-startup-with-inline-images
17148 When visiting a file, inline images can be automatically displayed. The
17149 corresponding variable is @code{org-startup-with-inline-images}, with a
17150 default value @code{nil} to avoid delays when visiting a file.
17151 @cindex @code{inlineimages}, STARTUP keyword
17152 @cindex @code{noinlineimages}, STARTUP keyword
17154 inlineimages @r{show inline images}
17155 noinlineimages @r{don't show inline images on startup}
17158 @vindex org-startup-with-latex-preview
17159 When visiting a file, @LaTeX{} fragments can be converted to images
17160 automatically. The variable @code{org-startup-with-latex-preview} which
17161 controls this behavior, is set to @code{nil} by default to avoid delays on
17163 @cindex @code{latexpreview}, STARTUP keyword
17164 @cindex @code{nolatexpreview}, STARTUP keyword
17166 latexpreview @r{preview @LaTeX{} fragments}
17167 nolatexpreview @r{don't preview @LaTeX{} fragments}
17170 @vindex org-log-done
17171 @vindex org-log-note-clock-out
17172 @vindex org-log-repeat
17173 Logging the closing and reopening of TODO items and clock intervals can be
17174 configured using these options (see variables @code{org-log-done},
17175 @code{org-log-note-clock-out} and @code{org-log-repeat})
17176 @cindex @code{logdone}, STARTUP keyword
17177 @cindex @code{lognotedone}, STARTUP keyword
17178 @cindex @code{nologdone}, STARTUP keyword
17179 @cindex @code{lognoteclock-out}, STARTUP keyword
17180 @cindex @code{nolognoteclock-out}, STARTUP keyword
17181 @cindex @code{logrepeat}, STARTUP keyword
17182 @cindex @code{lognoterepeat}, STARTUP keyword
17183 @cindex @code{nologrepeat}, STARTUP keyword
17184 @cindex @code{logreschedule}, STARTUP keyword
17185 @cindex @code{lognotereschedule}, STARTUP keyword
17186 @cindex @code{nologreschedule}, STARTUP keyword
17187 @cindex @code{logredeadline}, STARTUP keyword
17188 @cindex @code{lognoteredeadline}, STARTUP keyword
17189 @cindex @code{nologredeadline}, STARTUP keyword
17190 @cindex @code{logrefile}, STARTUP keyword
17191 @cindex @code{lognoterefile}, STARTUP keyword
17192 @cindex @code{nologrefile}, STARTUP keyword
17193 @cindex @code{logdrawer}, STARTUP keyword
17194 @cindex @code{nologdrawer}, STARTUP keyword
17195 @cindex @code{logstatesreversed}, STARTUP keyword
17196 @cindex @code{nologstatesreversed}, STARTUP keyword
17198 logdone @r{record a timestamp when an item is marked DONE}
17199 lognotedone @r{record timestamp and a note when DONE}
17200 nologdone @r{don't record when items are marked DONE}
17201 logrepeat @r{record a time when reinstating a repeating item}
17202 lognoterepeat @r{record a note when reinstating a repeating item}
17203 nologrepeat @r{do not record when reinstating repeating item}
17204 lognoteclock-out @r{record a note when clocking out}
17205 nolognoteclock-out @r{don't record a note when clocking out}
17206 logreschedule @r{record a timestamp when scheduling time changes}
17207 lognotereschedule @r{record a note when scheduling time changes}
17208 nologreschedule @r{do not record when a scheduling date changes}
17209 logredeadline @r{record a timestamp when deadline changes}
17210 lognoteredeadline @r{record a note when deadline changes}
17211 nologredeadline @r{do not record when a deadline date changes}
17212 logrefile @r{record a timestamp when refiling}
17213 lognoterefile @r{record a note when refiling}
17214 nologrefile @r{do not record when refiling}
17215 logdrawer @r{store log into drawer}
17216 nologdrawer @r{store log outside of drawer}
17217 logstatesreversed @r{reverse the order of states notes}
17218 nologstatesreversed @r{do not reverse the order of states notes}
17221 @vindex org-hide-leading-stars
17222 @vindex org-odd-levels-only
17223 Here are the options for hiding leading stars in outline headings, and for
17224 indenting outlines. The corresponding variables are
17225 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
17226 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
17227 @cindex @code{hidestars}, STARTUP keyword
17228 @cindex @code{showstars}, STARTUP keyword
17229 @cindex @code{odd}, STARTUP keyword
17230 @cindex @code{even}, STARTUP keyword
17232 hidestars @r{make all but one of the stars starting a headline invisible.}
17233 showstars @r{show all stars starting a headline}
17234 indent @r{virtual indentation according to outline level}
17235 noindent @r{no virtual indentation according to outline level}
17236 odd @r{allow only odd outline levels (1,3,...)}
17237 oddeven @r{allow all outline levels}
17240 @vindex org-put-time-stamp-overlays
17241 @vindex org-time-stamp-overlay-formats
17242 To turn on custom format overlays over timestamps (variables
17243 @code{org-put-time-stamp-overlays} and
17244 @code{org-time-stamp-overlay-formats}), use
17245 @cindex @code{customtime}, STARTUP keyword
17247 customtime @r{overlay custom time format}
17250 @vindex constants-unit-system
17251 The following options influence the table spreadsheet (variable
17252 @code{constants-unit-system}).
17253 @cindex @code{constcgs}, STARTUP keyword
17254 @cindex @code{constSI}, STARTUP keyword
17256 constcgs @r{@file{constants.el} should use the c-g-s unit system}
17257 constSI @r{@file{constants.el} should use the SI unit system}
17260 @vindex org-footnote-define-inline
17261 @vindex org-footnote-auto-label
17262 @vindex org-footnote-auto-adjust
17263 To influence footnote settings, use the following keywords. The
17264 corresponding variables are @code{org-footnote-define-inline},
17265 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
17266 @cindex @code{fninline}, STARTUP keyword
17267 @cindex @code{nofninline}, STARTUP keyword
17268 @cindex @code{fnlocal}, STARTUP keyword
17269 @cindex @code{fnprompt}, STARTUP keyword
17270 @cindex @code{fnauto}, STARTUP keyword
17271 @cindex @code{fnconfirm}, STARTUP keyword
17272 @cindex @code{fnplain}, STARTUP keyword
17273 @cindex @code{fnadjust}, STARTUP keyword
17274 @cindex @code{nofnadjust}, STARTUP keyword
17276 fninline @r{define footnotes inline}
17277 fnnoinline @r{define footnotes in separate section}
17278 fnlocal @r{define footnotes near first reference, but not inline}
17279 fnprompt @r{prompt for footnote labels}
17280 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
17281 fnconfirm @r{offer automatic label for editing or confirmation}
17282 fnplain @r{create @code{[1]}-like labels automatically}
17283 fnadjust @r{automatically renumber and sort footnotes}
17284 nofnadjust @r{do not renumber and sort automatically}
17287 @cindex org-hide-block-startup
17288 To hide blocks on startup, use these keywords. The corresponding variable is
17289 @code{org-hide-block-startup}.
17290 @cindex @code{hideblocks}, STARTUP keyword
17291 @cindex @code{nohideblocks}, STARTUP keyword
17293 hideblocks @r{Hide all begin/end blocks on startup}
17294 nohideblocks @r{Do not hide blocks on startup}
17297 @cindex org-pretty-entities
17298 The display of entities as UTF-8 characters is governed by the variable
17299 @code{org-pretty-entities} and the keywords
17300 @cindex @code{entitiespretty}, STARTUP keyword
17301 @cindex @code{entitiesplain}, STARTUP keyword
17303 entitiespretty @r{Show entities as UTF-8 characters where possible}
17304 entitiesplain @r{Leave entities plain}
17307 @item #+TAGS: TAG1(c1) TAG2(c2)
17308 @vindex org-tag-alist
17309 These lines (several such lines are allowed) specify the valid tags in
17310 this file, and (potentially) the corresponding @emph{fast tag selection}
17311 keys. The corresponding variable is @code{org-tag-alist}.
17314 This line contains the formulas for the table directly above the line.
17316 Table can have multiple lines containing @samp{#+TBLFM:}. Note
17317 that only the first line of @samp{#+TBLFM:} will be applied when
17318 you recalculate the table. For more details see @ref{Using
17319 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
17321 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
17322 @itemx #+OPTIONS:, #+BIND:,
17323 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
17324 These lines provide settings for exporting files. For more details see
17325 @ref{Export settings}.
17326 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
17327 @vindex org-todo-keywords
17328 These lines set the TODO keywords and their interpretation in the
17329 current file. The corresponding variable is @code{org-todo-keywords}.
17332 @node The very busy C-c C-c key
17333 @section The very busy C-c C-c key
17335 @cindex C-c C-c, overview
17337 The key @kbd{C-c C-c} has many purposes in Org, which are all
17338 mentioned scattered throughout this manual. One specific function of
17339 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
17340 other circumstances it means something like @emph{``Hey Org, look
17341 here and update according to what you see here''}. Here is a summary of
17342 what this means in different contexts.
17346 If there are highlights in the buffer from the creation of a sparse
17347 tree, or from clock display, remove these highlights.
17349 If the cursor is in one of the special @code{#+KEYWORD} lines, this
17350 triggers scanning the buffer for these lines and updating the
17353 If the cursor is inside a table, realign the table. This command
17354 works even if the automatic table editor has been turned off.
17356 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
17359 If the current buffer is a capture buffer, close the note and file it.
17360 With a prefix argument, file it, without further interaction, to the
17363 If the cursor is on a @code{<<<target>>>}, update radio targets and
17364 corresponding links in this buffer.
17366 If the cursor is in a property line or at the start or end of a property
17367 drawer, offer property commands.
17369 If the cursor is at a footnote reference, go to the corresponding
17370 definition, and @emph{vice versa}.
17372 If the cursor is on a statistics cookie, update it.
17374 If the cursor is in a plain list item with a checkbox, toggle the status
17377 If the cursor is on a numbered item in a plain list, renumber the
17380 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
17383 If the cursor is at a timestamp, fix the day name in the timestamp.
17387 @section A cleaner outline view
17388 @cindex hiding leading stars
17389 @cindex dynamic indentation
17390 @cindex odd-levels-only outlines
17391 @cindex clean outline view
17393 Some people find it noisy and distracting that the Org headlines start with a
17394 potentially large number of stars, and that text below the headlines is not
17395 indented. While this is no problem when writing a @emph{book-like} document
17396 where the outline headings are really section headings, in a more
17397 @emph{list-oriented} outline, indented structure is a lot cleaner:
17401 * Top level headline | * Top level headline
17402 ** Second level | * Second level
17403 *** 3rd level | * 3rd level
17404 some text | some text
17405 *** 3rd level | * 3rd level
17406 more text | more text
17407 * Another top level headline | * Another top level headline
17413 This kind of view can be achieved dynamically at display time using
17414 @code{org-indent-mode}. In this minor mode, all lines are prefixed for
17415 display with the necessary amount of space@footnote{@code{org-indent-mode}
17416 also sets the @code{wrap-prefix} property, such that @code{visual-line-mode}
17417 (or purely setting @code{word-wrap}) wraps long lines (including headlines)
17418 correctly indented.}. Also headlines are prefixed with additional stars, so
17419 that the amount of indentation shifts by two@footnote{See the variable
17420 @code{org-indent-indentation-per-level}.} spaces per level. All headline
17421 stars but the last one are made invisible using the @code{org-hide}
17422 face@footnote{Turning on @code{org-indent-mode} sets
17423 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
17424 @code{nil}.}; see below under @samp{2.} for more information on how this
17425 works. You can turn on @code{org-indent-mode} for all files by customizing
17426 the variable @code{org-startup-indented}, or you can turn it on for
17427 individual files using
17433 If you want a similar effect in an earlier version of Emacs and/or Org, or if
17434 you want the indentation to be hard space characters so that the plain text
17435 file looks as similar as possible to the Emacs display, Org supports you in
17440 @emph{Indentation of text below headlines}@*
17441 You may indent text below each headline to make the left boundary line up
17442 with the headline, like
17446 more text, now indented
17449 @vindex org-adapt-indentation
17450 Org supports this with paragraph filling, line wrapping, and structure
17451 editing@footnote{See also the variable @code{org-adapt-indentation}.},
17452 preserving or adapting the indentation as appropriate.
17455 @vindex org-hide-leading-stars
17456 @emph{Hiding leading stars}@* You can modify the display in such a way that
17457 all leading stars become invisible. To do this in a global way, configure
17458 the variable @code{org-hide-leading-stars} or change this on a per-file basis
17462 #+STARTUP: hidestars
17463 #+STARTUP: showstars
17466 With hidden stars, the tree becomes:
17470 * Top level headline
17478 @vindex org-hide @r{(face)}
17479 The leading stars are not truly replaced by whitespace, they are only
17480 fontified with the face @code{org-hide} that uses the background color as
17481 font color. If you are not using either white or black background, you may
17482 have to customize this face to get the wanted effect. Another possibility is
17483 to set this font such that the extra stars are @i{almost} invisible, for
17484 example using the color @code{grey90} on a white background.
17487 @vindex org-odd-levels-only
17488 Things become cleaner still if you skip all the even levels and use only odd
17489 levels 1, 3, 5..., effectively adding two stars to go from one outline level
17490 to the next@footnote{When you need to specify a level for a property search
17491 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
17492 way we get the outline view shown at the beginning of this section. In order
17493 to make the structure editing and export commands handle this convention
17494 correctly, configure the variable @code{org-odd-levels-only}, or set this on
17495 a per-file basis with one of the following lines:
17502 You can convert an Org file from single-star-per-level to the
17503 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
17504 RET} in that file. The reverse operation is @kbd{M-x
17505 org-convert-to-oddeven-levels}.
17509 @section Using Org on a tty
17510 @cindex tty key bindings
17512 Because Org contains a large number of commands, by default many of
17513 Org's core commands are bound to keys that are generally not
17514 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
17515 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
17516 together with modifiers like @key{Meta} and/or @key{Shift}. To access
17517 these commands on a tty when special keys are unavailable, the following
17518 alternative bindings can be used. The tty bindings below will likely be
17519 more cumbersome; you may find for some of the bindings below that a
17520 customized workaround suits you better. For example, changing a timestamp
17521 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
17522 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
17524 @multitable @columnfractions 0.15 0.2 0.1 0.2
17525 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
17526 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
17527 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
17528 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
17529 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
17530 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
17531 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
17532 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
17533 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
17534 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
17535 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
17536 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
17537 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
17538 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
17539 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
17540 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
17541 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
17542 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
17543 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17548 @section Interaction with other packages
17549 @cindex packages, interaction with other
17550 Org lives in the world of GNU Emacs and interacts in various ways
17551 with other code out there.
17554 * Cooperation:: Packages Org cooperates with
17555 * Conflicts:: Packages that lead to conflicts
17559 @subsection Packages that Org cooperates with
17562 @cindex @file{calc.el}
17563 @cindex Gillespie, Dave
17564 @item @file{calc.el} by Dave Gillespie
17565 Org uses the Calc package for implementing spreadsheet functionality in its
17566 tables (@pxref{The spreadsheet}). Another possibility for interaction
17567 between the two packages is using Calc for embedded calculations.
17568 @xref{Embedded Mode, , Embedded Mode, calc, GNU Emacs Calc Manual}.
17569 @item @file{constants.el} by Carsten Dominik
17570 @cindex @file{constants.el}
17571 @cindex Dominik, Carsten
17572 @vindex org-table-formula-constants
17573 In a table formula (@pxref{The spreadsheet}), it is possible to use
17574 names for natural constants or units. Instead of defining your own
17575 constants in the variable @code{org-table-formula-constants}, install
17576 the @file{constants} package which defines a large number of constants
17577 and units, and lets you use unit prefixes like @samp{M} for
17578 @samp{Mega}, etc. You will need version 2.0 of this package, available
17579 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
17580 the function @code{constants-get}, which has to be autoloaded in your
17581 setup. See the installation instructions in the file
17582 @file{constants.el}.
17583 @item @file{cdlatex.el} by Carsten Dominik
17584 @cindex @file{cdlatex.el}
17585 @cindex Dominik, Carsten
17586 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17587 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
17588 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17589 @cindex @file{imenu.el}
17590 Imenu allows menu access to an index of items in a file. Org mode
17591 supports Imenu---all you need to do to get the index is the following:
17593 (add-hook 'org-mode-hook
17594 (lambda () (imenu-add-to-menubar "Imenu")))
17596 @vindex org-imenu-depth
17597 By default the index is two levels deep---you can modify the depth using
17598 the option @code{org-imenu-depth}.
17599 @item @file{speedbar.el} by Eric M. Ludlam
17600 @cindex @file{speedbar.el}
17601 @cindex Ludlam, Eric M.
17602 Speedbar is a package that creates a special frame displaying files and
17603 index items in files. Org mode supports Speedbar and allows you to
17604 drill into Org files directly from the Speedbar. It also allows you to
17605 restrict the scope of agenda commands to a file or a subtree by using
17606 the command @kbd{<} in the Speedbar frame.
17607 @cindex @file{table.el}
17608 @item @file{table.el} by Takaaki Ota
17610 @cindex table editor, @file{table.el}
17611 @cindex @file{table.el}
17612 @cindex Ota, Takaaki
17614 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17615 and alignment can be created using the Emacs table package by Takaaki Ota.
17616 Org mode will recognize these tables and export them properly. Because of
17617 interference with other Org mode functionality, you unfortunately cannot edit
17618 these tables directly in the buffer. Instead, you need to use the command
17619 @kbd{C-c '} to edit them, similar to source code snippets.
17622 @orgcmd{C-c ',org-edit-special}
17623 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
17625 @orgcmd{C-c ~,org-table-create-with-table.el}
17626 Insert a @file{table.el} table. If there is already a table at point, this
17627 command converts it between the @file{table.el} format and the Org mode
17628 format. See the documentation string of the command
17629 @code{org-convert-table} for the restrictions under which this is
17635 @subsection Packages that lead to conflicts with Org mode
17639 @cindex @code{shift-selection-mode}
17640 @vindex org-support-shift-select
17641 In Emacs, @code{shift-selection-mode} is on by default, meaning that cursor
17642 motions combined with the shift key should start or enlarge regions. This
17643 conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17644 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17645 at such a location. By default, @kbd{S-@key{cursor}} commands outside
17646 special contexts don't do anything, but you can customize the variable
17647 @code{org-support-shift-select}. Org mode then tries to accommodate shift
17648 selection by (i) using it outside of the special contexts where special
17649 commands apply, and by (ii) extending an existing active region even if the
17650 cursor moves across a special context.
17652 @item @file{CUA.el} by Kim. F. Storm
17653 @cindex @file{CUA.el}
17654 @cindex Storm, Kim. F.
17655 @vindex org-replace-disputed-keys
17656 For the same reason, key bindings in Org also conflict with the
17657 @kbd{S-<cursor>} keys used by CUA mode. If you prefer to leave these keys to
17658 a different package while working in Org mode, configure the variable
17659 @code{org-replace-disputed-keys}. When set, Org will move the following key
17660 bindings in Org files, and in the agenda buffer (but not during date
17664 S-UP @result{} M-p S-DOWN @result{} M-n
17665 S-LEFT @result{} M-- S-RIGHT @result{} M-+
17666 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
17669 @vindex org-disputed-keys
17670 Yes, these are unfortunately more difficult to remember. If you want
17671 to have other replacement keys, look at the variable
17672 @code{org-disputed-keys}.
17674 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17675 @cindex @file{ecomplete.el}
17677 Ecomplete provides ``electric'' address completion in address header
17678 lines in message buffers. Sadly Orgtbl mode cuts ecompletes power
17679 supply: No completion happens when Orgtbl mode is enabled in message
17680 buffers while entering text in address header lines. If one wants to
17681 use ecomplete one should @emph{not} follow the advice to automagically
17682 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17683 instead---after filling in the message headers---turn on Orgtbl mode
17684 manually when needed in the messages body.
17686 @item @file{filladapt.el} by Kyle Jones
17687 @cindex @file{filladapt.el}
17689 Org mode tries to do the right thing when filling paragraphs, list items and
17690 other elements. Many users reported they had problems using both
17691 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17695 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17698 @item @file{yasnippet.el}
17699 @cindex @file{yasnippet.el}
17700 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17701 @code{"\t"}) overrules YASnippet's access to this key. The following code
17702 fixed this problem:
17705 (add-hook 'org-mode-hook
17707 (org-set-local 'yas/trigger-key [tab])
17708 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17711 The latest version of yasnippet doesn't play well with Org mode. If the
17712 above code does not fix the conflict, start by defining the following
17716 (defun yas/org-very-safe-expand ()
17717 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17720 Then, tell Org mode what to do with the new function:
17723 (add-hook 'org-mode-hook
17725 (make-variable-buffer-local 'yas/trigger-key)
17726 (setq yas/trigger-key [tab])
17727 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17728 (define-key yas/keymap [tab] 'yas/next-field)))
17731 @item @file{windmove.el} by Hovav Shacham
17732 @cindex @file{windmove.el}
17733 This package also uses the @kbd{S-<cursor>} keys, so everything written
17734 in the paragraph above about CUA mode also applies here. If you want make
17735 the windmove function active in locations where Org mode does not have
17736 special functionality on @kbd{S-@key{cursor}}, add this to your
17740 ;; Make windmove work in org-mode:
17741 (add-hook 'org-shiftup-final-hook 'windmove-up)
17742 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17743 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17744 (add-hook 'org-shiftright-final-hook 'windmove-right)
17747 @item @file{viper.el} by Michael Kifer
17748 @cindex @file{viper.el}
17750 Viper uses @kbd{C-c /} and therefore makes this key not access the
17751 corresponding Org mode command @code{org-sparse-tree}. You need to find
17752 another key for this command, or override the key in
17753 @code{viper-vi-global-user-map} with
17756 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17764 @section org-crypt.el
17765 @cindex @file{org-crypt.el}
17766 @cindex @code{org-decrypt-entry}
17768 Org-crypt will encrypt the text of an entry, but not the headline, or
17769 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17772 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17773 be encrypted when the file is saved. If you want to use a different tag just
17774 customize the @code{org-crypt-tag-matcher} setting.
17776 To use org-crypt it is suggested that you have the following in your
17780 (require 'org-crypt)
17781 (org-crypt-use-before-save-magic)
17782 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17784 (setq org-crypt-key nil)
17785 ;; GPG key to use for encryption
17786 ;; Either the Key ID or set to nil to use symmetric encryption.
17788 (setq auto-save-default nil)
17789 ;; Auto-saving does not cooperate with org-crypt.el: so you need
17790 ;; to turn it off if you plan to use org-crypt.el quite often.
17791 ;; Otherwise, you'll get an (annoying) message each time you
17794 ;; To turn it off only locally, you can insert this:
17796 ;; # -*- buffer-auto-save-file-name: nil; -*-
17799 Excluding the crypt tag from inheritance prevents already encrypted text
17800 being encrypted again.
17806 This appendix covers some areas where users can extend the functionality of
17810 * Hooks:: How to reach into Org's internals
17811 * Add-on packages:: Available extensions
17812 * Adding hyperlink types:: New custom link types
17813 * Adding export back-ends:: How to write new export back-ends
17814 * Context-sensitive commands:: How to add functionality to such commands
17815 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
17816 * Dynamic blocks:: Automatically filled blocks
17817 * Special agenda views:: Customized views
17818 * Speeding up your agendas:: Tips on how to speed up your agendas
17819 * Extracting agenda information:: Post-processing of agenda information
17820 * Using the property API:: Writing programs that use entry properties
17821 * Using the mapping API:: Mapping over all or selected entries
17828 Org has a large number of hook variables that can be used to add
17829 functionality. This appendix about hacking is going to illustrate the
17830 use of some of them. A complete list of all hooks with documentation is
17831 maintained by the Worg project and can be found at
17832 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17834 @node Add-on packages
17835 @section Add-on packages
17836 @cindex add-on packages
17838 A large number of add-on packages have been written by various authors.
17840 These packages are not part of Emacs, but they are distributed as contributed
17841 packages with the separate release available at @uref{http://orgmode.org}.
17842 See the @file{contrib/README} file in the source code directory for a list of
17843 contributed files. You may also find some more information on the Worg page:
17844 @uref{http://orgmode.org/worg/org-contrib/}.
17846 @node Adding hyperlink types
17847 @section Adding hyperlink types
17848 @cindex hyperlinks, adding new types
17850 Org has a large number of hyperlink types built-in
17851 (@pxref{Hyperlinks}). If you would like to add new link types, Org
17852 provides an interface for doing so. Let's look at an example file,
17853 @file{org-man.el}, that will add support for creating links like
17854 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17858 ;;; org-man.el - Support for links to manpages in Org
17862 (org-add-link-type "man" 'org-man-open)
17863 (add-hook 'org-store-link-functions 'org-man-store-link)
17865 (defcustom org-man-command 'man
17866 "The Emacs command to be used to display a man page."
17868 :type '(choice (const man) (const woman)))
17870 (defun org-man-open (path)
17871 "Visit the manpage on PATH.
17872 PATH should be a topic that can be thrown at the man command."
17873 (funcall org-man-command path))
17875 (defun org-man-store-link ()
17876 "Store a link to a manpage."
17877 (when (memq major-mode '(Man-mode woman-mode))
17878 ;; This is a man page, we do make this link
17879 (let* ((page (org-man-get-page-name))
17880 (link (concat "man:" page))
17881 (description (format "Manpage for %s" page)))
17882 (org-store-link-props
17885 :description description))))
17887 (defun org-man-get-page-name ()
17888 "Extract the page name from the buffer name."
17889 ;; This works for both `Man-mode' and `woman-mode'.
17890 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17891 (match-string 1 (buffer-name))
17892 (error "Cannot create link to this man page")))
17896 ;;; org-man.el ends here
17900 You would activate this new link type in @file{.emacs} with
17907 Let's go through the file and see what it does.
17910 It does @code{(require 'org)} to make sure that @file{org.el} has been
17913 The next line calls @code{org-add-link-type} to define a new link type
17914 with prefix @samp{man}. The call also contains the name of a function
17915 that will be called to follow such a link.
17917 @vindex org-store-link-functions
17918 The next line adds a function to @code{org-store-link-functions}, in
17919 order to allow the command @kbd{C-c l} to record a useful link in a
17920 buffer displaying a man page.
17923 The rest of the file defines the necessary variables and functions.
17924 First there is a customization variable that determines which Emacs
17925 command should be used to display man pages. There are two options,
17926 @code{man} and @code{woman}. Then the function to follow a link is
17927 defined. It gets the link path as an argument---in this case the link
17928 path is just a topic for the manual command. The function calls the
17929 value of @code{org-man-command} to display the man page.
17931 Finally the function @code{org-man-store-link} is defined. When you try
17932 to store a link with @kbd{C-c l}, this function will be called to
17933 try to make a link. The function must first decide if it is supposed to
17934 create the link for this buffer type; we do this by checking the value
17935 of the variable @code{major-mode}. If not, the function must exit and
17936 return the value @code{nil}. If yes, the link is created by getting the
17937 manual topic from the buffer name and prefixing it with the string
17938 @samp{man:}. Then it must call the command @code{org-store-link-props}
17939 and set the @code{:type} and @code{:link} properties. Optionally you
17940 can also set the @code{:description} property to provide a default for
17941 the link description when the link is later inserted into an Org
17942 buffer with @kbd{C-c C-l}.
17944 When it makes sense for your new link type, you may also define a function
17945 that implements special (e.g., completion) support for inserting such a link
17946 with @kbd{C-c C-l}. Such a function should not accept any arguments, and
17947 return the full link with prefix.
17949 @node Adding export back-ends
17950 @section Adding export back-ends
17951 @cindex Export, writing back-ends
17953 Org 8.0 comes with a completely rewritten export engine which makes it easy
17954 to write new export back-ends, either from scratch, or by deriving them
17955 from existing ones.
17957 Your two entry points are respectively @code{org-export-define-backend} and
17958 @code{org-export-define-derived-backend}. To grok these functions, you
17959 should first have a look at @file{ox-latex.el} (for how to define a new
17960 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17961 back-end from an existing one.
17963 When creating a new back-end from scratch, the basic idea is to set the name
17964 of the back-end (as a symbol) and an alist of elements and export functions.
17965 On top of this, you will need to set additional keywords like
17966 @code{:menu-entry} (to display the back-end in the export dispatcher), and
17967 @code{:options-alist} (to let the user set export options that are specific
17970 Deriving a new back-end is similar, except that you need to set
17971 @code{:translate-alist} to an alist of export functions that should be used
17972 instead of the parent back-end functions.
17974 For a complete reference documentation, see
17975 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17976 Reference on Worg}.
17978 @node Context-sensitive commands
17979 @section Context-sensitive commands
17980 @cindex context-sensitive commands, hooks
17981 @cindex add-ons, context-sensitive commands
17982 @vindex org-ctrl-c-ctrl-c-hook
17984 Org has several commands that act differently depending on context. The most
17985 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17986 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17988 Add-ons can tap into this functionality by providing a function that detects
17989 special context for that add-on and executes functionality appropriate for
17990 the context. Here is an example from Dan Davison's @file{org-R.el} which
17991 allows you to evaluate commands based on the @file{R} programming language
17992 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17993 described in @ref{Working with source code} and is now obsolete.}. For this
17994 package, special contexts are lines that start with @code{#+R:} or
17998 (defun org-R-apply-maybe ()
17999 "Detect if this is context for org-R and execute R commands."
18000 (if (save-excursion
18001 (beginning-of-line 1)
18002 (looking-at "#\\+RR?:"))
18003 (progn (call-interactively 'org-R-apply)
18004 t) ;; to signal that we took action
18005 nil)) ;; to signal that we did not
18007 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
18010 The function first checks if the cursor is in such a line. If that is the
18011 case, @code{org-R-apply} is called and the function returns @code{t} to
18012 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
18013 contexts. If the function finds it should do nothing locally, it returns
18014 @code{nil} so that other, similar functions can have a try.
18017 @node Tables in arbitrary syntax
18018 @section Tables and lists in arbitrary syntax
18019 @cindex tables, in other modes
18020 @cindex lists, in other modes
18021 @cindex Orgtbl mode
18023 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
18024 frequent feature request has been to make it work with native tables in
18025 specific languages, for example @LaTeX{}. However, this is extremely
18026 hard to do in a general way, would lead to a customization nightmare,
18027 and would take away much of the simplicity of the Orgtbl mode table
18030 This appendix describes a different approach. We keep the Orgtbl mode
18031 table in its native format (the @i{source table}), and use a custom
18032 function to @i{translate} the table to the correct syntax, and to
18033 @i{install} it in the right location (the @i{target table}). This puts
18034 the burden of writing conversion functions on the user, but it allows
18035 for a very flexible system.
18037 Bastien added the ability to do the same with lists, in Orgstruct mode. You
18038 can use Org's facilities to edit and structure lists by turning
18039 @code{orgstruct-mode} on, then locally exporting such lists in another format
18040 (HTML, @LaTeX{} or Texinfo.)
18044 * Radio tables:: Sending and receiving radio tables
18045 * A @LaTeX{} example:: Step by step, almost a tutorial
18046 * Translator functions:: Copy and modify
18047 * Radio lists:: Sending and receiving lists
18051 @subsection Radio tables
18052 @cindex radio tables
18054 To define the location of the target table, you first need to create two
18055 lines that are comments in the current mode, but contain magic words
18056 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will
18057 insert the translated table between these lines, replacing whatever was there
18058 before. For example in C mode where comments are between @code{/* ... */}:
18061 /* BEGIN RECEIVE ORGTBL table_name */
18062 /* END RECEIVE ORGTBL table_name */
18066 Just above the source table, we put a special line that tells
18067 Orgtbl mode how to translate this table and where to install it. For
18071 #+ORGTBL: SEND table_name translation_function arguments...
18075 @code{table_name} is the reference name for the table that is also used
18076 in the receiver lines. @code{translation_function} is the Lisp function
18077 that does the translation. Furthermore, the line can contain a list of
18078 arguments (alternating key and value) at the end. The arguments will be
18079 passed as a property list to the translation function for
18080 interpretation. A few standard parameters are already recognized and
18081 acted upon before the translation function is called:
18085 Skip the first N lines of the table. Hlines do count as separate lines for
18088 @item :skipcols (n1 n2 ...)
18089 List of columns that should be skipped. If the table has a column with
18090 calculation marks, that column is automatically discarded as well.
18091 Please note that the translator function sees the table @emph{after} the
18092 removal of these columns, the function never knows that there have been
18093 additional columns.
18097 The one problem remaining is how to keep the source table in the buffer
18098 without disturbing the normal workings of the file, for example during
18099 compilation of a C file or processing of a @LaTeX{} file. There are a
18100 number of different solutions:
18104 The table could be placed in a block comment if that is supported by the
18105 language. For example, in C mode you could wrap the table between
18106 @samp{/*} and @samp{*/} lines.
18108 Sometimes it is possible to put the table after some kind of @i{END}
18109 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
18112 You can just comment the table line-by-line whenever you want to process
18113 the file, and uncomment it whenever you need to edit the table. This
18114 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
18115 makes this comment-toggling very easy, in particular if you bind it to a
18119 @node A @LaTeX{} example
18120 @subsection A @LaTeX{} example of radio tables
18121 @cindex @LaTeX{}, and Orgtbl mode
18123 The best way to wrap the source table in @LaTeX{} is to use the
18124 @code{comment} environment provided by @file{comment.sty}. It has to be
18125 activated by placing @code{\usepackage@{comment@}} into the document
18126 header. Orgtbl mode can insert a radio table skeleton@footnote{By
18127 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
18128 variable @code{orgtbl-radio-table-templates} to install templates for other
18129 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
18130 be prompted for a table name, let's say we use @samp{salesfigures}. You
18131 will then get the following template:
18133 @cindex #+ORGTBL, SEND
18135 % BEGIN RECEIVE ORGTBL salesfigures
18136 % END RECEIVE ORGTBL salesfigures
18138 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18144 @vindex @LaTeX{}-verbatim-environments
18145 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
18146 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
18147 into the receiver location with name @code{salesfigures}. You may now
18148 fill in the table---feel free to use the spreadsheet features@footnote{If
18149 the @samp{#+TBLFM} line contains an odd number of dollar characters,
18150 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
18151 example you can fix this by adding an extra line inside the
18152 @code{comment} environment that is used to balance the dollar
18153 expressions. If you are using AUC@TeX{} with the font-latex library, a
18154 much better solution is to add the @code{comment} environment to the
18155 variable @code{LaTeX-verbatim-environments}.}:
18158 % BEGIN RECEIVE ORGTBL salesfigures
18159 % END RECEIVE ORGTBL salesfigures
18161 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18162 | Month | Days | Nr sold | per day |
18163 |-------+------+---------+---------|
18164 | Jan | 23 | 55 | 2.4 |
18165 | Feb | 21 | 16 | 0.8 |
18166 | March | 22 | 278 | 12.6 |
18167 #+TBLFM: $4=$3/$2;%.1f
18168 % $ (optional extra dollar to keep font-lock happy, see footnote)
18173 When you are done, press @kbd{C-c C-c} in the table to get the converted
18174 table inserted between the two marker lines.
18176 Now let's assume you want to make the table header by hand, because you
18177 want to control how columns are aligned, etc. In this case we make sure
18178 that the table translator skips the first 2 lines of the source
18179 table, and tell the command to work as a @i{splice}, i.e., to not produce
18180 header and footer commands of the target table:
18183 \begin@{tabular@}@{lrrr@}
18184 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
18185 % BEGIN RECEIVE ORGTBL salesfigures
18186 % END RECEIVE ORGTBL salesfigures
18190 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
18191 | Month | Days | Nr sold | per day |
18192 |-------+------+---------+---------|
18193 | Jan | 23 | 55 | 2.4 |
18194 | Feb | 21 | 16 | 0.8 |
18195 | March | 22 | 278 | 12.6 |
18196 #+TBLFM: $4=$3/$2;%.1f
18200 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
18201 Orgtbl mode. By default, it uses a @code{tabular} environment to typeset the
18202 table and marks horizontal lines with @code{\hline}. You can control the
18203 output through several parameters (see also @pxref{Translator functions}),
18204 including the following ones :
18207 @item :splice nil/t
18208 When non-@code{nil}, return only table body lines, don't wrap them into a tabular
18209 environment. Default is @code{nil}.
18212 A format to be used to wrap each field, it should contain @code{%s} for the
18213 original field value. For example, to wrap each field value in dollars,
18214 you could use @code{:fmt "$%s$"}. This may also be a property list with
18215 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
18216 A function of one argument can be used in place of the strings; the
18217 function must return a formatted string.
18220 Use this format to print numbers with exponentials. The format should have
18221 @code{%s} twice for inserting mantissa and exponent, for example
18222 @code{"%s\\times10^@{%s@}"}. This may also be a property list with column
18223 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
18224 4 "$%s\\cdot10^@{%s@}$")}. After @code{efmt} has been applied to a value,
18225 @code{fmt} will also be applied. Similar to @code{fmt}, functions of two
18226 arguments can be supplied instead of strings. By default, no special
18227 formatting is applied.
18230 @node Translator functions
18231 @subsection Translator functions
18232 @cindex HTML, and Orgtbl mode
18233 @cindex translator function
18235 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
18236 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
18237 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
18238 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}. These all use
18239 a generic translator, @code{orgtbl-to-generic}, which, in turn, delegates
18240 translations to various export back-ends.
18242 In particular, properties passed into the function (i.e., the ones set by the
18243 @samp{ORGTBL SEND} line) take precedence over translations defined in the
18244 function. So if you would like to use the @LaTeX{} translator, but wanted
18245 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
18246 could just overrule the default with
18249 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
18252 For a new language, you can use the generic function to write your own
18253 converter function. For example, if you have a language where a table is
18254 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
18255 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
18256 separator is a TAB, you could define your generic translator like this:
18259 (defun orgtbl-to-language (table params)
18260 "Convert the orgtbl-mode TABLE to language."
18263 (org-combine-plists
18264 '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
18269 Please check the documentation string of the function
18270 @code{orgtbl-to-generic} for a full list of parameters understood by
18271 that function, and remember that you can pass each of them into
18272 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
18273 using the generic function.
18275 Of course you can also write a completely new function doing complicated
18276 things the generic translator cannot do. A translator function takes
18277 two arguments. The first argument is the table, a list of lines, each
18278 line either the symbol @code{hline} or a list of fields. The second
18279 argument is the property list containing all parameters specified in the
18280 @samp{#+ORGTBL: SEND} line. The function must return a single string
18281 containing the formatted table. If you write a generally useful
18282 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
18283 others can benefit from your work.
18286 @subsection Radio lists
18287 @cindex radio lists
18288 @cindex org-list-insert-radio-list
18290 Sending and receiving radio lists works exactly the same way as sending and
18291 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
18292 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
18293 @code{org-list-insert-radio-list}.
18295 Here are the differences with radio tables:
18300 Orgstruct mode must be active.
18302 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
18304 @kbd{C-c C-c} will work when pressed on the first item of the list.
18307 Built-in translators functions are : @code{org-list-to-latex},
18308 @code{org-list-to-html} and @code{org-list-to-texinfo}. They all use the
18309 generic translator @code{org-list-to-generic}. Please check its
18310 documentation for a list of supported parameters, which can be used to
18311 control more accurately how the list should be rendered.
18313 Here is a @LaTeX{} example. Let's say that you have this in your
18317 % BEGIN RECEIVE ORGLST to-buy
18318 % END RECEIVE ORGLST to-buy
18320 #+ORGLST: SEND to-buy org-list-to-latex
18329 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
18330 @LaTeX{} list between the two marker lines.
18332 @node Dynamic blocks
18333 @section Dynamic blocks
18334 @cindex dynamic blocks
18336 Org documents can contain @emph{dynamic blocks}. These are
18337 specially marked regions that are updated by some user-written function.
18338 A good example for such a block is the clock table inserted by the
18339 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
18341 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
18342 to the block and can also specify parameters for the function producing
18343 the content of the block.
18345 @cindex #+BEGIN:dynamic block
18347 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
18352 Dynamic blocks are updated with the following commands
18355 @orgcmd{C-c C-x C-u,org-dblock-update}
18356 Update dynamic block at point.
18357 @orgkey{C-u C-c C-x C-u}
18358 Update all dynamic blocks in the current file.
18361 Updating a dynamic block means to remove all the text between BEGIN and
18362 END, parse the BEGIN line for parameters and then call the specific
18363 writer function for this block to insert the new content. If you want
18364 to use the original content in the writer function, you can use the
18365 extra parameter @code{:content}.
18367 For a block with name @code{myblock}, the writer function is
18368 @code{org-dblock-write:myblock} with as only parameter a property list
18369 with the parameters given in the begin line. Here is a trivial example
18370 of a block that keeps track of when the block update function was last
18374 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
18380 The corresponding block writer function could look like this:
18383 (defun org-dblock-write:block-update-time (params)
18384 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
18385 (insert "Last block update at: "
18386 (format-time-string fmt))))
18389 If you want to make sure that all dynamic blocks are always up-to-date,
18390 you could add the function @code{org-update-all-dblocks} to a hook, for
18391 example @code{before-save-hook}. @code{org-update-all-dblocks} is
18392 written in a way such that it does nothing in buffers that are not in
18395 You can narrow the current buffer to the current dynamic block (like any
18396 other block) with @code{org-narrow-to-block}.
18398 @node Special agenda views
18399 @section Special agenda views
18400 @cindex agenda views, user-defined
18402 @vindex org-agenda-skip-function
18403 @vindex org-agenda-skip-function-global
18404 Org provides a special hook that can be used to narrow down the selection
18405 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
18406 @code{agenda*} view is the same as @code{agenda} except that it only
18407 considers @emph{appointments}, i.e., scheduled and deadline items that have a
18408 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
18409 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
18410 specify a function that is used at each match to verify if the match should
18411 indeed be part of the agenda view, and if not, how much should be skipped.
18412 You can specify a global condition that will be applied to all agenda views,
18413 this condition would be stored in the variable
18414 @code{org-agenda-skip-function-global}. More commonly, such a definition is
18415 applied only to specific custom searches, using
18416 @code{org-agenda-skip-function}.
18418 Let's say you want to produce a list of projects that contain a WAITING
18419 tag anywhere in the project tree. Let's further assume that you have
18420 marked all tree headings that define a project with the TODO keyword
18421 PROJECT@. In this case you would run a TODO search for the keyword
18422 PROJECT, but skip the match unless there is a WAITING tag anywhere in
18423 the subtree belonging to the project line.
18425 To achieve this, you must write a function that searches the subtree for
18426 the tag. If the tag is found, the function must return @code{nil} to
18427 indicate that this match should not be skipped. If there is no such
18428 tag, return the location of the end of the subtree, to indicate that
18429 search should continue from there.
18432 (defun my-skip-unless-waiting ()
18433 "Skip trees that are not waiting"
18434 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
18435 (if (re-search-forward ":waiting:" subtree-end t)
18436 nil ; tag found, do not skip
18437 subtree-end))) ; tag not found, continue after end of subtree
18440 Now you may use this function in an agenda custom command, for example
18444 (org-add-agenda-custom-command
18445 '("b" todo "PROJECT"
18446 ((org-agenda-skip-function 'my-skip-unless-waiting)
18447 (org-agenda-overriding-header "Projects waiting for something: "))))
18450 @vindex org-agenda-overriding-header
18451 Note that this also binds @code{org-agenda-overriding-header} to get a
18452 meaningful header in the agenda view.
18454 @vindex org-odd-levels-only
18455 @vindex org-agenda-skip-function
18456 A general way to create custom searches is to base them on a search for
18457 entries with a certain level limit. If you want to study all entries with
18458 your custom search function, simply do a search for
18459 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
18460 level number corresponds to order in the hierarchy, not to the number of
18461 stars.}, and then use @code{org-agenda-skip-function} to select the entries
18462 you really want to have.
18464 You may also put a Lisp form into @code{org-agenda-skip-function}. In
18465 particular, you may use the functions @code{org-agenda-skip-entry-if}
18466 and @code{org-agenda-skip-subtree-if} in this form, for example:
18469 @item (org-agenda-skip-entry-if 'scheduled)
18470 Skip current entry if it has been scheduled.
18471 @item (org-agenda-skip-entry-if 'notscheduled)
18472 Skip current entry if it has not been scheduled.
18473 @item (org-agenda-skip-entry-if 'deadline)
18474 Skip current entry if it has a deadline.
18475 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
18476 Skip current entry if it has a deadline, or if it is scheduled.
18477 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
18478 Skip current entry if the TODO keyword is TODO or WAITING.
18479 @item (org-agenda-skip-entry-if 'todo 'done)
18480 Skip current entry if the TODO keyword marks a DONE state.
18481 @item (org-agenda-skip-entry-if 'timestamp)
18482 Skip current entry if it has any timestamp, may also be deadline or scheduled.
18483 @anchor{x-agenda-skip-entry-regexp}
18484 @item (org-agenda-skip-entry-if 'regexp "regular expression")
18485 Skip current entry if the regular expression matches in the entry.
18486 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
18487 Skip current entry unless the regular expression matches.
18488 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
18489 Same as above, but check and skip the entire subtree.
18492 Therefore we could also have written the search for WAITING projects
18493 like this, even without defining a special function:
18496 (org-add-agenda-custom-command
18497 '("b" todo "PROJECT"
18498 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
18499 'regexp ":waiting:"))
18500 (org-agenda-overriding-header "Projects waiting for something: "))))
18503 @node Speeding up your agendas
18504 @section Speeding up your agendas
18505 @cindex agenda views, optimization
18507 When your Org files grow in both number and size, agenda commands may start
18508 to become slow. Below are some tips on how to speed up the agenda commands.
18512 Reduce the number of Org agenda files: this will reduce the slowdown caused
18513 by accessing a hard drive.
18515 Reduce the number of DONE and archived headlines: this way the agenda does
18516 not need to skip them.
18518 @vindex org-agenda-dim-blocked-tasks
18519 Inhibit the dimming of blocked tasks:
18521 (setq org-agenda-dim-blocked-tasks nil)
18524 @vindex org-startup-folded
18525 @vindex org-agenda-inhibit-startup
18526 Inhibit agenda files startup options:
18528 (setq org-agenda-inhibit-startup nil)
18531 @vindex org-agenda-show-inherited-tags
18532 @vindex org-agenda-use-tag-inheritance
18533 Disable tag inheritance in agenda:
18535 (setq org-agenda-use-tag-inheritance nil)
18539 You can set these options for specific agenda views only. See the docstrings
18540 of these variables for details on why they affect the agenda generation, and
18541 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18542 page} for further explanations.
18544 @node Extracting agenda information
18545 @section Extracting agenda information
18546 @cindex agenda, pipe
18547 @cindex Scripts, for agenda processing
18549 @vindex org-agenda-custom-commands
18550 Org provides commands to access agenda information for the command
18551 line in Emacs batch mode. This extracted information can be sent
18552 directly to a printer, or it can be read by a program that does further
18553 processing of the data. The first of these commands is the function
18554 @code{org-batch-agenda}, that produces an agenda view and sends it as
18555 ASCII text to STDOUT@. The command takes a single string as parameter.
18556 If the string has length 1, it is used as a key to one of the commands
18557 you have configured in @code{org-agenda-custom-commands}, basically any
18558 key you can use after @kbd{C-c a}. For example, to directly print the
18559 current TODO list, you could use
18562 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18565 If the parameter is a string with 2 or more characters, it is used as a
18566 tags/TODO match string. For example, to print your local shopping list
18567 (all items with the tag @samp{shop}, but excluding the tag
18568 @samp{NewYork}), you could use
18571 emacs -batch -l ~/.emacs \
18572 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18576 You may also modify parameters on the fly like this:
18579 emacs -batch -l ~/.emacs \
18580 -eval '(org-batch-agenda "a" \
18581 org-agenda-span (quote month) \
18582 org-agenda-include-diary nil \
18583 org-agenda-files (quote ("~/org/project.org")))' \
18588 which will produce a 30-day agenda, fully restricted to the Org file
18589 @file{~/org/projects.org}, not even including the diary.
18591 If you want to process the agenda data in more sophisticated ways, you
18592 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18593 list of values for each agenda item. Each line in the output will
18594 contain a number of fields separated by commas. The fields in a line
18598 category @r{The category of the item}
18599 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
18600 type @r{The type of the agenda entry, can be}
18601 todo @r{selected in TODO match}
18602 tagsmatch @r{selected in tags match}
18603 diary @r{imported from diary}
18604 deadline @r{a deadline}
18605 scheduled @r{scheduled}
18606 timestamp @r{appointment, selected by timestamp}
18607 closed @r{entry was closed on date}
18608 upcoming-deadline @r{warning about nearing deadline}
18609 past-scheduled @r{forwarded scheduled item}
18610 block @r{entry has date block including date}
18611 todo @r{The TODO keyword, if any}
18612 tags @r{All tags including inherited ones, separated by colons}
18613 date @r{The relevant date, like 2007-2-14}
18614 time @r{The time, like 15:00-16:50}
18615 extra @r{String with extra planning info}
18616 priority-l @r{The priority letter if any was given}
18617 priority-n @r{The computed numerical priority}
18621 Time and date will only be given if a timestamp (or deadline/scheduled)
18622 led to the selection of the item.
18624 A CSV list like this is very easy to use in a post-processing script.
18625 For example, here is a Perl program that gets the TODO list from
18626 Emacs/Org and prints all the items, preceded by a checkbox:
18631 # define the Emacs command to run
18632 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18634 # run it and capture the output
18635 $agenda = qx@{$cmd 2>/dev/null@};
18637 # loop over all lines
18638 foreach $line (split(/\n/,$agenda)) @{
18639 # get the individual values
18640 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18641 $priority_l,$priority_n) = split(/,/,$line);
18642 # process and print
18643 print "[ ] $head\n";
18647 @node Using the property API
18648 @section Using the property API
18649 @cindex API, for properties
18650 @cindex properties, API
18652 Here is a description of the functions that can be used to work with
18655 @defun org-entry-properties &optional pom which
18656 Get all properties of the entry at point-or-marker POM.@*
18657 This includes the TODO keyword, the tags, time strings for deadline,
18658 scheduled, and clocking, and any additional properties defined in the
18659 entry. The return value is an alist. Keys may occur multiple times
18660 if the property key was used several times.@*
18661 POM may also be @code{nil}, in which case the current entry is used.
18662 If WHICH is @code{nil} or @code{all}, get all properties. If WHICH is
18663 @code{special} or @code{standard}, only get that subclass.
18665 @vindex org-use-property-inheritance
18666 @findex org-insert-property-drawer
18667 @defun org-entry-get pom property &optional inherit
18668 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
18669 this only looks at properties defined locally in the entry. If @code{INHERIT}
18670 is non-@code{nil} and the entry does not have the property, then also check
18671 higher levels of the hierarchy. If @code{INHERIT} is the symbol
18672 @code{selective}, use inheritance if and only if the setting of
18673 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18676 @defun org-entry-delete pom property
18677 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18680 @defun org-entry-put pom property value
18681 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18684 @defun org-buffer-property-keys &optional include-specials
18685 Get all property keys in the current buffer.
18688 @defun org-insert-property-drawer
18689 Insert a property drawer for the current entry.
18692 @defun org-entry-put-multivalued-property pom property &rest values
18693 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18694 @code{VALUES} should be a list of strings. They will be concatenated, with
18695 spaces as separators.
18698 @defun org-entry-get-multivalued-property pom property
18699 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18700 list of values and return the values as a list of strings.
18703 @defun org-entry-add-to-multivalued-property pom property value
18704 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18705 list of values and make sure that @code{VALUE} is in this list.
18708 @defun org-entry-remove-from-multivalued-property pom property value
18709 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18710 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18713 @defun org-entry-member-in-multivalued-property pom property value
18714 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18715 list of values and check if @code{VALUE} is in this list.
18718 @defopt org-property-allowed-value-functions
18719 Hook for functions supplying allowed values for a specific property.
18720 The functions must take a single argument, the name of the property, and
18721 return a flat list of allowed values. If @samp{:ETC} is one of
18722 the values, use the values as completion help, but allow also other values
18723 to be entered. The functions must return @code{nil} if they are not
18724 responsible for this property.
18727 @node Using the mapping API
18728 @section Using the mapping API
18729 @cindex API, for mapping
18730 @cindex mapping entries, API
18732 Org has sophisticated mapping capabilities to find all entries satisfying
18733 certain criteria. Internally, this functionality is used to produce agenda
18734 views, but there is also an API that can be used to execute arbitrary
18735 functions for each or selected entries. The main entry point for this API
18738 @defun org-map-entries func &optional match scope &rest skip
18739 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18741 @code{FUNC} is a function or a Lisp form. The function will be called
18742 without arguments, with the cursor positioned at the beginning of the
18743 headline. The return values of all calls to the function will be collected
18744 and returned as a list.
18746 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18747 @code{FUNC} does not need to preserve point. After evaluation, the cursor
18748 will be moved to the end of the line (presumably of the headline of the
18749 processed entry) and search continues from there. Under some circumstances,
18750 this may not produce the wanted results. For example, if you have removed
18751 (e.g., archived) the current (sub)tree it could mean that the next entry will
18752 be skipped entirely. In such cases, you can specify the position from where
18753 search should continue by making @code{FUNC} set the variable
18754 @code{org-map-continue-from} to the desired buffer position.
18756 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18757 view. Only headlines that are matched by this query will be considered
18758 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
18759 headlines will be visited by the iteration.
18761 @code{SCOPE} determines the scope of this command. It can be any of:
18764 nil @r{the current buffer, respecting the restriction if any}
18765 tree @r{the subtree started with the entry at point}
18766 region @r{The entries within the active region, if any}
18767 file @r{the current buffer, without restriction}
18769 @r{the current buffer, and any archives associated with it}
18770 agenda @r{all agenda files}
18771 agenda-with-archives
18772 @r{all agenda files with any archive files associated with them}
18774 @r{if this is a list, all files in the list will be scanned}
18777 The remaining args are treated as settings for the skipping facilities of
18778 the scanner. The following items can be given here:
18780 @vindex org-agenda-skip-function
18782 archive @r{skip trees with the archive tag}
18783 comment @r{skip trees with the COMMENT keyword}
18784 function or Lisp form
18785 @r{will be used as value for @code{org-agenda-skip-function},}
18786 @r{so whenever the function returns t, FUNC}
18787 @r{will not be called for that entry and search will}
18788 @r{continue from the point where the function leaves it}
18792 The function given to that mapping routine can really do anything you like.
18793 It can use the property API (@pxref{Using the property API}) to gather more
18794 information about the entry, or in order to change metadata in the entry.
18795 Here are a couple of functions that might be handy:
18797 @defun org-todo &optional arg
18798 Change the TODO state of the entry. See the docstring of the functions for
18799 the many possible values for the argument @code{ARG}.
18802 @defun org-priority &optional action
18803 Change the priority of the entry. See the docstring of this function for the
18804 possible values for @code{ACTION}.
18807 @defun org-toggle-tag tag &optional onoff
18808 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
18809 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18814 Promote the current entry.
18818 Demote the current entry.
18821 Here is a simple example that will turn all entries in the current file with
18822 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18823 Entries in comment trees and in archive trees will be ignored.
18827 '(org-todo "UPCOMING")
18828 "+TOMORROW" 'file 'archive 'comment)
18831 The following example counts the number of entries with TODO keyword
18832 @code{WAITING}, in all agenda files.
18835 (length (org-map-entries t "/+WAITING" 'agenda))
18839 @appendix MobileOrg
18843 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18844 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
18845 capture support for an Org mode system rooted on a ``real'' computer. It
18846 also allows you to record changes to existing entries. The
18847 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18848 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18849 and is now in the hands Sean Escriva. Android users should check out
18850 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18851 by Matt Jones. The two implementations are not identical but offer similar
18854 This appendix describes the support Org has for creating agenda views in a
18855 format that can be displayed by @i{MobileOrg}, and for integrating notes
18856 captured and changes made by @i{MobileOrg} into the main system.
18858 For changing tags and TODO states in MobileOrg, you should have set up the
18859 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18860 cover all important tags and TODO keywords, even if individual files use only
18861 part of these. MobileOrg will also offer you states and tags set up with
18862 in-buffer settings, but it will understand the logistics of TODO state
18863 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18864 (@pxref{Setting tags}) only for those set in these variables.
18867 * Setting up the staging area:: Where to interact with the mobile device
18868 * Pushing to MobileOrg:: Uploading Org files and agendas
18869 * Pulling from MobileOrg:: Integrating captured and flagged items
18872 @node Setting up the staging area
18873 @section Setting up the staging area
18875 MobileOrg needs to interact with Emacs through a directory on a server. If
18876 you are using a public server, you should consider encrypting the files that
18877 are uploaded to the server. This can be done with Org mode 7.02 and with
18878 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18879 installation on your system. To turn on encryption, set a password in
18880 @i{MobileOrg} and, on the Emacs side, configure the variable
18881 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18882 password in your Emacs setup, you might also want to configure
18883 @code{org-mobile-encryption-password}. Please read the docstring of that
18884 variable. Note that encryption will apply only to the contents of the
18885 @file{.org} files. The file names themselves will remain visible.}.
18887 The easiest way to create that directory is to use a free
18888 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18889 Dropbox, or if your version of MobileOrg does not support it, you can use a
18890 webdav server. For more information, check out the documentation of MobileOrg and also this
18891 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18892 When MobileOrg first connects to your Dropbox, it will create a directory
18893 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
18897 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18900 Org mode has commands to put files for @i{MobileOrg} into that directory,
18901 and to read captured notes from there.
18903 @node Pushing to MobileOrg
18904 @section Pushing to MobileOrg
18906 This operation copies all files currently listed in @code{org-mobile-files}
18907 to the directory @code{org-mobile-directory}. By default this list contains
18908 all agenda files (as listed in @code{org-agenda-files}), but additional files
18909 can be included by customizing @code{org-mobile-files}. File names will be
18910 staged with paths relative to @code{org-directory}, so all files should be
18911 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18912 have the same name as their targets.}.
18914 The push operation also creates a special Org file @file{agendas.org} with
18915 all custom agenda view defined by the user@footnote{While creating the
18916 agendas, Org mode will force ID properties on all referenced entries, so that
18917 these entries can be uniquely identified if @i{MobileOrg} flags them for
18918 further action. If you do not want to get these properties in so many
18919 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18920 to @code{nil}. Org mode will then rely on outline paths, in the hope that
18921 these will be unique enough.}.
18923 Finally, Org writes the file @file{index.org}, containing links to all other
18924 files. @i{MobileOrg} first reads this file from the server, and then
18925 downloads all agendas and Org files listed in it. To speed up the download,
18926 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18927 automatically in the file @file{checksums.dat}} have changed.
18929 @node Pulling from MobileOrg
18930 @section Pulling from MobileOrg
18932 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18933 files for viewing. It also appends captured entries and pointers to flagged
18934 and changed entries to the file @file{mobileorg.org} on the server. Org has
18935 a @emph{pull} operation that integrates this information into an inbox file
18936 and operates on the pointers to flagged entries. Here is how it works:
18940 Org moves all entries found in
18941 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18942 operation.} and appends them to the file pointed to by the variable
18943 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
18944 will be a top-level entry in the inbox file.
18946 After moving the entries, Org will attempt to implement the changes made in
18947 @i{MobileOrg}. Some changes are applied directly and without user
18948 interaction. Examples are all changes to tags, TODO state, headline and body
18949 text that can be cleanly applied. Entries that have been flagged for further
18950 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18951 again. When there is a problem finding an entry or applying the change, the
18952 pointer entry will remain in the inbox and will be marked with an error
18953 message. You need to later resolve these issues by hand.
18955 Org will then generate an agenda view with all flagged entries. The user
18956 should then go through these entries and do whatever actions are necessary.
18957 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18958 will be displayed in the echo area when the cursor is on the corresponding
18964 Pressing @kbd{?} in that special agenda will display the full flagging note in
18965 another window and also push it onto the kill ring. So you could use @kbd{?
18966 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18967 Pressing @kbd{?} twice in succession will offer to remove the
18968 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18969 in a property). In this way you indicate that the intended processing for
18970 this flagged entry is finished.
18975 If you are not able to process all flagged entries directly, you can always
18976 return to this agenda view@footnote{Note, however, that there is a subtle
18977 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
18978 is guaranteed to search all files that have been addressed by the last pull.
18979 This might include a file that is not currently in your list of agenda files.
18980 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18981 agenda files will be searched.} using @kbd{C-c a ?}.
18983 @node History and acknowledgments
18984 @appendix History and acknowledgments
18985 @cindex acknowledgments
18989 @section From Carsten
18991 Org was born in 2003, out of frustration over the user interface of the Emacs
18992 Outline mode. I was trying to organize my notes and projects, and using
18993 Emacs seemed to be the natural way to go. However, having to remember eleven
18994 different commands with two or three keys per command, only to hide and show
18995 parts of the outline tree, that seemed entirely unacceptable to me. Also,
18996 when using outlines to take notes, I constantly wanted to restructure the
18997 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
18998 cycling} and @emph{structure editing} were originally implemented in the
18999 package @file{outline-magic.el}, but quickly moved to the more general
19000 @file{org.el}. As this environment became comfortable for project planning,
19001 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
19002 @emph{table support}. These areas highlighted the two main goals that Org
19003 still has today: to be a new, outline-based, plain text mode with innovative
19004 and intuitive editing features, and to incorporate project planning
19005 functionality directly into a notes file.
19007 Since the first release, literally thousands of emails to me or to
19008 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
19009 reports, feedback, new ideas, and sometimes patches and add-on code.
19010 Many thanks to everyone who has helped to improve this package. I am
19011 trying to keep here a list of the people who had significant influence
19012 in shaping one or more aspects of Org. The list may not be
19013 complete, if I have forgotten someone, please accept my apologies and
19016 Before I get to this list, a few special mentions are in order:
19019 @item Bastien Guerry
19020 Bastien has written a large number of extensions to Org (most of them
19021 integrated into the core by now), including the @LaTeX{} exporter and the
19022 plain list parser. His support during the early days was central to the
19023 success of this project. Bastien also invented Worg, helped establishing the
19024 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
19025 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
19026 I desparately needed a break.
19027 @item Eric Schulte and Dan Davison
19028 Eric and Dan are jointly responsible for the Org-babel system, which turns
19029 Org into a multi-language environment for evaluating code and doing literate
19030 programming and reproducible research. This has become one of Org's killer
19031 features that define what Org is today.
19033 John has contributed a number of great ideas and patches directly to Org,
19034 including the attachment system (@file{org-attach.el}), integration with
19035 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
19036 items, habit tracking (@file{org-habits.el}), and encryption
19037 (@file{org-crypt.el}). Also, the capture system is really an extended copy
19038 of his great @file{remember.el}.
19039 @item Sebastian Rose
19040 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
19041 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
19042 higher level. He also wrote @file{org-info.js}, a Java script for displaying
19043 web pages derived from Org using an Info-like or a folding interface with
19044 single-key navigation.
19047 @noindent See below for the full list of contributions! Again, please
19048 let me know what I am missing here!
19050 @section From Bastien
19052 I (Bastien) have been maintaining Org between 2011 and 2013. This appendix
19053 would not be complete without adding a few more acknowledgements and thanks.
19055 I am first grateful to Carsten for his trust while handing me over the
19056 maintainership of Org. His unremitting support is what really helped me
19057 getting more confident over time, with both the community and the code.
19059 When I took over maintainership, I knew I would have to make Org more
19060 collaborative than ever, as I would have to rely on people that are more
19061 knowledgeable than I am on many parts of the code. Here is a list of the
19062 persons I could rely on, they should really be considered co-maintainers,
19063 either of the code or the community:
19067 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
19068 from worrying about possible bugs here and let me focus on other parts.
19070 @item Nicolas Goaziou
19071 Nicolas is maintaining the consistency of the deepest parts of Org. His work
19072 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
19073 the doors for many new ideas and features. He rewrote many of the old
19074 exporters to use the new export engine, and helped with documenting this
19075 major change. More importantly (if that's possible), he has been more than
19076 reliable during all the work done for Org 8.0, and always very reactive on
19080 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
19081 into a flexible and conceptually clean process. He patiently coped with the
19082 many hiccups that such a change can create for users.
19085 The Org mode mailing list would not be such a nice place without Nick, who
19086 patiently helped users so many times. It is impossible to overestimate such
19087 a great help, and the list would not be so active without him.
19090 I received support from so many users that it is clearly impossible to be
19091 fair when shortlisting a few of them, but Org's history would not be
19092 complete if the ones above were not mentioned in this manual.
19094 @section List of contributions
19099 @i{Russel Adams} came up with the idea for drawers.
19101 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
19102 feedback on many features and several patches.
19104 @i{Luis Anaya} wrote @file{ox-man.el}.
19106 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
19108 @i{Michael Brand} helped by reporting many bugs and testing many features.
19109 He also implemented the distinction between empty fields and 0-value fields
19110 in Org's spreadsheets.
19112 @i{Christophe Bataillon} created the great unicorn logo that we use on the
19115 @i{Alex Bochannek} provided a patch for rounding timestamps.
19117 @i{Jan Böcker} wrote @file{org-docview.el}.
19119 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
19121 @i{Tom Breton} wrote @file{org-choose.el}.
19123 @i{Charles Cave}'s suggestion sparked the implementation of templates
19124 for Remember, which are now templates for capture.
19126 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
19129 @i{Gregory Chernov} patched support for Lisp forms into table
19130 calculations and improved XEmacs compatibility, in particular by porting
19131 @file{nouline.el} to XEmacs.
19133 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
19134 make Org pupular through her blog.
19136 @i{Toby S. Cubitt} contributed to the code for clock formats.
19138 @i{Baoqiu Cui} contributed the first DocBook exporter. In Org 8.0, we go a
19139 different route: you can now export to Texinfo and export the @file{.texi}
19140 file to DocBook using @code{makeinfo}.
19142 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
19143 came up with the idea of properties, and that there should be an API for
19146 @i{Nick Dokos} tracked down several nasty bugs.
19148 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
19149 inspired some of the early development, including HTML export. He also
19150 asked for a way to narrow wide table columns.
19152 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
19153 several years now. He also sponsored the hosting costs until Rackspace
19154 started to host us for free.
19156 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
19157 the Org-Babel documentation into the manual.
19159 @i{Christian Egli} converted the documentation into Texinfo format, inspired
19160 the agenda, patched CSS formatting into the HTML exporter, and wrote
19161 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
19162 @file{ox-taskjuggler.el} for Org 8.0.
19164 @i{David Emery} provided a patch for custom CSS support in exported
19167 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
19169 @i{Nic Ferrier} contributed mailcap and XOXO support.
19171 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
19173 @i{John Foerch} figured out how to make incremental search show context
19174 around a match in a hidden outline tree.
19176 @i{Raimar Finken} wrote @file{org-git-line.el}.
19178 @i{Mikael Fornius} works as a mailing list moderator.
19180 @i{Austin Frank} works as a mailing list moderator.
19182 @i{Eric Fraga} drove the development of BEAMER export with ideas and
19185 @i{Barry Gidden} did proofreading the manual in preparation for the book
19186 publication through Network Theory Ltd.
19188 @i{Niels Giesen} had the idea to automatically archive DONE trees.
19190 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
19191 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
19192 in implementing a clean framework for Org exporters.
19194 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
19196 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
19199 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
19200 task state change logging, and the clocktable. His clear explanations have
19201 been critical when we started to adopt the Git version control system.
19203 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
19206 @i{Phil Jackson} wrote @file{org-irc.el}.
19208 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
19209 folded entries, and column view for properties.
19211 @i{Matt Jones} wrote @i{MobileOrg Android}.
19213 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
19215 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
19217 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
19218 provided frequent feedback and some patches.
19220 @i{Matt Lundin} has proposed last-row references for table formulas and named
19221 invisible anchors. He has also worked a lot on the FAQ.
19223 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
19224 and is a prolific contributor on the mailing list with competent replies,
19225 small fixes and patches.
19227 @i{Jason F. McBrayer} suggested agenda export to CSV format.
19229 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
19231 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
19234 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
19237 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
19239 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
19240 and being able to quickly restrict the agenda to a subtree.
19242 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
19244 @i{Greg Newman} refreshed the unicorn logo into its current form.
19246 @i{Tim O'Callaghan} suggested in-file links, search options for general
19247 file links, and TAGS.
19249 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
19250 version of the reference card.
19252 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
19255 @i{Oliver Oppitz} suggested multi-state TODO items.
19257 @i{Scott Otterson} sparked the introduction of descriptive text for
19258 links, among other things.
19260 @i{Pete Phillips} helped during the development of the TAGS feature, and
19261 provided frequent feedback.
19263 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
19266 @i{Martin Pohlack} provided the code snippet to bundle character insertion
19267 into bundles of 20 for undo.
19269 @i{Rackspace.com} is hosting our website for free. Thank you Rackspace!
19271 @i{T.V. Raman} reported bugs and suggested improvements.
19273 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
19276 @i{Paul Rivier} provided the basic implementation of named footnotes. He
19277 also acted as mailing list moderator for some time.
19279 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
19281 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
19282 conflict with @file{allout.el}.
19284 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
19287 @i{Philip Rooke} created the Org reference card, provided lots
19288 of feedback, developed and applied standards to the Org documentation.
19290 @i{Christian Schlauer} proposed angular brackets around links, among
19293 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
19294 enjoy folding in non-org buffers by using Org headlines in comments.
19296 @i{Paul Sexton} wrote @file{org-ctags.el}.
19298 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
19299 @file{organizer-mode.el}.
19301 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
19302 examples, and remote highlighting for referenced code lines.
19304 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
19305 now packaged into Org's @file{contrib} directory.
19307 @i{Daniel Sinder} came up with the idea of internal archiving by locking
19310 @i{Dale Smith} proposed link abbreviations.
19312 @i{James TD Smith} has contributed a large number of patches for useful
19313 tweaks and features.
19315 @i{Adam Spiers} asked for global linking commands, inspired the link
19316 extension system, added support for mairix, and proposed the mapping API.
19318 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
19319 @LaTeX{}, UTF-8, Latin-1 and ASCII.
19321 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
19322 with links transformation to Org syntax.
19324 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
19325 chapter about publishing.
19327 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
19329 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
19330 enabled source code highlighting in Gnus.
19332 @i{Stefan Vollmar} organized a video-recorded talk at the
19333 Max-Planck-Institute for Neurology. He also inspired the creation of a
19334 concept index for HTML export.
19336 @i{Jürgen Vollmer} contributed code generating the table of contents
19339 @i{Samuel Wales} has provided important feedback and bug reports.
19341 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
19344 @i{David Wainberg} suggested archiving, and improvements to the linking
19347 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
19350 @i{Roland Winkler} requested additional key bindings to make Org
19353 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
19354 and contributed various ideas and code snippets.
19356 @i{Marco Wahl} wrote @file{org-eww.el}.
19360 @node GNU Free Documentation License
19361 @appendix GNU Free Documentation License
19362 @include doclicense.texi
19366 @unnumbered Concept index
19371 @unnumbered Key index
19375 @node Command and Function Index
19376 @unnumbered Command and function index
19380 @node Variable Index
19381 @unnumbered Variable index
19383 This is not a complete index of variables and faces, only the ones that are
19384 mentioned in the manual. For a more complete list, use @kbd{M-x
19385 org-customize @key{RET}} and then click yourself through the tree.
19391 @c Local variables:
19393 @c indent-tabs-mode: nil
19394 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
19395 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
19399 @c LocalWords: webdavhost pre