1 \input texinfo @c -*- coding: utf-8 -*-
3 @setfilename ../../info/org.info
4 @settitle The Org Manual
7 @include org-version.inc
9 @c Version and Contact Info
10 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
11 @set AUTHOR Carsten Dominik
12 @set MAINTAINER Carsten Dominik
13 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
14 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
19 @c -----------------------------------------------------------------------------
21 @c Macro definitions for commands and keys
22 @c =======================================
24 @c The behavior of the key/command macros will depend on the flag cmdnames
25 @c When set, commands names are shown. When clear, they are not shown.
29 @c Below we define the following macros for Org key tables:
31 @c orgkey{key} A key item
32 @c orgcmd{key,cmd} Key with command name
33 @c xorgcmd{key,cmd} Key with command name as @itemx
34 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
35 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
36 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
37 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
38 @c different functions, so format as @itemx
39 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
40 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
41 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
43 @c a key but no command
55 @c one key with a command
56 @c Inserts: @item KEY COMMAND
57 @macro orgcmd{key,command}
62 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
65 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
74 @c One key with one command, formatted using @itemx
75 @c Inserts: @itemx KEY COMMAND
76 @macro xorgcmd{key,command}
81 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
84 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
93 @c one key with a command, bit do not index the key
94 @c Inserts: @item KEY COMMAND
95 @macro orgcmdnki{key,command}
99 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
102 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
110 @c one key with a command, and special text to replace key in item
111 @c Inserts: @item TEXT COMMAND
112 @macro orgcmdtkc{text,key,command}
117 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
120 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
129 @c two keys with one command
130 @c Inserts: @item KEY1 or KEY2 COMMAND
131 @macro orgcmdkkc{key1,key2,command}
137 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
140 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
150 @c Two keys with one command name, but different functions, so format as
152 @c Inserts: @item KEY1
153 @c @itemx KEY2 COMMAND
154 @macro orgcmdkxkc{key1,key2,command}
161 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
165 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
176 @c Same as previous, but use "or short"
177 @c Inserts: @item KEY1 or short KEY2 COMMAND
178 @macro orgcmdkskc{key1,key2,command}
184 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
187 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
197 @c Same as previous, but use @itemx
198 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
199 @macro xorgcmdkskc{key1,key2,command}
205 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
208 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
218 @c two keys with two commands
219 @c Inserts: @item KEY1 COMMAND1
220 @c @itemx KEY2 COMMAND2
221 @macro orgcmdkkcc{key1,key2,command1,command2}
228 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
229 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
232 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
233 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
243 @c -----------------------------------------------------------------------------
246 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
249 @c Subheadings inside a table.
250 @macro tsubheading{text}
252 @subsubheading \text\
260 This manual is for Org version @value{VERSION}.
262 Copyright @copyright{} 2004--2016 Free Software Foundation, Inc.
265 Permission is granted to copy, distribute and/or modify this document
266 under the terms of the GNU Free Documentation License, Version 1.3 or
267 any later version published by the Free Software Foundation; with no
268 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
269 and with the Back-Cover Texts as in (a) below. A copy of the license
270 is included in the section entitled ``GNU Free Documentation License.''
272 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
273 modify this GNU manual.''
277 @dircategory Emacs editing modes
279 * Org Mode: (org). Outline-based notes management and organizer
283 @title The Org Manual
285 @subtitle Release @value{VERSION}
286 @author by Carsten Dominik
287 with contributions by Bastien Guerry, Nicolas Goaziou, Eric Schulte,
288 Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
290 @c The following two commands start the copyright page.
292 @vskip 0pt plus 1filll
296 @c Output the short table of contents at the beginning.
299 @c Output the table of contents at the beginning.
303 @c FIXME These hand-written next,prev,up node pointers make editing a lot
304 @c harder. There should be no need for them, makeinfo can do it
305 @c automatically for any document with a normal structure.
306 @node Top, Introduction, (dir), (dir)
313 * Introduction:: Getting started
314 * Document structure:: A tree works like your brain
315 * Tables:: Pure magic for quick formatting
316 * Hyperlinks:: Notes in context
317 * TODO items:: Every tree branch can be a TODO item
318 * Tags:: Tagging headlines and matching sets of tags
319 * Properties and columns:: Storing information about an entry
320 * Dates and times:: Making items useful for planning
321 * Capture - Refile - Archive:: The ins and outs for projects
322 * Agenda views:: Collecting information into views
323 * Markup:: Prepare text for rich export
324 * Exporting:: Sharing and publishing notes
325 * Publishing:: Create a web site of linked Org files
326 * Working with source code:: Export, evaluate, and tangle code blocks
327 * Miscellaneous:: All the rest which did not fit elsewhere
328 * Hacking:: How to hack your way around
329 * MobileOrg:: Viewing and capture on a mobile device
330 * History and acknowledgments:: How Org came into being
331 * GNU Free Documentation License:: The license for this documentation.
332 * Main Index:: An index of Org's concepts and features
333 * Key Index:: Key bindings and where they are described
334 * Command and Function Index:: Command names and some internal functions
335 * Variable Index:: Variables mentioned in the manual
338 --- The Detailed Node Listing ---
342 * Summary:: Brief summary of what Org does
343 * Installation:: Installing Org
344 * Activation:: How to activate Org for certain buffers
345 * Feedback:: Bug reports, ideas, patches etc.
346 * Conventions:: Typesetting conventions in the manual
350 * Outlines:: Org is based on Outline mode
351 * Headlines:: How to typeset Org tree headlines
352 * Visibility cycling:: Show and hide, much simplified
353 * Motion:: Jumping to other headlines
354 * Structure editing:: Changing sequence and level of headlines
355 * Sparse trees:: Matches embedded in context
356 * Plain lists:: Additional structure within an entry
357 * Drawers:: Tucking stuff away
358 * Blocks:: Folding blocks
359 * Footnotes:: How footnotes are defined in Org's syntax
360 * Orgstruct mode:: Structure editing outside Org
361 * Org syntax:: Formal description of Org's syntax
365 * Global and local cycling:: Cycling through various visibility states
366 * Initial visibility:: Setting the initial visibility state
367 * Catching invisible edits:: Preventing mistakes when editing invisible parts
371 * Built-in table editor:: Simple tables
372 * Column width and alignment:: Overrule the automatic settings
373 * Column groups:: Grouping to trigger vertical lines
374 * Orgtbl mode:: The table editor as minor mode
375 * The spreadsheet:: The table editor has spreadsheet capabilities
376 * Org-Plot:: Plotting from org tables
380 * References:: How to refer to another field or range
381 * Formula syntax for Calc:: Using Calc to compute stuff
382 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
383 * Durations and time values:: How to compute durations and time values
384 * Field and range formulas:: Formula for specific (ranges of) fields
385 * Column formulas:: Formulas valid for an entire column
386 * Lookup functions:: Lookup functions for searching tables
387 * Editing and debugging formulas:: Fixing formulas
388 * Updating the table:: Recomputing all dependent fields
389 * Advanced features:: Field and column names, parameters and automatic recalc
393 * Link format:: How links in Org are formatted
394 * Internal links:: Links to other places in the current file
395 * External links:: URL-like links to the world
396 * Handling links:: Creating, inserting and following
397 * Using links outside Org:: Linking from my C source code?
398 * Link abbreviations:: Shortcuts for writing complex links
399 * Search options:: Linking to a specific location
400 * Custom searches:: When the default search is not enough
404 * Radio targets:: Make targets trigger links in plain text
408 * TODO basics:: Marking and displaying TODO entries
409 * TODO extensions:: Workflow and assignments
410 * Progress logging:: Dates and notes for progress
411 * Priorities:: Some things are more important than others
412 * Breaking down tasks:: Splitting a task into manageable pieces
413 * Checkboxes:: Tick-off lists
415 Extended use of TODO keywords
417 * Workflow states:: From TODO to DONE in steps
418 * TODO types:: I do this, Fred does the rest
419 * Multiple sets in one file:: Mixing it all, and still finding your way
420 * Fast access to TODO states:: Single letter selection of a state
421 * Per-file keywords:: Different files, different requirements
422 * Faces for TODO keywords:: Highlighting states
423 * TODO dependencies:: When one task needs to wait for others
427 * Closing items:: When was this entry marked DONE?
428 * Tracking TODO state changes:: When did the status change?
429 * Tracking your habits:: How consistent have you been?
433 * Tag inheritance:: Tags use the tree structure of the outline
434 * Setting tags:: How to assign tags to a headline
435 * Tag hierarchy:: Create a hierarchy of tags
436 * Tag searches:: Searching for combinations of tags
438 Properties and columns
440 * Property syntax:: How properties are spelled out
441 * Special properties:: Access to other Org mode features
442 * Property searches:: Matching property values
443 * Property inheritance:: Passing values down the tree
444 * Column view:: Tabular viewing and editing
445 * Property API:: Properties for Lisp programmers
449 * Defining columns:: The COLUMNS format property
450 * Using column view:: How to create and use column view
451 * Capturing column view:: A dynamic block for column view
455 * Scope of column definitions:: Where defined, where valid?
456 * Column attributes:: Appearance and content of a column
460 * Timestamps:: Assigning a time to a tree entry
461 * Creating timestamps:: Commands which insert timestamps
462 * Deadlines and scheduling:: Planning your work
463 * Clocking work time:: Tracking how long you spend on a task
464 * Effort estimates:: Planning work effort in advance
465 * Timers:: Notes with a running timer
469 * The date/time prompt:: How Org mode helps you entering date and time
470 * Custom time format:: Making dates look different
472 Deadlines and scheduling
474 * Inserting deadline/schedule:: Planning items
475 * Repeated tasks:: Items that show up again and again
479 * Clocking commands:: Starting and stopping a clock
480 * The clock table:: Detailed reports
481 * Resolving idle time:: Resolving time when you've been idle
483 Capture - Refile - Archive
485 * Capture:: Capturing new stuff
486 * Attachments:: Add files to tasks
487 * RSS feeds:: Getting input from RSS feeds
488 * Protocols:: External (e.g., Browser) access to Emacs and Org
489 * Refile and copy:: Moving/copying a tree from one place to another
490 * Archiving:: What to do with finished projects
494 * Setting up capture:: Where notes will be stored
495 * Using capture:: Commands to invoke and terminate capture
496 * Capture templates:: Define the outline of different note types
500 * Template elements:: What is needed for a complete template entry
501 * Template expansion:: Filling in information about time and context
502 * Templates in contexts:: Only show a template in a specific context
506 * Moving subtrees:: Moving a tree to an archive file
507 * Internal archiving:: Switch off a tree but keep it in the file
511 * Agenda files:: Files being searched for agenda information
512 * Agenda dispatcher:: Keyboard access to agenda views
513 * Built-in agenda views:: What is available out of the box?
514 * Presentation and sorting:: How agenda items are prepared for display
515 * Agenda commands:: Remote editing of Org trees
516 * Custom agenda views:: Defining special searches and views
517 * Exporting agenda views:: Writing a view to a file
518 * Agenda column view:: Using column view for collected entries
520 The built-in agenda views
522 * Weekly/daily agenda:: The calendar page with current tasks
523 * Global TODO list:: All unfinished action items
524 * Matching tags and properties:: Structured information with fine-tuned search
525 * Timeline:: Time-sorted view for single file
526 * Search view:: Find entries by searching for text
527 * Stuck projects:: Find projects you need to review
529 Presentation and sorting
531 * Categories:: Not all tasks are equal
532 * Time-of-day specifications:: How the agenda knows the time
533 * Sorting agenda items:: The order of things
534 * Filtering/limiting agenda items:: Dynamically narrow the agenda
538 * Storing searches:: Type once, use often
539 * Block agenda:: All the stuff you need in a single buffer
540 * Setting options:: Changing the rules
542 Markup for rich export
544 * Structural markup elements:: The basic structure as seen by the exporter
545 * Images and tables:: Images, tables and caption mechanism
546 * Literal examples:: Source code examples with special formatting
547 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
548 * Special blocks:: Containers targeted at export back-ends
550 Structural markup elements
552 * Document title:: Where the title is taken from
553 * Headings and sections:: The document structure as seen by the exporter
554 * Table of contents:: The if and where of the table of contents
556 * Paragraphs:: Paragraphs
557 * Footnote markup:: Footnotes
558 * Emphasis and monospace:: Bold, italic, etc.
559 * Horizontal rules:: Make a line
560 * Comment lines:: What will *not* be exported
564 * Special symbols:: Greek letters and other symbols
565 * Subscripts and superscripts:: Simple syntax for raising/lowering text
566 * @LaTeX{} fragments:: Complex formulas made easy
567 * Previewing @LaTeX{} fragments:: What will this snippet look like?
568 * CDLaTeX mode:: Speed up entering of formulas
572 * The export dispatcher:: The main exporter interface
573 * Export back-ends:: Built-in export formats
574 * Export settings:: Generic export settings
575 * Include files:: Include additional files into a document
576 * Macro replacement:: Use macros to create templates
577 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
578 * Beamer export:: Exporting as a Beamer presentation
579 * HTML export:: Exporting to HTML
580 * @LaTeX{} export:: Exporting to @LaTeX{}, and processing to PDF
581 * Markdown export:: Exporting to Markdown
582 * OpenDocument Text export:: Exporting to OpenDocument Text
583 * Org export:: Exporting to Org
584 * Texinfo export:: Exporting to Texinfo
585 * iCalendar export:: Exporting to iCalendar
586 * Other built-in back-ends:: Exporting to a man page
587 * Export in foreign buffers:: Author tables and lists in Org syntax
588 * Advanced configuration:: Fine-tuning the export output
592 * Beamer export commands:: How to export Beamer documents.
593 * Beamer specific export settings:: Export settings for Beamer export.
594 * Sectioning Frames and Blocks in Beamer:: Blocks and sections in Beamer.
595 * Beamer specific syntax:: Syntax specific to Beamer.
596 * Editing support:: Helper functions for Org Beamer export.
597 * A Beamer Example:: An complete Beamer example.
601 * HTML Export commands:: How to invoke HTML export
602 * HTML Specific export settings:: Export settings for HTML export
603 * HTML doctypes:: Org can export to various (X)HTML flavors
604 * HTML preamble and postamble:: How to insert a preamble and a postamble
605 * Quoting HTML tags:: Using direct HTML in Org mode
606 * Links in HTML export:: How links will be interpreted and formatted
607 * Tables in HTML export:: How to modify the formatting of tables
608 * Images in HTML export:: How to insert figures into HTML output
609 * Math formatting in HTML export:: Beautiful math also on the web
610 * Text areas in HTML export:: An alternative way to show an example
611 * CSS support:: Changing the appearance of the output
612 * JavaScript support:: Info and Folding in a web browser
616 * @LaTeX{} export commands:: How to export to @LaTeX{} and PDF
617 * @LaTeX{} specific export settings:: Export settings for @LaTeX{}
618 * @LaTeX{} header and sectioning:: Setting up the export file structure
619 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
620 * Tables in @LaTeX{} export:: Specific attributes for tables
621 * Images in @LaTeX{} export:: Specific attributes for images
622 * Plain lists in @LaTeX{} export:: Specific attributes for plain lists
623 * Source blocks in @LaTeX{} export:: Specific attributes for source blocks
624 * Example blocks in @LaTeX{} export:: Specific attributes for example blocks
625 * Special blocks in @LaTeX{} export:: Specific attributes for special blocks
626 * Horizontal rules in @LaTeX{} export:: Specific attributes for horizontal rules
628 OpenDocument Text export
630 * Pre-requisites for ODT export:: What packages ODT exporter relies on
631 * ODT export commands:: How to invoke ODT export
632 * ODT specific export settings:: Export settings for ODT
633 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
634 * Applying custom styles:: How to apply custom styles to the output
635 * Links in ODT export:: How links will be interpreted and formatted
636 * Tables in ODT export:: How Tables are exported
637 * Images in ODT export:: How to insert images
638 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
639 * Labels and captions in ODT export:: How captions are rendered
640 * Literal examples in ODT export:: How source and example blocks are formatted
641 * Advanced topics in ODT export:: Read this if you are a power user
643 Math formatting in ODT export
645 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
646 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
648 Advanced topics in ODT export
650 * Configuring a document converter:: How to register a document converter
651 * Working with OpenDocument style files:: Explore the internals
652 * Creating one-off styles:: How to produce custom highlighting etc
653 * Customizing tables in ODT export:: How to define and use Table templates
654 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
658 * Texinfo export commands:: How to invoke Texinfo export
659 * Texinfo specific export settings:: Export settings for Texinfo
660 * Texinfo file header:: Generating the begining of a Texinfo file
661 * Texinfo title and copyright page:: Creating title and copyright pages
662 * Texinfo @samp{Top} node:: Installing a manual in Info Top node
663 * Headings and sectioning structure:: Building document structure
664 * Indices:: Creating indices
665 * Quoting Texinfo code:: Incorporating literal Texinfo code
666 * Plain lists in Texinfo export:: Specific attributes for plain lists
667 * Tables in Texinfo export:: Specific attributes for tables
668 * Images in Texinfo export:: Specific attributes for images
669 * Special blocks in Texinfo export:: Specific attributes for special blocks
670 * A Texinfo example:: Illustrating Org to Texinfo process
674 * Configuration:: Defining projects
675 * Uploading files:: How to get files up on the server
676 * Sample configuration:: Example projects
677 * Triggering publication:: Publication commands
681 * Project alist:: The central configuration variable
682 * Sources and destinations:: From here to there
683 * Selecting files:: What files are part of the project?
684 * Publishing action:: Setting the function doing the publishing
685 * Publishing options:: Tweaking HTML/@LaTeX{} export
686 * Publishing links:: Which links keep working after publishing?
687 * Sitemap:: Generating a list of all pages
688 * Generating an index:: An index that reaches across pages
692 * Simple example:: One-component publishing
693 * Complex example:: A multi-component publishing example
695 Working with source code
697 * Structure of code blocks:: Code block syntax described
698 * Editing source code:: Language major-mode editing
699 * Exporting code blocks:: Export contents and/or results
700 * Extracting source code:: Create pure source code files
701 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
702 * Library of Babel:: Use and contribute to a library of useful code blocks
703 * Languages:: List of supported code block languages
704 * Header arguments:: Configure code block functionality
705 * Results of evaluation:: How evaluation results are handled
706 * Noweb reference syntax:: Literate programming in Org mode
707 * Key bindings and useful functions:: Work quickly with code blocks
708 * Batch execution:: Call functions from the command line
712 * Using header arguments:: Different ways to set header arguments
713 * Specific header arguments:: List of header arguments
715 Using header arguments
717 * System-wide header arguments:: Set global default values
718 * Language-specific header arguments:: Set default values by language
719 * Header arguments in Org mode properties:: Set default values for a buffer or heading
720 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
721 * Code block specific header arguments:: The most common way to set values
722 * Header arguments in function calls:: The most specific level
724 Specific header arguments
726 * var:: Pass arguments to code blocks
727 * results:: Specify the type of results and how they will
728 be collected and handled
729 * file:: Specify a path for file output
730 * file-desc:: Specify a description for file results
731 * file-ext:: Specify an extension for file output
732 * output-dir:: Specify a directory to write file output to
733 * dir:: Specify the default (possibly remote)
734 directory for code block execution
735 * exports:: Export code and/or results
736 * tangle:: Toggle tangling and specify file name
737 * mkdirp:: Toggle creation of parent directories of target
738 files during tangling
739 * comments:: Toggle insertion of comments in tangled
741 * padline:: Control insertion of padding lines in tangled
743 * no-expand:: Turn off variable assignment and noweb
744 expansion during tangling
745 * session:: Preserve the state of code evaluation
746 * noweb:: Toggle expansion of noweb references
747 * noweb-ref:: Specify block's noweb reference resolution target
748 * noweb-sep:: String used to separate noweb references
749 * cache:: Avoid re-evaluating unchanged code blocks
750 * sep:: Delimiter for writing tabular results outside Org
751 * hlines:: Handle horizontal lines in tables
752 * colnames:: Handle column names in tables
753 * rownames:: Handle row names in tables
754 * shebang:: Make tangled files executable
755 * tangle-mode:: Set permission of tangled files
756 * eval:: Limit evaluation of specific code blocks
757 * wrap:: Mark source block evaluation results
758 * post:: Post processing of code block results
759 * prologue:: Text to prepend to code block body
760 * epilogue:: Text to append to code block body
764 * Completion:: M-TAB knows what you need
765 * Easy templates:: Quick insertion of structural elements
766 * Speed keys:: Electric commands at the beginning of a headline
767 * Code evaluation security:: Org mode files evaluate inline code
768 * Customization:: Adapting Org to your taste
769 * In-buffer settings:: Overview of the #+KEYWORDS
770 * The very busy C-c C-c key:: When in doubt, press C-c C-c
771 * Clean view:: Getting rid of leading stars in the outline
772 * TTY keys:: Using Org on a tty
773 * Interaction:: Other Emacs packages
774 * org-crypt:: Encrypting Org files
776 Interaction with other packages
778 * Cooperation:: Packages Org cooperates with
779 * Conflicts:: Packages that lead to conflicts
783 * Hooks:: How to reach into Org's internals
784 * Add-on packages:: Available extensions
785 * Adding hyperlink types:: New custom link types
786 * Adding export back-ends:: How to write new export back-ends
787 * Context-sensitive commands:: How to add functionality to such commands
788 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
789 * Dynamic blocks:: Automatically filled blocks
790 * Special agenda views:: Customized views
791 * Speeding up your agendas:: Tips on how to speed up your agendas
792 * Extracting agenda information:: Post-processing of agenda information
793 * Using the property API:: Writing programs that use entry properties
794 * Using the mapping API:: Mapping over all or selected entries
796 Tables and lists in arbitrary syntax
798 * Radio tables:: Sending and receiving radio tables
799 * A @LaTeX{} example:: Step by step, almost a tutorial
800 * Translator functions:: Copy and modify
801 * Radio lists:: Sending and receiving lists
805 * Setting up the staging area:: Where to interact with the mobile device
806 * Pushing to MobileOrg:: Uploading Org files and agendas
807 * Pulling from MobileOrg:: Integrating captured and flagged items
813 @chapter Introduction
817 * Summary:: Brief summary of what Org does
818 * Installation:: Installing Org
819 * Activation:: How to activate Org for certain buffers
820 * Feedback:: Bug reports, ideas, patches etc.
821 * Conventions:: Typesetting conventions in the manual
828 Org is a mode for keeping notes, maintaining TODO lists, and project planning
829 with a fast and effective plain-text system. It also is an authoring system
830 with unique support for literate programming and reproducible research.
832 Org is implemented on top of Outline mode, which makes it possible to keep
833 the content of large files well structured. Visibility cycling and structure
834 editing help to work with the tree. Tables are easily created with a
835 built-in table editor. Plain text URL-like links connect to websites,
836 emails, Usenet messages, BBDB entries, and any files related to the projects.
838 Org develops organizational tasks around notes files that contain lists or
839 information about projects as plain text. Project planning and task
840 management makes use of metadata which is part of an outline node. Based on
841 this data, specific entries can be extracted in queries and create dynamic
842 @i{agenda views} that also integrate the Emacs calendar and diary. Org can
843 be used to implement many different project planning schemes, such as David
846 Org files can serve as a single source authoring system with export to many
847 different formats such as HTML, @LaTeX{}, Open Document, and Markdown. New
848 export backends can be derived from existing ones, or defined from scratch.
850 Org files can include source code blocks, which makes Org uniquely suited for
851 authoring technical documents with code examples. Org source code blocks are
852 fully functional; they can be evaluated in place and their results can be
853 captured in the file. This makes it possible to create a single file
854 reproducible research compendium.
856 Org keeps simple things simple. When first fired up, it should feel like a
857 straightforward, easy to use outliner. Complexity is not imposed, but a
858 large amount of functionality is available when needed. Org is a toolbox.
859 Many users actually run only a (very personal) fraction of Org's capabilities, and
860 know that there is more whenever they need it.
862 All of this is achieved with strictly plain text files, the most portable and
863 future-proof file format. Org runs in Emacs. Emacs is one of the most
864 widely ported programs, so that Org mode is available on every major
868 There is a website for Org which provides links to the newest
869 version of Org, as well as additional information, frequently asked
870 questions (FAQ), links to tutorials, etc. This page is located at
871 @uref{http://orgmode.org}.
872 @cindex print edition
874 An earlier version (7.3) of this manual is available as a
875 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
881 @section Installation
884 Org is part of recent distributions of GNU Emacs, so you normally don't need
885 to install it. If, for one reason or another, you want to install Org on top
886 of this pre-packaged version, there are three ways to do it:
889 @item By using Emacs package system.
890 @item By downloading Org as an archive.
891 @item By using Org's git repository.
894 We @b{strongly recommend} to stick to a single installation method.
896 @subsubheading Using Emacs packaging system
898 Recent Emacs distributions include a packaging system which lets you install
899 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
901 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
902 been visited, i.e., where no Org built-in function have been loaded.
903 Otherwise autoload Org functions will mess up the installation.
905 Then, to make sure your Org configuration is taken into account, initialize
906 the package system with @code{(package-initialize)} in your @file{.emacs}
907 before setting any Org option. If you want to use Org's package repository,
908 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
910 @subsubheading Downloading Org as an archive
912 You can download Org latest release from @uref{http://orgmode.org/, Org's
913 website}. In this case, make sure you set the load-path correctly in your
917 (add-to-list 'load-path "~/path/to/orgdir/lisp")
920 The downloaded archive contains contributed libraries that are not included
921 in Emacs. If you want to use them, add the @file{contrib} directory to your
925 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
928 Optionally, you can compile the files and/or install them in your system.
929 Run @code{make help} to list compilation and installation options.
931 @subsubheading Using Org's git repository
933 You can clone Org's repository and install Org like this:
937 $ git clone git://orgmode.org/org-mode.git
941 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
942 version in @file{org-version.el} and Org's autoloads in
943 @file{org-loaddefs.el}.
945 Remember to add the correct load-path as described in the method above.
947 You can also compile with @code{make}, generate the documentation with
948 @code{make doc}, create a local configuration with @code{make config} and
949 install Org with @code{make install}. Please run @code{make help} to get
950 the list of compilation/installation options.
952 For more detailed explanations on Org's build system, please check the Org
953 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
961 @cindex global key bindings
962 @cindex key bindings, global
965 @findex org-store-link
968 Org mode buffers need font-lock to be turned on: this is the default in
969 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
970 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
972 There are compatibility issues between Org mode and some other Elisp
973 packages, please take the time to check the list (@pxref{Conflicts}).
975 The four Org commands @command{org-store-link}, @command{org-capture},
976 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
977 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
978 suggested bindings for these keys, please modify the keys to your own
981 (global-set-key "\C-cl" 'org-store-link)
982 (global-set-key "\C-ca" 'org-agenda)
983 (global-set-key "\C-cc" 'org-capture)
984 (global-set-key "\C-cb" 'org-iswitchb)
987 @cindex Org mode, turning on
988 Files with the @file{.org} extension use Org mode by default. To turn on Org
989 mode in a file that does not have the extension @file{.org}, make the first
990 line of a file look like this:
993 MY PROJECTS -*- mode: org; -*-
996 @vindex org-insert-mode-line-in-empty-file
997 @noindent which will select Org mode for this buffer no matter what
998 the file's name is. See also the variable
999 @code{org-insert-mode-line-in-empty-file}.
1001 Many commands in Org work on the region if the region is @i{active}. To make
1002 use of this, you need to have @code{transient-mark-mode} turned on, which is
1003 the default. If you do not like @code{transient-mark-mode}, you can create
1004 an active region by using the mouse to select a region, or pressing
1005 @kbd{C-@key{SPC}} twice before moving the cursor.
1014 If you find problems with Org, or if you have questions, remarks, or ideas
1015 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1016 You can subscribe to the list
1017 @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, on this web page}.
1018 If you are not a member of the mailing list, your mail will be passed to the
1019 list after a moderator has approved it@footnote{Please consider subscribing
1020 to the mailing list, in order to minimize the work the mailing list
1021 moderators have to do.}.
1023 For bug reports, please first try to reproduce the bug with the latest
1024 version of Org available---if you are running an outdated version, it is
1025 quite possible that the bug has been fixed already. If the bug persists,
1026 prepare a report and provide as much information as possible, including the
1027 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1028 (@kbd{M-x org-version RET}), as well as the Org related setup in
1029 @file{.emacs}. The easiest way to do this is to use the command
1031 @kbd{M-x org-submit-bug-report RET}
1033 @noindent which will put all this information into an Emacs mail buffer so
1034 that you only need to add your description. If you are not sending the Email
1035 from within Emacs, please copy and paste the content into your Email program.
1037 Sometimes you might face a problem due to an error in your Emacs or Org mode
1038 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1039 customizations and reproduce the problem. Doing so often helps you determine
1040 if the problem is with your customization or with Org mode itself. You can
1041 start a typical minimal session with a command like the example below.
1044 $ emacs -Q -l /path/to/minimal-org.el
1047 However if you are using Org mode as distributed with Emacs, a minimal setup
1048 is not necessary. In that case it is sufficient to start Emacs as
1049 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1053 ;;; Minimal setup to load latest 'org-mode'
1055 ;; activate debugging
1056 (setq debug-on-error t
1060 ;; add latest org-mode to load path
1061 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1062 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1065 If an error occurs, a backtrace can be very useful (see below on how to
1066 create one). Often a small example file helps, along with clear information
1070 @item What exactly did you do?
1071 @item What did you expect to happen?
1072 @item What happened instead?
1074 @noindent Thank you for helping to improve this program.
1076 @subsubheading How to create a useful backtrace
1078 @cindex backtrace of an error
1079 If working with Org produces an error with a message you don't
1080 understand, you may have hit a bug. The best way to report this is by
1081 providing, in addition to what was mentioned above, a @emph{backtrace}.
1082 This is information from the built-in debugger about where and how the
1083 error occurred. Here is how to produce a useful backtrace:
1087 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1088 contains much more information if it is produced with uncompiled code.
1091 @kbd{C-u M-x org-reload RET}
1094 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1097 Go to the @code{Options} menu and select @code{Enter Debugger on Error}.
1099 Do whatever you have to do to hit the error. Don't forget to
1100 document the steps you take.
1102 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1103 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1104 attach it to your bug report.
1108 @section Typesetting conventions used in this manual
1110 @subsubheading TODO keywords, tags, properties, etc.
1112 Org mainly uses three types of keywords: TODO keywords, tags and property
1113 names. In this manual we use the following conventions:
1118 TODO keywords are written with all capitals, even if they are
1122 User-defined tags are written in lowercase; built-in tags with special
1123 meaning are written with all capitals.
1126 User-defined properties are capitalized; built-in properties with
1127 special meaning are written with all capitals.
1130 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1131 and @i{environment keywords} (like @code{#+BEGIN_EXPORT html} to start
1132 a @code{HTML} environment). They are written in uppercase in the manual to
1133 enhance its readability, but you can use lowercase in your Org
1134 files@footnote{Easy templates insert lowercase keywords and Babel dynamically
1135 inserts @code{#+results}.}.
1137 @subsubheading Key bindings and commands
1143 The manual suggests a few global key bindings, in particular @kbd{C-c a} for
1144 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}. These are only
1145 suggestions, but the rest of the manual assumes that these key bindings are in
1146 place in order to list commands by key access.
1148 Also, the manual lists both the keys and the corresponding commands for
1149 accessing a functionality. Org mode often uses the same key for different
1150 functions, depending on context. The command that is bound to such keys has
1151 a generic name, like @code{org-metaright}. In the manual we will, wherever
1152 possible, give the function that is internally called by the generic command.
1153 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1154 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1155 will be listed to call @code{org-table-move-column-right}. If you prefer,
1156 you can compile the manual without the command names by unsetting the flag
1157 @code{cmdnames} in @file{org.texi}.
1159 @node Document structure
1160 @chapter Document structure
1161 @cindex document structure
1162 @cindex structure of document
1164 Org is based on Outline mode and provides flexible commands to
1165 edit the structure of the document.
1168 * Outlines:: Org is based on Outline mode
1169 * Headlines:: How to typeset Org tree headlines
1170 * Visibility cycling:: Show and hide, much simplified
1171 * Motion:: Jumping to other headlines
1172 * Structure editing:: Changing sequence and level of headlines
1173 * Sparse trees:: Matches embedded in context
1174 * Plain lists:: Additional structure within an entry
1175 * Drawers:: Tucking stuff away
1176 * Blocks:: Folding blocks
1177 * Footnotes:: How footnotes are defined in Org's syntax
1178 * Orgstruct mode:: Structure editing outside Org
1179 * Org syntax:: Formal description of Org's syntax
1185 @cindex Outline mode
1187 Org is implemented on top of Outline mode. Outlines allow a
1188 document to be organized in a hierarchical structure, which (at least
1189 for me) is the best representation of notes and thoughts. An overview
1190 of this structure is achieved by folding (hiding) large parts of the
1191 document to show only the general document structure and the parts
1192 currently being worked on. Org greatly simplifies the use of
1193 outlines by compressing the entire show/hide functionality into a single
1194 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1199 @cindex outline tree
1200 @vindex org-special-ctrl-a/e
1201 @vindex org-special-ctrl-k
1202 @vindex org-ctrl-k-protect-subtree
1204 Headlines define the structure of an outline tree. The headlines in Org
1205 start with one or more stars, on the left margin@footnote{See the variables
1206 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1207 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1208 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1209 headings indented less than 30 stars.}. For example:
1212 * Top level headline
1219 * Another top level headline
1222 @vindex org-footnote-section
1223 @noindent Note that a headline named after @code{org-footnote-section},
1224 which defaults to @samp{Footnotes}, is considered as special. A subtree with
1225 this headline will be silently ignored by exporting functions.
1227 Some people find the many stars too noisy and would prefer an
1228 outline that has whitespace followed by a single star as headline
1229 starters. @ref{Clean view}, describes a setup to realize this.
1231 @vindex org-cycle-separator-lines
1232 An empty line after the end of a subtree is considered part of it and
1233 will be hidden when the subtree is folded. However, if you leave at
1234 least two empty lines, one empty line will remain visible after folding
1235 the subtree, in order to structure the collapsed view. See the
1236 variable @code{org-cycle-separator-lines} to modify this behavior.
1238 @node Visibility cycling
1239 @section Visibility cycling
1240 @cindex cycling, visibility
1241 @cindex visibility cycling
1242 @cindex trees, visibility
1243 @cindex show hidden text
1247 * Global and local cycling:: Cycling through various visibility states
1248 * Initial visibility:: Setting the initial visibility state
1249 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1252 @node Global and local cycling
1253 @subsection Global and local cycling
1255 Outlines make it possible to hide parts of the text in the buffer.
1256 Org uses just two commands, bound to @key{TAB} and
1257 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1259 @cindex subtree visibility states
1260 @cindex subtree cycling
1261 @cindex folded, subtree visibility state
1262 @cindex children, subtree visibility state
1263 @cindex subtree, subtree visibility state
1265 @orgcmd{@key{TAB},org-cycle}
1266 @emph{Subtree cycling}: Rotate current subtree among the states
1269 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1270 '-----------------------------------'
1273 @vindex org-cycle-emulate-tab
1274 @vindex org-cycle-global-at-bob
1275 The cursor must be on a headline for this to work@footnote{see, however,
1276 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1277 beginning of the buffer and the first line is not a headline, then
1278 @key{TAB} actually runs global cycling (see below)@footnote{see the
1279 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1280 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1282 @cindex global visibility states
1283 @cindex global cycling
1284 @cindex overview, global visibility state
1285 @cindex contents, global visibility state
1286 @cindex show all, global visibility state
1287 @orgcmd{S-@key{TAB},org-global-cycle}
1288 @itemx C-u @key{TAB}
1289 @emph{Global cycling}: Rotate the entire buffer among the states
1292 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1293 '--------------------------------------'
1296 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1297 CONTENTS view up to headlines of level N will be shown. Note that inside
1298 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1300 @cindex set startup visibility, command
1301 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1302 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1303 @cindex show all, command
1304 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1305 Show all, including drawers.
1306 @cindex revealing context
1307 @orgcmd{C-c C-r,org-reveal}
1308 Reveal context around point, showing the current entry, the following heading
1309 and the hierarchy above. Useful for working near a location that has been
1310 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1311 (@pxref{Agenda commands}). With a prefix argument show, on each
1312 level, all sibling headings. With a double prefix argument, also show the
1313 entire subtree of the parent.
1314 @cindex show branches, command
1315 @orgcmd{C-c C-k,show-branches}
1316 Expose all the headings of the subtree, CONTENT view for just one subtree.
1317 @cindex show children, command
1318 @orgcmd{C-c @key{TAB},show-children}
1319 Expose all direct children of the subtree. With a numeric prefix argument N,
1320 expose all children down to level N@.
1321 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1322 Show the current subtree in an indirect buffer@footnote{The indirect buffer
1323 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
1324 buffer, but will be narrowed to the current tree. Editing the indirect
1325 buffer will also change the original buffer, but without affecting visibility
1326 in that buffer.}. With a numeric prefix argument N, go up to level N and
1327 then take that tree. If N is negative then go up that many levels. With a
1328 @kbd{C-u} prefix, do not remove the previously used indirect buffer.
1329 @orgcmd{C-c C-x v,org-copy-visible}
1330 Copy the @i{visible} text in the region into the kill ring.
1333 @node Initial visibility
1334 @subsection Initial visibility
1336 @cindex visibility, initialize
1337 @vindex org-startup-folded
1338 @vindex org-agenda-inhibit-startup
1339 @cindex @code{overview}, STARTUP keyword
1340 @cindex @code{content}, STARTUP keyword
1341 @cindex @code{showall}, STARTUP keyword
1342 @cindex @code{showeverything}, STARTUP keyword
1344 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1345 i.e., only the top level headlines are visible@footnote{When
1346 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1347 visibility state when first opening a file for the agenda (@pxref{Speeding up
1348 your agendas}).}. This can be configured through the variable
1349 @code{org-startup-folded}, or on a per-file basis by adding one of the
1350 following lines anywhere in the buffer:
1356 #+STARTUP: showeverything
1359 The startup visibility options are ignored when the file is open for the
1360 first time during the agenda generation: if you want the agenda to honor
1361 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1363 @cindex property, VISIBILITY
1365 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1366 and columns}) will get their visibility adapted accordingly. Allowed values
1367 for this property are @code{folded}, @code{children}, @code{content}, and
1371 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1372 Switch back to the startup visibility of the buffer, i.e., whatever is
1373 requested by startup options and @samp{VISIBILITY} properties in individual
1377 @node Catching invisible edits
1378 @subsection Catching invisible edits
1380 @vindex org-catch-invisible-edits
1381 @cindex edits, catching invisible
1382 Sometimes you may inadvertently edit an invisible part of the buffer and be
1383 confused on what has been edited and how to undo the mistake. Setting
1384 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
1385 docstring of this option on how Org should catch invisible edits and process
1390 @cindex motion, between headlines
1391 @cindex jumping, to headlines
1392 @cindex headline navigation
1393 The following commands jump to other headlines in the buffer.
1396 @orgcmd{C-c C-n,outline-next-visible-heading}
1398 @orgcmd{C-c C-p,outline-previous-visible-heading}
1400 @orgcmd{C-c C-f,org-forward-same-level}
1401 Next heading same level.
1402 @orgcmd{C-c C-b,org-backward-same-level}
1403 Previous heading same level.
1404 @orgcmd{C-c C-u,outline-up-heading}
1405 Backward to higher level heading.
1406 @orgcmd{C-c C-j,org-goto}
1407 Jump to a different place without changing the current outline
1408 visibility. Shows the document structure in a temporary buffer, where
1409 you can use the following keys to find your destination:
1410 @vindex org-goto-auto-isearch
1412 @key{TAB} @r{Cycle visibility.}
1413 @key{down} / @key{up} @r{Next/previous visible headline.}
1414 @key{RET} @r{Select this location.}
1415 @kbd{/} @r{Do a Sparse-tree search}
1416 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1417 n / p @r{Next/previous visible headline.}
1418 f / b @r{Next/previous headline same level.}
1420 0-9 @r{Digit argument.}
1423 @vindex org-goto-interface
1425 See also the option @code{org-goto-interface}.
1428 @node Structure editing
1429 @section Structure editing
1430 @cindex structure editing
1431 @cindex headline, promotion and demotion
1432 @cindex promotion, of subtrees
1433 @cindex demotion, of subtrees
1434 @cindex subtree, cut and paste
1435 @cindex pasting, of subtrees
1436 @cindex cutting, of subtrees
1437 @cindex copying, of subtrees
1438 @cindex sorting, of subtrees
1439 @cindex subtrees, cut and paste
1442 @orgcmd{M-@key{RET},org-insert-heading}
1443 @vindex org-M-RET-may-split-line
1444 Insert a new heading/item with the same level as the one at point.
1446 If the cursor is in a plain list item, a new item is created (@pxref{Plain
1447 lists}). To prevent this behavior in lists, call the command with one prefix
1448 argument. When this command is used in the middle of a line, the line is
1449 split and the rest of the line becomes the new item or headline. If you do
1450 not want the line to be split, customize @code{org-M-RET-may-split-line}.
1452 If the command is used at the @emph{beginning} of a line, and if there is a
1453 heading or an item at point, the new heading/item is created @emph{before}
1454 the current line. If the command is used at the @emph{end} of a folded
1455 subtree (i.e., behind the ellipses at the end of a headline), then a headline
1456 will be inserted after the end of the subtree.
1458 Calling this command with @kbd{C-u C-u} will unconditionally respect the
1459 headline's content and create a new item at the end of the parent subtree.
1461 If point is at the beginning of a normal line, turn this line into a heading.
1462 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1463 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1464 current heading, the new heading is placed after the body instead of before
1465 it. This command works from anywhere in the entry.
1466 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1467 @vindex org-treat-insert-todo-heading-as-state-change
1468 Insert new TODO entry with same level as current heading. See also the
1469 variable @code{org-treat-insert-todo-heading-as-state-change}.
1470 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1471 Insert new TODO entry with same level as current heading. Like
1472 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1474 @orgcmd{@key{TAB},org-cycle}
1475 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1476 become a child of the previous one. The next @key{TAB} makes it a parent,
1477 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1478 to the initial level.
1479 @orgcmd{M-@key{left},org-do-promote}
1480 Promote current heading by one level.
1481 @orgcmd{M-@key{right},org-do-demote}
1482 Demote current heading by one level.
1483 @orgcmd{M-S-@key{left},org-promote-subtree}
1484 Promote the current subtree by one level.
1485 @orgcmd{M-S-@key{right},org-demote-subtree}
1486 Demote the current subtree by one level.
1487 @orgcmd{M-S-@key{up},org-move-subtree-up}
1488 Move subtree up (swap with previous subtree of same
1490 @orgcmd{M-S-@key{down},org-move-subtree-down}
1491 Move subtree down (swap with next subtree of same level).
1492 @orgcmd{M-h,org-mark-element}
1493 Mark the element at point. Hitting repeatedly will mark subsequent elements
1494 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1495 hitting @key{M-h} immediately again will mark the next one.
1496 @orgcmd{C-c @@,org-mark-subtree}
1497 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1498 of the same level than the marked subtree.
1499 @orgcmd{C-c C-x C-w,org-cut-subtree}
1500 Kill subtree, i.e., remove it from buffer but save in kill ring.
1501 With a numeric prefix argument N, kill N sequential subtrees.
1502 @orgcmd{C-c C-x M-w,org-copy-subtree}
1503 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1504 sequential subtrees.
1505 @orgcmd{C-c C-x C-y,org-paste-subtree}
1506 Yank subtree from kill ring. This does modify the level of the subtree to
1507 make sure the tree fits in nicely at the yank position. The yank level can
1508 also be specified with a numeric prefix argument, or by yanking after a
1509 headline marker like @samp{****}.
1510 @orgcmd{C-y,org-yank}
1511 @vindex org-yank-adjusted-subtrees
1512 @vindex org-yank-folded-subtrees
1513 Depending on the options @code{org-yank-adjusted-subtrees} and
1514 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1515 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1516 C-x C-y}. With the default settings, no level adjustment will take place,
1517 but the yanked tree will be folded unless doing so would swallow text
1518 previously visible. Any prefix argument to this command will force a normal
1519 @code{yank} to be executed, with the prefix passed along. A good way to
1520 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1521 yank, it will yank previous kill items plainly, without adjustment and
1523 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1524 Clone a subtree by making a number of sibling copies of it. You will be
1525 prompted for the number of copies to make, and you can also specify if any
1526 timestamps in the entry should be shifted. This can be useful, for example,
1527 to create a number of tasks related to a series of lectures to prepare. For
1528 more details, see the docstring of the command
1529 @code{org-clone-subtree-with-time-shift}.
1530 @orgcmd{C-c C-w,org-refile}
1531 Refile entry or region to a different location. @xref{Refile and copy}.
1532 @orgcmd{C-c ^,org-sort}
1533 Sort same-level entries. When there is an active region, all entries in the
1534 region will be sorted. Otherwise the children of the current headline are
1535 sorted. The command prompts for the sorting method, which can be
1536 alphabetically, numerically, by time (first timestamp with active preferred,
1537 creation time, scheduled time, deadline time), by priority, by TODO keyword
1538 (in the sequence the keywords have been defined in the setup) or by the value
1539 of a property. Reverse sorting is possible as well. You can also supply
1540 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1541 sorting will be case-sensitive.
1542 @orgcmd{C-x n s,org-narrow-to-subtree}
1543 Narrow buffer to current subtree.
1544 @orgcmd{C-x n b,org-narrow-to-block}
1545 Narrow buffer to current block.
1546 @orgcmd{C-x n w,widen}
1547 Widen buffer to remove narrowing.
1548 @orgcmd{C-c *,org-toggle-heading}
1549 Turn a normal line or plain list item into a headline (so that it becomes a
1550 subheading at its location). Also turn a headline into a normal line by
1551 removing the stars. If there is an active region, turn all lines in the
1552 region into headlines. If the first line in the region was an item, turn
1553 only the item lines into headlines. Finally, if the first line is a
1554 headline, remove the stars from all headlines in the region.
1557 @cindex region, active
1558 @cindex active region
1559 @cindex transient mark mode
1560 When there is an active region (Transient Mark mode), promotion and
1561 demotion work on all headlines in the region. To select a region of
1562 headlines, it is best to place both point and mark at the beginning of a
1563 line, mark at the beginning of the first headline, and point at the line
1564 just after the last headline to change. Note that when the cursor is
1565 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1570 @section Sparse trees
1571 @cindex sparse trees
1572 @cindex trees, sparse
1573 @cindex folding, sparse trees
1574 @cindex occur, command
1576 @vindex org-show-context-detail
1577 An important feature of Org mode is the ability to construct @emph{sparse
1578 trees} for selected information in an outline tree, so that the entire
1579 document is folded as much as possible, but the selected information is made
1580 visible along with the headline structure above it@footnote{See also the
1581 variable @code{org-show-context-detail} to decide how much context is shown
1582 around each match.}. Just try it out and you will see immediately how it
1585 Org mode contains several commands for creating such trees, all these
1586 commands can be accessed through a dispatcher:
1589 @orgcmd{C-c /,org-sparse-tree}
1590 This prompts for an extra key to select a sparse-tree creating command.
1591 @orgcmd{C-c / r,org-occur}
1592 @vindex org-remove-highlights-with-change
1593 Prompts for a regexp and shows a sparse tree with all matches. If
1594 the match is in a headline, the headline is made visible. If the match is in
1595 the body of an entry, headline and body are made visible. In order to
1596 provide minimal context, also the full hierarchy of headlines above the match
1597 is shown, as well as the headline following the match. Each match is also
1598 highlighted; the highlights disappear when the buffer is changed by an
1599 editing command@footnote{This depends on the option
1600 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1601 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1602 so several calls to this command can be stacked.
1603 @orgcmdkkc{M-g n,M-g M-n,next-error}
1604 Jump to the next sparse tree match in this buffer.
1605 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1606 Jump to the previous sparse tree match in this buffer.
1610 @vindex org-agenda-custom-commands
1611 For frequently used sparse trees of specific search strings, you can
1612 use the option @code{org-agenda-custom-commands} to define fast
1613 keyboard access to specific sparse trees. These commands will then be
1614 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1618 (setq org-agenda-custom-commands
1619 '(("f" occur-tree "FIXME")))
1622 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1623 a sparse tree matching the string @samp{FIXME}.
1625 The other sparse tree commands select headings based on TODO keywords,
1626 tags, or properties and will be discussed later in this manual.
1629 @cindex printing sparse trees
1630 @cindex visible text, printing
1631 To print a sparse tree, you can use the Emacs command
1632 @code{ps-print-buffer-with-faces} which does not print invisible parts of the
1633 document. Or you can use @kbd{C-c C-e C-v} to export only the visible part
1634 of the document and print the resulting file.
1637 @section Plain lists
1639 @cindex lists, plain
1640 @cindex lists, ordered
1641 @cindex ordered lists
1643 Within an entry of the outline tree, hand-formatted lists can provide
1644 additional structure. They also provide a way to create lists of checkboxes
1645 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1646 (@pxref{Exporting}) can parse and format them.
1648 Org knows ordered lists, unordered lists, and description lists.
1651 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1652 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1653 they will be seen as top-level headlines. Also, when you are hiding leading
1654 stars to get a clean outline view, plain list items starting with a star may
1655 be hard to distinguish from true headlines. In short: even though @samp{*}
1656 is supported, it may be better to not use it for plain list items.} as
1659 @vindex org-plain-list-ordered-item-terminator
1660 @vindex org-list-allow-alphabetical
1661 @emph{Ordered} list items start with a numeral followed by either a period or
1662 a right parenthesis@footnote{You can filter out any of them by configuring
1663 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1664 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1665 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1666 confusion with normal text, those are limited to one character only. Beyond
1667 that limit, bullets will automatically fallback to numbers.}. If you want a
1668 list to start with a different value (e.g., 20), start the text of the item
1669 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1670 must be put @emph{before} the checkbox. If you have activated alphabetical
1671 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1672 be used in any item of the list in order to enforce a particular numbering.
1674 @emph{Description} list items are unordered list items, and contain the
1675 separator @samp{ :: } to distinguish the description @emph{term} from the
1679 Items belonging to the same list must have the same indentation on the first
1680 line. In particular, if an ordered list reaches number @samp{10.}, then the
1681 2--digit numbers must be written left-aligned with the other numbers in the
1682 list. An item ends before the next line that is less or equally indented
1683 than its bullet/number.
1685 @vindex org-list-empty-line-terminates-plain-lists
1686 A list ends whenever every item has ended, which means before any line less
1687 or equally indented than items at top level. It also ends before two blank
1688 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1689 In that case, all items are closed. Here is an example:
1693 ** Lord of the Rings
1694 My favorite scenes are (in this order)
1695 1. The attack of the Rohirrim
1696 2. Eowyn's fight with the witch king
1697 + this was already my favorite scene in the book
1698 + I really like Miranda Otto.
1699 3. Peter Jackson being shot by Legolas
1701 He makes a really funny face when it happens.
1702 But in the end, no individual scenes matter but the film as a whole.
1703 Important actors in this film are:
1704 - @b{Elijah Wood} :: He plays Frodo
1705 - @b{Sean Astin} :: He plays Sam, Frodo's friend. I still remember
1706 him very well from his role as Mikey Walsh in @i{The Goonies}.
1710 Org supports these lists by tuning filling and wrapping commands to deal with
1711 them correctly, and by exporting them properly (@pxref{Exporting}). Since
1712 indentation is what governs the structure of these lists, many structural
1713 constructs like @code{#+BEGIN_...} blocks can be indented to signal that they
1714 belong to a particular item.
1716 @vindex org-list-demote-modify-bullet
1717 @vindex org-list-indent-offset
1718 If you find that using a different bullet for a sub-list (than that used for
1719 the current list-level) improves readability, customize the variable
1720 @code{org-list-demote-modify-bullet}. To get a greater difference of
1721 indentation between items and their sub-items, customize
1722 @code{org-list-indent-offset}.
1724 @vindex org-list-automatic-rules
1725 The following commands act on items when the cursor is in the first line of
1726 an item (the line with the bullet or number). Some of them imply the
1727 application of automatic rules to keep list structure intact. If some of
1728 these actions get in your way, configure @code{org-list-automatic-rules}
1729 to disable them individually.
1732 @orgcmd{@key{TAB},org-cycle}
1733 @cindex cycling, in plain lists
1734 @vindex org-cycle-include-plain-lists
1735 Items can be folded just like headline levels. Normally this works only if
1736 the cursor is on a plain list item. For more details, see the variable
1737 @code{org-cycle-include-plain-lists}. If this variable is set to
1738 @code{integrate}, plain list items will be treated like low-level
1739 headlines. The level of an item is then given by the indentation of the
1740 bullet/number. Items are always subordinate to real headlines, however; the
1741 hierarchies remain completely separated. In a new item with no text yet, the
1742 first @key{TAB} demotes the item to become a child of the previous
1743 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1744 and eventually get it back to its initial position.
1745 @orgcmd{M-@key{RET},org-insert-heading}
1746 @vindex org-M-RET-may-split-line
1747 @vindex org-list-automatic-rules
1748 Insert new item at current level. With a prefix argument, force a new
1749 heading (@pxref{Structure editing}). If this command is used in the middle
1750 of an item, that item is @emph{split} in two, and the second part becomes the
1751 new item@footnote{If you do not want the item to be split, customize the
1752 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1753 @emph{before item's body}, the new item is created @emph{before} the current
1758 @kindex M-S-@key{RET}
1760 Insert a new item with a checkbox (@pxref{Checkboxes}).
1761 @kindex S-@key{down}
1764 @cindex shift-selection-mode
1765 @vindex org-support-shift-select
1766 @vindex org-list-use-circular-motion
1767 Jump to the previous/next item in the current list@footnote{If you want to
1768 cycle around items that way, you may customize
1769 @code{org-list-use-circular-motion}.}, but only if
1770 @code{org-support-shift-select} is off. If not, you can still use paragraph
1771 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1774 @kindex M-@key{down}
1777 Move the item including subitems up/down@footnote{See
1778 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1779 previous/next item of same indentation). If the list is ordered, renumbering
1781 @kindex M-@key{left}
1782 @kindex M-@key{right}
1785 Decrease/increase the indentation of an item, leaving children alone.
1786 @kindex M-S-@key{left}
1787 @kindex M-S-@key{right}
1788 @item M-S-@key{left}
1789 @itemx M-S-@key{right}
1790 Decrease/increase the indentation of the item, including subitems.
1791 Initially, the item tree is selected based on current indentation. When
1792 these commands are executed several times in direct succession, the initially
1793 selected region is used, even if the new indentation would imply a different
1794 hierarchy. To use the new hierarchy, break the command chain with a cursor
1797 As a special case, using this command on the very first item of a list will
1798 move the whole list. This behavior can be disabled by configuring
1799 @code{org-list-automatic-rules}. The global indentation of a list has no
1800 influence on the text @emph{after} the list.
1803 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1804 state of the checkbox. In any case, verify bullets and indentation
1805 consistency in the whole list.
1807 @vindex org-plain-list-ordered-item-terminator
1809 Cycle the entire list level through the different itemize/enumerate bullets
1810 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1811 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1812 and its indentation. With a numeric prefix argument N, select the Nth bullet
1813 from this list. If there is an active region when calling this, selected
1814 text will be changed into an item. With a prefix argument, all lines will be
1815 converted to list items. If the first line already was a list item, any item
1816 marker will be removed from the list. Finally, even without an active
1817 region, a normal line will be converted into a list item.
1820 Turn a plain list item into a headline (so that it becomes a subheading at
1821 its location). @xref{Structure editing}, for a detailed explanation.
1824 Turn the whole plain list into a subtree of the current heading. Checkboxes
1825 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1827 @kindex S-@key{left}
1828 @kindex S-@key{right}
1830 @vindex org-support-shift-select
1831 This command also cycles bullet styles when the cursor in on the bullet or
1832 anywhere in an item line, details depending on
1833 @code{org-support-shift-select}.
1835 @cindex sorting, of plain list
1837 Sort the plain list. You will be prompted for the sorting method:
1838 numerically, alphabetically, by time, by checked status for check lists,
1839 or by a custom function.
1845 @cindex visibility cycling, drawers
1847 @cindex org-insert-drawer
1849 Sometimes you want to keep information associated with an entry, but you
1850 normally don't want to see it. For this, Org mode has @emph{drawers}. They
1851 can contain anything but a headline and another drawer. Drawers look like
1855 ** This is a headline
1856 Still outside the drawer
1858 This is inside the drawer.
1863 You can interactively insert drawers at point by calling
1864 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1865 region, this command will put the region inside the drawer. With a prefix
1866 argument, this command calls @code{org-insert-property-drawer} and add a
1867 property drawer right below the current headline. Completion over drawer
1868 keywords is also possible using @key{M-TAB}.
1870 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1871 show the entry, but keep the drawer collapsed to a single line. In order to
1872 look inside the drawer, you need to move the cursor to the drawer line and
1873 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1874 storing properties (@pxref{Properties and columns}), and you can also arrange
1875 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1876 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1877 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1883 Add a time-stamped note to the LOGBOOK drawer.
1886 @vindex org-export-with-drawers
1887 @vindex org-export-with-properties
1888 You can select the name of the drawers which should be exported with
1889 @code{org-export-with-drawers}. In that case, drawer contents will appear in
1890 export output. Property drawers are not affected by this variable: configure
1891 @code{org-export-with-properties} instead.
1896 @vindex org-hide-block-startup
1897 @cindex blocks, folding
1898 Org mode uses begin...end blocks for various purposes from including source
1899 code examples (@pxref{Literal examples}) to capturing time logging
1900 information (@pxref{Clocking work time}). These blocks can be folded and
1901 unfolded by pressing TAB in the begin line. You can also get all blocks
1902 folded at startup by configuring the option @code{org-hide-block-startup}
1903 or on a per-file basis by using
1905 @cindex @code{hideblocks}, STARTUP keyword
1906 @cindex @code{nohideblocks}, STARTUP keyword
1908 #+STARTUP: hideblocks
1909 #+STARTUP: nohideblocks
1916 Org mode supports the creation of footnotes.
1918 A footnote is started by a footnote marker in square brackets in column 0, no
1919 indentation allowed. It ends at the next footnote definition, headline, or
1920 after two consecutive empty lines. The footnote reference is simply the
1921 marker in square brackets, inside text. Markers always start with
1922 @code{fn:}. For example:
1925 The Org homepage[fn:1] now looks a lot better than it used to.
1927 [fn:1] The link is: http://orgmode.org
1930 Org mode extends the number-based syntax to @emph{named} footnotes and
1931 optional inline definition. Here are the valid references:
1935 A named footnote reference, where @code{name} is a unique label word, or, for
1936 simplicity of automatic creation, a number.
1937 @item [fn::This is the inline definition of this footnote]
1938 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1940 @item [fn:name:a definition]
1941 An inline definition of a footnote, which also specifies a name for the note.
1942 Since Org allows multiple references to the same note, you can then use
1943 @code{[fn:name]} to create additional references.
1946 @vindex org-footnote-auto-label
1947 Footnote labels can be created automatically, or you can create names yourself.
1948 This is handled by the variable @code{org-footnote-auto-label} and its
1949 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1952 @noindent The following command handles footnotes:
1957 The footnote action command.
1959 When the cursor is on a footnote reference, jump to the definition. When it
1960 is at a definition, jump to the (first) reference.
1962 @vindex org-footnote-define-inline
1963 @vindex org-footnote-section
1964 @vindex org-footnote-auto-adjust
1965 Otherwise, create a new footnote. Depending on the option
1966 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1967 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1968 definition will be placed right into the text as part of the reference, or
1969 separately into the location determined by the option
1970 @code{org-footnote-section}.
1972 When this command is called with a prefix argument, a menu of additional
1975 s @r{Sort the footnote definitions by reference sequence. During editing,}
1976 @r{Org makes no effort to sort footnote definitions into a particular}
1977 @r{sequence. If you want them sorted, use this command, which will}
1978 @r{also move entries according to @code{org-footnote-section}. Automatic}
1979 @r{sorting after each insertion/deletion can be configured using the}
1980 @r{option @code{org-footnote-auto-adjust}.}
1981 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1982 @r{after each insertion/deletion can be configured using the option}
1983 @r{@code{org-footnote-auto-adjust}.}
1984 S @r{Short for first @code{r}, then @code{s} action.}
1985 n @r{Normalize the footnotes by collecting all definitions (including}
1986 @r{inline definitions) into a special section, and then numbering them}
1987 @r{in sequence. The references will then also be numbers.}
1988 d @r{Delete the footnote at point, and all definitions of and references}
1991 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1992 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1993 renumbering and sorting footnotes can be automatic after each insertion or
1998 If the cursor is on a footnote reference, jump to the definition. If it is a
1999 the definition, jump back to the reference. When called at a footnote
2000 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2004 @item C-c C-o @r{or} mouse-1/2
2005 Footnote labels are also links to the corresponding definition/reference, and
2006 you can use the usual commands to follow these links.
2008 @vindex org-edit-footnote-reference
2012 Edit the footnote definition corresponding to the reference at point in
2013 a seperate window. The window can be closed by pressing @kbd{C-c '}.
2017 @node Orgstruct mode
2018 @section The Orgstruct minor mode
2019 @cindex Orgstruct mode
2020 @cindex minor mode for structure editing
2022 If you like the intuitive way the Org mode structure editing and list
2023 formatting works, you might want to use these commands in other modes like
2024 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2025 this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2026 turn it on by default, for example in Message mode, with one of:
2029 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2030 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2033 When this mode is active and the cursor is on a line that looks to Org like a
2034 headline or the first line of a list item, most structure editing commands
2035 will work, even if the same keys normally have different functionality in the
2036 major mode you are using. If the cursor is not in one of those special
2037 lines, Orgstruct mode lurks silently in the shadows.
2039 When you use @code{orgstruct++-mode}, Org will also export indentation and
2040 autofill settings into that mode, and detect item context after the first
2043 @vindex orgstruct-heading-prefix-regexp
2044 You can also use Org structure editing to fold and unfold headlines in
2045 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2046 the regular expression must match the local prefix to use before Org's
2047 headlines. For example, if you set this variable to @code{";; "} in Emacs
2048 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2049 commented lines. Some commands like @code{org-demote} are disabled when the
2050 prefix is set, but folding/unfolding will work correctly.
2056 A reference document providing a formal description of Org's syntax is
2057 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2058 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2059 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2060 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2061 file falls into one of the categories above.
2063 To explore the abstract structure of an Org buffer, run this in a buffer:
2066 M-: (org-element-parse-buffer) RET
2069 It will output a list containing the buffer's content represented as an
2070 abstract structure. The export engine relies on the information stored in
2071 this list. Most interactive commands (e.g., for structure editing) also
2072 rely on the syntactic meaning of the surrounding context.
2074 @cindex syntax checker
2076 You can check syntax in your documents using @code{org-lint} command.
2081 @cindex editing tables
2083 Org comes with a fast and intuitive table editor. Spreadsheet-like
2084 calculations are supported using the Emacs @file{calc} package
2085 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2088 * Built-in table editor:: Simple tables
2089 * Column width and alignment:: Overrule the automatic settings
2090 * Column groups:: Grouping to trigger vertical lines
2091 * Orgtbl mode:: The table editor as minor mode
2092 * The spreadsheet:: The table editor has spreadsheet capabilities
2093 * Org-Plot:: Plotting from org tables
2096 @node Built-in table editor
2097 @section The built-in table editor
2098 @cindex table editor, built-in
2100 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2101 the first non-whitespace character is considered part of a table. @samp{|}
2102 is also the column separator@footnote{To insert a vertical bar into a table
2103 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2104 might look like this:
2107 | Name | Phone | Age |
2108 |-------+-------+-----|
2109 | Peter | 1234 | 17 |
2110 | Anna | 4321 | 25 |
2113 A table is re-aligned automatically each time you press @key{TAB} or
2114 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2115 the next field (@key{RET} to the next row) and creates new table rows
2116 at the end of the table or before horizontal lines. The indentation
2117 of the table is set by the first line. Any line starting with
2118 @samp{|-} is considered as a horizontal separator line and will be
2119 expanded on the next re-align to span the whole table width. So, to
2120 create the above table, you would only type
2127 @noindent and then press @key{TAB} to align the table and start filling in
2128 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2129 @kbd{C-c @key{RET}}.
2131 @vindex org-enable-table-editor
2132 @vindex org-table-auto-blank-field
2133 When typing text into a field, Org treats @key{DEL},
2134 @key{Backspace}, and all character keys in a special way, so that
2135 inserting and deleting avoids shifting other fields. Also, when
2136 typing @emph{immediately after the cursor was moved into a new field
2137 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2138 field is automatically made blank. If this behavior is too
2139 unpredictable for you, configure the options
2140 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2143 @tsubheading{Creation and conversion}
2144 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2145 Convert the active region to a table. If every line contains at least one
2146 TAB character, the function assumes that the material is tab separated.
2147 If every line contains a comma, comma-separated values (CSV) are assumed.
2148 If not, lines are split at whitespace into fields. You can use a prefix
2149 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2150 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2151 match the separator, and a numeric argument N indicates that at least N
2152 consecutive spaces, or alternatively a TAB will be the separator.
2154 If there is no active region, this command creates an empty Org
2155 table. But it is easier just to start typing, like
2156 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2158 @tsubheading{Re-aligning and field motion}
2159 @orgcmd{C-c C-c,org-table-align}
2160 Re-align the table and don't move to another field.
2162 @orgcmd{C-c SPC,org-table-blank-field}
2163 Blank the field at point.
2165 @orgcmd{<TAB>,org-table-next-field}
2166 Re-align the table, move to the next field. Creates a new row if
2169 @orgcmd{S-@key{TAB},org-table-previous-field}
2170 Re-align, move to previous field.
2172 @orgcmd{@key{RET},org-table-next-row}
2173 Re-align the table and move down to next row. Creates a new row if
2174 necessary. At the beginning or end of a line, @key{RET} still does
2175 NEWLINE, so it can be used to split a table.
2177 @orgcmd{M-a,org-table-beginning-of-field}
2178 Move to beginning of the current table field, or on to the previous field.
2179 @orgcmd{M-e,org-table-end-of-field}
2180 Move to end of the current table field, or on to the next field.
2182 @tsubheading{Column and row editing}
2183 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2184 Move the current column left/right.
2186 @orgcmd{M-S-@key{left},org-table-delete-column}
2187 Kill the current column.
2189 @orgcmd{M-S-@key{right},org-table-insert-column}
2190 Insert a new column to the left of the cursor position.
2192 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2193 Move the current row up/down.
2195 @orgcmd{M-S-@key{up},org-table-kill-row}
2196 Kill the current row or horizontal line.
2198 @orgcmd{M-S-@key{down},org-table-insert-row}
2199 Insert a new row above the current row. With a prefix argument, the line is
2200 created below the current one.
2202 @orgcmd{C-c -,org-table-insert-hline}
2203 Insert a horizontal line below current row. With a prefix argument, the line
2204 is created above the current line.
2206 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2207 Insert a horizontal line below current row, and move the cursor into the row
2210 @orgcmd{C-c ^,org-table-sort-lines}
2211 Sort the table lines in the region. The position of point indicates the
2212 column to be used for sorting, and the range of lines is the range
2213 between the nearest horizontal separator lines, or the entire table. If
2214 point is before the first column, you will be prompted for the sorting
2215 column. If there is an active region, the mark specifies the first line
2216 and the sorting column, while point should be in the last line to be
2217 included into the sorting. The command prompts for the sorting type
2218 (alphabetically, numerically, or by time). You can sort in normal or
2219 reverse order. You can also supply your own key extraction and comparison
2220 functions. When called with a prefix argument, alphabetic sorting will be
2223 @tsubheading{Regions}
2224 @orgcmd{C-c C-x M-w,org-table-copy-region}
2225 Copy a rectangular region from a table to a special clipboard. Point and
2226 mark determine edge fields of the rectangle. If there is no active region,
2227 copy just the current field. The process ignores horizontal separator lines.
2229 @orgcmd{C-c C-x C-w,org-table-cut-region}
2230 Copy a rectangular region from a table to a special clipboard, and
2231 blank all fields in the rectangle. So this is the ``cut'' operation.
2233 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2234 Paste a rectangular region into a table.
2235 The upper left corner ends up in the current field. All involved fields
2236 will be overwritten. If the rectangle does not fit into the present table,
2237 the table is enlarged as needed. The process ignores horizontal separator
2240 @orgcmd{M-@key{RET},org-table-wrap-region}
2241 Split the current field at the cursor position and move the rest to the line
2242 below. If there is an active region, and both point and mark are in the same
2243 column, the text in the column is wrapped to minimum width for the given
2244 number of lines. A numeric prefix argument may be used to change the number
2245 of desired lines. If there is no region, but you specify a prefix argument,
2246 the current field is made blank, and the content is appended to the field
2249 @tsubheading{Calculations}
2250 @cindex formula, in tables
2251 @cindex calculations, in tables
2252 @cindex region, active
2253 @cindex active region
2254 @cindex transient mark mode
2255 @orgcmd{C-c +,org-table-sum}
2256 Sum the numbers in the current column, or in the rectangle defined by
2257 the active region. The result is shown in the echo area and can
2258 be inserted with @kbd{C-y}.
2260 @orgcmd{S-@key{RET},org-table-copy-down}
2261 @vindex org-table-copy-increment
2262 When current field is empty, copy from first non-empty field above. When not
2263 empty, copy current field down to next row and move cursor along with it.
2264 Depending on the option @code{org-table-copy-increment}, integer field
2265 values will be incremented during copy. Integers that are too large will not
2266 be incremented. Also, a @code{0} prefix argument temporarily disables the
2267 increment. This key is also used by shift-selection and related modes
2268 (@pxref{Conflicts}).
2270 @tsubheading{Miscellaneous}
2271 @orgcmd{C-c `,org-table-edit-field}
2272 Edit the current field in a separate window. This is useful for fields that
2273 are not fully visible (@pxref{Column width and alignment}). When called with
2274 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2275 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2276 window follow the cursor through the table and always show the current
2277 field. The follow mode exits automatically when the cursor leaves the table,
2278 or when you repeat this command with @kbd{C-u C-u C-c `}.
2280 @item M-x org-table-import RET
2281 Import a file as a table. The table should be TAB or whitespace
2282 separated. Use, for example, to import a spreadsheet table or data
2283 from a database, because these programs generally can write
2284 TAB-separated text files. This command works by inserting the file into
2285 the buffer and then converting the region to a table. Any prefix
2286 argument is passed on to the converter, which uses it to determine the
2288 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2289 Tables can also be imported by pasting tabular text into the Org
2290 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2291 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2293 @item M-x org-table-export RET
2294 @findex org-table-export
2295 @vindex org-table-export-default-format
2296 Export the table, by default as a TAB-separated file. Use for data
2297 exchange with, for example, spreadsheet or database programs. The format
2298 used to export the file can be configured in the option
2299 @code{org-table-export-default-format}. You may also use properties
2300 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2301 name and the format for table export in a subtree. Org supports quite
2302 general formats for exported tables. The exporter format is the same as the
2303 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2304 detailed description.
2307 If you don't like the automatic table editor because it gets in your
2308 way on lines which you would like to start with @samp{|}, you can turn
2312 (setq org-enable-table-editor nil)
2315 @noindent Then the only table command that still works is
2316 @kbd{C-c C-c} to do a manual re-align.
2318 @node Column width and alignment
2319 @section Column width and alignment
2320 @cindex narrow columns in tables
2321 @cindex alignment in tables
2323 The width of columns is automatically determined by the table editor. And
2324 also the alignment of a column is determined automatically from the fraction
2325 of number-like versus non-number fields in the column.
2327 Sometimes a single field or a few fields need to carry more text, leading to
2328 inconveniently wide columns. Or maybe you want to make a table with several
2329 columns having a fixed width, regardless of content. To set the width of
2330 a column, one field anywhere in the column may contain just the string
2331 @samp{<N>} where @samp{N} is an integer specifying the width of the column in
2332 characters. The next re-align will then set the width of this column to this
2337 |---+------------------------------| |---+--------|
2339 | 1 | one | | 1 | one |
2340 | 2 | two | ----\ | 2 | two |
2341 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2342 | 4 | four | | 4 | four |
2343 |---+------------------------------| |---+--------|
2348 Fields that are wider become clipped and end in the string @samp{=>}.
2349 Note that the full text is still in the buffer but is hidden.
2350 To see the full text, hold the mouse over the field---a tool-tip window
2351 will show the full content. To edit such a field, use the command
2352 @kbd{C-c `} (that is @kbd{C-c} followed by the grave accent). This will
2353 open a new window with the full field. Edit it and finish with @kbd{C-c
2356 @vindex org-startup-align-all-tables
2357 When visiting a file containing a table with narrowed columns, the
2358 necessary character hiding has not yet happened, and the table needs to
2359 be aligned before it looks nice. Setting the option
2360 @code{org-startup-align-all-tables} will realign all tables in a file
2361 upon visiting, but also slow down startup. You can also set this option
2362 on a per-file basis with:
2369 If you would like to overrule the automatic alignment of number-rich columns
2370 to the right and of string-rich column to the left, you can use @samp{<r>},
2371 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2372 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2373 also combine alignment and field width like this: @samp{<r10>}.
2375 Lines which only contain these formatting cookies will be removed
2376 automatically when exporting the document.
2379 @section Column groups
2380 @cindex grouping columns in tables
2382 When Org exports tables, it does so by default without vertical
2383 lines because that is visually more satisfying in general. Occasionally
2384 however, vertical lines can be useful to structure a table into groups
2385 of columns, much like horizontal lines can do for groups of rows. In
2386 order to specify column groups, you can use a special row where the
2387 first field contains only @samp{/}. The further fields can either
2388 contain @samp{<} to indicate that this column should start a group,
2389 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2390 and @samp{>}) to make a column
2391 a group of its own. Boundaries between column groups will upon export be
2392 marked with vertical lines. Here is an example:
2395 | N | N^2 | N^3 | N^4 | ~sqrt(n)~ | ~sqrt[4](N)~ |
2396 |---+-----+-----+-----+-----------+--------------|
2397 | / | < | | > | < | > |
2398 | 1 | 1 | 1 | 1 | 1 | 1 |
2399 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2400 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2401 |---+-----+-----+-----+-----------+--------------|
2402 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2405 It is also sufficient to just insert the column group starters after
2406 every vertical line you would like to have:
2409 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2410 |----+-----+-----+-----+---------+------------|
2415 @section The Orgtbl minor mode
2417 @cindex minor mode for tables
2419 If you like the intuitive way the Org table editor works, you
2420 might also want to use it in other modes like Text mode or Mail mode.
2421 The minor mode Orgtbl mode makes this possible. You can always toggle
2422 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2423 example in Message mode, use
2426 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2429 Furthermore, with some special setup, it is possible to maintain tables
2430 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2431 construct @LaTeX{} tables with the underlying ease and power of
2432 Orgtbl mode, including spreadsheet capabilities. For details, see
2433 @ref{Tables in arbitrary syntax}.
2435 @node The spreadsheet
2436 @section The spreadsheet
2437 @cindex calculations, in tables
2438 @cindex spreadsheet capabilities
2439 @cindex @file{calc} package
2441 The table editor makes use of the Emacs @file{calc} package to implement
2442 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2443 derive fields from other fields. While fully featured, Org's implementation
2444 is not identical to other spreadsheets. For example, Org knows the concept
2445 of a @emph{column formula} that will be applied to all non-header fields in a
2446 column without having to copy the formula to each relevant field. There is
2447 also a formula debugger, and a formula editor with features for highlighting
2448 fields in the table corresponding to the references at the point in the
2449 formula, moving these references by arrow keys
2452 * References:: How to refer to another field or range
2453 * Formula syntax for Calc:: Using Calc to compute stuff
2454 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2455 * Durations and time values:: How to compute durations and time values
2456 * Field and range formulas:: Formula for specific (ranges of) fields
2457 * Column formulas:: Formulas valid for an entire column
2458 * Lookup functions:: Lookup functions for searching tables
2459 * Editing and debugging formulas:: Fixing formulas
2460 * Updating the table:: Recomputing all dependent fields
2461 * Advanced features:: Field and column names, parameters and automatic recalc
2465 @subsection References
2468 To compute fields in the table from other fields, formulas must
2469 reference other fields or ranges. In Org, fields can be referenced
2470 by name, by absolute coordinates, and by relative coordinates. To find
2471 out what the coordinates of a field are, press @kbd{C-c ?} in that
2472 field, or press @kbd{C-c @}} to toggle the display of a grid.
2474 @subsubheading Field references
2475 @cindex field references
2476 @cindex references, to fields
2478 Formulas can reference the value of another field in two ways. Like in
2479 any other spreadsheet, you may reference fields with a letter/number
2480 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2481 @vindex org-table-use-standard-references
2482 However, Org prefers@footnote{Org will understand references typed by the
2483 user as @samp{B4}, but it will not use this syntax when offering a formula
2484 for editing. You can customize this behavior using the option
2485 @code{org-table-use-standard-references}.} to use another, more general
2486 representation that looks like this:
2488 @@@var{row}$@var{column}
2491 Column specifications can be absolute like @code{$1},
2492 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2493 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2494 @code{$<} and @code{$>} are immutable references to the first and last
2495 column, respectively, and you can use @code{$>>>} to indicate the third
2496 column from the right.
2498 The row specification only counts data lines and ignores horizontal separator
2499 lines (hlines). Like with columns, you can use absolute row numbers
2500 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2501 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2502 immutable references the first and last@footnote{For backward compatibility
2503 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2504 a stable way to the 5th and 12th field in the last row of the table.
2505 However, this syntax is deprecated, it should not be used for new documents.
2506 Use @code{@@>$} instead.} row in the table, respectively. You may also
2507 specify the row relative to one of the hlines: @code{@@I} refers to the first
2508 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2509 line above the current line, @code{@@+I} to the first such line below the
2510 current line. You can also write @code{@@III+2} which is the second data line
2511 after the third hline in the table.
2513 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2514 i.e., to the row/column for the field being computed. Also, if you omit
2515 either the column or the row part of the reference, the current row/column is
2518 Org's references with @emph{unsigned} numbers are fixed references
2519 in the sense that if you use the same reference in the formula for two
2520 different fields, the same field will be referenced each time.
2521 Org's references with @emph{signed} numbers are floating
2522 references because the same reference operator can reference different
2523 fields depending on the field being calculated by the formula.
2525 Here are a few examples:
2528 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2529 $5 @r{column 5 in the current row (same as @code{E&})}
2530 @@2 @r{current column, row 2}
2531 @@-1$-3 @r{the field one row up, three columns to the left}
2532 @@-I$2 @r{field just under hline above current row, column 2}
2533 @@>$5 @r{field in the last row, in column 5}
2536 @subsubheading Range references
2537 @cindex range references
2538 @cindex references, to ranges
2540 You may reference a rectangular range of fields by specifying two field
2541 references connected by two dots @samp{..}. If both fields are in the
2542 current row, you may simply use @samp{$2..$7}, but if at least one field
2543 is in a different row, you need to use the general @code{@@row$column}
2544 format at least for the first field (i.e the reference must start with
2545 @samp{@@} in order to be interpreted correctly). Examples:
2548 $1..$3 @r{first three fields in the current row}
2549 $P..$Q @r{range, using column names (see under Advanced)}
2550 $<<<..$>> @r{start in third column, continue to the last but one}
2551 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2552 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2553 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2556 @noindent Range references return a vector of values that can be fed
2557 into Calc vector functions. Empty fields in ranges are normally suppressed,
2558 so that the vector contains only the non-empty fields. For other options
2559 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2562 @subsubheading Field coordinates in formulas
2563 @cindex field coordinates
2564 @cindex coordinates, of field
2565 @cindex row, of field coordinates
2566 @cindex column, of field coordinates
2568 One of the very first actions during evaluation of Calc formulas and Lisp
2569 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2570 row or column number of the field where the current result will go to. The
2571 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2572 @code{org-table-current-column}. Examples:
2575 @item if(@@# % 2, $#, string(""))
2576 Insert column number on odd rows, set field to empty on even rows.
2577 @item $2 = '(identity remote(FOO, @@@@#$1))
2578 Copy text or values of each row of column 1 of the table named @code{FOO}
2579 into column 2 of the current table.
2580 @item @@3 = 2 * remote(FOO, @@1$$#)
2581 Insert the doubled value of each column of row 1 of the table named
2582 @code{FOO} into row 3 of the current table.
2585 @noindent For the second/third example, the table named @code{FOO} must have
2586 at least as many rows/columns as the current table. Note that this is
2587 inefficient@footnote{The computation time scales as O(N^2) because the table
2588 named @code{FOO} is parsed for each field to be read.} for large number of
2591 @subsubheading Named references
2592 @cindex named references
2593 @cindex references, named
2594 @cindex name, of column or field
2595 @cindex constants, in calculations
2598 @vindex org-table-formula-constants
2599 @samp{$name} is interpreted as the name of a column, parameter or
2600 constant. Constants are defined globally through the option
2601 @code{org-table-formula-constants}, and locally (for the file) through a
2605 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2609 @vindex constants-unit-system
2610 @pindex constants.el
2611 Also properties (@pxref{Properties and columns}) can be used as
2612 constants in table formulas: for a property @samp{:Xyz:} use the name
2613 @samp{$PROP_Xyz}, and the property will be searched in the current
2614 outline entry and in the hierarchy above it. If you have the
2615 @file{constants.el} package, it will also be used to resolve constants,
2616 including natural constants like @samp{$h} for Planck's constant, and
2617 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2618 supply the values of constants in two different unit systems, @code{SI}
2619 and @code{cgs}. Which one is used depends on the value of the variable
2620 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2621 @code{constSI} and @code{constcgs} to set this value for the current
2622 buffer.}. Column names and parameters can be specified in special table
2623 lines. These are described below, see @ref{Advanced features}. All
2624 names must start with a letter, and further consist of letters and
2627 @subsubheading Remote references
2628 @cindex remote references
2629 @cindex references, remote
2630 @cindex references, to a different table
2631 @cindex name, of column or field
2632 @cindex constants, in calculations
2633 @cindex #+NAME, for table
2635 You may also reference constants, fields and ranges from a different table,
2636 either in the current file or even in a different file. The syntax is
2639 remote(NAME-OR-ID,REF)
2643 where NAME can be the name of a table in the current file as set by a
2644 @code{#+NAME: Name} line before the table. It can also be the ID of an
2645 entry, even in a different file, and the reference then refers to the first
2646 table in that entry. REF is an absolute field or range reference as
2647 described above for example @code{@@3$3} or @code{$somename}, valid in the
2650 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2651 it will be substituted with the name or ID found in this field of the current
2652 table. For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2653 @@>$1)}. The format @code{B3} is not supported because it can not be
2654 distinguished from a plain table name or ID.
2656 @node Formula syntax for Calc
2657 @subsection Formula syntax for Calc
2658 @cindex formula syntax, Calc
2659 @cindex syntax, of formulas
2661 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2662 package. Note that @file{calc} has the non-standard convention that @samp{/}
2663 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2664 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2665 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2666 GNU Emacs Calc Manual}), variable substitution takes place according to the
2667 rules described above.
2668 @cindex vectors, in table calculations
2669 The range vectors can be directly fed into the Calc vector functions
2670 like @samp{vmean} and @samp{vsum}.
2672 @cindex format specifier
2673 @cindex mode, for @file{calc}
2674 @vindex org-calc-default-modes
2675 A formula can contain an optional mode string after a semicolon. This
2676 string consists of flags to influence Calc and other modes during
2677 execution. By default, Org uses the standard Calc modes (precision
2678 12, angular units degrees, fraction and symbolic modes off). The display
2679 format, however, has been changed to @code{(float 8)} to keep tables
2680 compact. The default settings can be configured using the option
2681 @code{org-calc-default-modes}.
2683 @noindent List of modes:
2687 Set the internal Calc calculation precision to 20 digits.
2688 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2689 Normal, scientific, engineering or fixed format of the result of Calc passed
2690 back to Org. Calc formatting is unlimited in precision as long as the Calc
2691 calculation precision is greater.
2692 @item @code{D}, @code{R}
2693 Degree and radian angle modes of Calc.
2694 @item @code{F}, @code{S}
2695 Fraction and symbolic modes of Calc.
2696 @item @code{T}, @code{t}
2697 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2699 If and how to consider empty fields. Without @samp{E} empty fields in range
2700 references are suppressed so that the Calc vector or Lisp list contains only
2701 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2702 fields in ranges or empty field references the value @samp{nan} (not a
2703 number) is used in Calc formulas and the empty string is used for Lisp
2704 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2705 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2707 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2708 to see how this is essential for computations with Lisp formulas. In Calc
2709 formulas it is used only occasionally because there number strings are
2710 already interpreted as numbers without @samp{N}.
2712 Literal, for Lisp formulas only. See the next section.
2716 Unless you use large integer numbers or high-precision-calculation and
2717 -display for floating point numbers you may alternatively provide a
2718 @samp{printf} format specifier to reformat the Calc result after it has been
2719 passed back to Org instead of letting Calc already do the
2720 formatting@footnote{The @samp{printf} reformatting is limited in precision
2721 because the value passed to it is converted into an @samp{integer} or
2722 @samp{double}. The @samp{integer} is limited in size by truncating the
2723 signed value to 32 bits. The @samp{double} is limited in precision to 64
2724 bits overall which leaves approximately 16 significant decimal digits.}. A
2728 $1+$2 @r{Sum of first and second field}
2729 $1+$2;%.2f @r{Same, format result to two decimals}
2730 exp($2)+exp($1) @r{Math functions can be used}
2731 $0;%.1f @r{Reformat current cell to 1 decimal}
2732 ($3-32)*5/9 @r{Degrees F -> C conversion}
2733 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2734 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2735 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2736 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2739 Calc also contains a complete set of logical operations, (@pxref{Logical
2740 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2743 @item if($1 < 20, teen, string(""))
2744 "teen" if age $1 is less than 20, else the Org table result field is set to
2745 empty with the empty string.
2746 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2747 Sum of the first two columns. When at least one of the input fields is empty
2748 the Org table result field is set to empty. @samp{E} is required to not
2749 convert empty fields to 0. @samp{f-1} is an optional Calc format string
2750 similar to @samp{%.1f} but leaves empty results empty.
2751 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2752 Mean value of a range unless there is any empty field. Every field in the
2753 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2754 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2755 @samp{vmean} and the Org table result field is set to empty. Use this when
2756 the sample set is expected to never have missing values.
2757 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2758 Mean value of a range with empty fields skipped. Every field in the range
2759 that is empty is skipped. When all fields in the range are empty the mean
2760 value is not defined and the Org table result field is set to empty. Use
2761 this when the sample set can have a variable size.
2762 @item vmean($1..$7); EN
2763 To complete the example before: Mean value of a range with empty fields
2764 counting as samples with value 0. Use this only when incomplete sample sets
2765 should be padded with 0 to the full size.
2768 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2769 and use them in formula syntax for Calc.
2771 @node Formula syntax for Lisp
2772 @subsection Emacs Lisp forms as formulas
2773 @cindex Lisp forms, as table formulas
2775 It is also possible to write a formula in Emacs Lisp. This can be useful
2776 for string manipulation and control structures, if Calc's functionality is
2779 If a formula starts with an apostrophe followed by an opening parenthesis,
2780 then it is evaluated as a Lisp form. The evaluation should return either a
2781 string or a number. Just as with @file{calc} formulas, you can specify modes
2782 and a printf format after a semicolon.
2784 With Emacs Lisp forms, you need to be conscious about the way field
2785 references are interpolated into the form. By default, a reference will be
2786 interpolated as a Lisp string (in double-quotes) containing the field. If
2787 you provide the @samp{N} mode switch, all referenced elements will be numbers
2788 (non-number fields will be zero) and interpolated as Lisp numbers, without
2789 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2790 literally, without quotes. I.e., if you want a reference to be interpreted
2791 as a string by the Lisp form, enclose the reference operator itself in
2792 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2793 fields, so you can embed them in list or vector syntax.
2795 Here are a few examples---note how the @samp{N} mode is used when we do
2796 computations in Lisp:
2799 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2800 Swap the first two characters of the content of column 1.
2802 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2803 @item '(apply '+ '($1..$4));N
2804 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2807 @node Durations and time values
2808 @subsection Durations and time values
2809 @cindex Duration, computing
2810 @cindex Time, computing
2811 @vindex org-table-duration-custom-format
2813 If you want to compute time values use the @code{T} flag, either in Calc
2814 formulas or Elisp formulas:
2818 | Task 1 | Task 2 | Total |
2819 |---------+----------+----------|
2820 | 2:12 | 1:47 | 03:59:00 |
2821 | 3:02:20 | -2:07:00 | 0.92 |
2822 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2826 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2827 are optional. With the @code{T} flag, computed durations will be displayed
2828 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2829 computed durations will be displayed according to the value of the option
2830 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2831 will display the result as a fraction of hours (see the second formula in the
2834 Negative duration values can be manipulated as well, and integers will be
2835 considered as seconds in addition and subtraction.
2837 @node Field and range formulas
2838 @subsection Field and range formulas
2839 @cindex field formula
2840 @cindex range formula
2841 @cindex formula, for individual table field
2842 @cindex formula, for range of fields
2844 To assign a formula to a particular field, type it directly into the field,
2845 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2846 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2847 the formula will be stored as the formula for this field, evaluated, and the
2848 current field will be replaced with the result.
2851 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2852 below the table. If you type the equation in the 4th field of the 3rd data
2853 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2854 inserting/deleting/swapping columns and rows with the appropriate commands,
2855 @i{absolute references} (but not relative ones) in stored formulas are
2856 modified in order to still reference the same field. To avoid this, in
2857 particular in range references, anchor ranges at the table borders (using
2858 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2859 @code{@@I} notation. Automatic adaptation of field references does of course
2860 not happen if you edit the table structure with normal editing
2861 commands---then you must fix the equations yourself.
2863 Instead of typing an equation into the field, you may also use the following
2867 @orgcmd{C-u C-c =,org-table-eval-formula}
2868 Install a new formula for the current field. The command prompts for a
2869 formula with default taken from the @samp{#+TBLFM:} line, applies
2870 it to the current field, and stores it.
2873 The left-hand side of a formula can also be a special expression in order to
2874 assign the formula to a number of different fields. There is no keyboard
2875 shortcut to enter such range formulas. To add them, use the formula editor
2876 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2881 Column formula, valid for the entire column. This is so common that Org
2882 treats these formulas in a special way, see @ref{Column formulas}.
2884 Row formula, applies to all fields in the specified row. @code{@@>=} means
2887 Range formula, applies to all fields in the given rectangular range. This
2888 can also be used to assign a formula to some but not all fields in a row.
2890 Named field, see @ref{Advanced features}.
2893 @node Column formulas
2894 @subsection Column formulas
2895 @cindex column formula
2896 @cindex formula, for table column
2898 When you assign a formula to a simple column reference like @code{$3=}, the
2899 same formula will be used in all fields of that column, with the following
2900 very convenient exceptions: (i) If the table contains horizontal separator
2901 hlines with rows above and below, everything before the first such hline is
2902 considered part of the table @emph{header} and will not be modified by column
2903 formulas. Therefore a header is mandatory when you use column formulas and
2904 want to add hlines to group rows, like for example to separate a total row at
2905 the bottom from the summand rows above. (ii) Fields that already get a value
2906 from a field/range formula will be left alone by column formulas. These
2907 conditions make column formulas very easy to use.
2909 To assign a formula to a column, type it directly into any field in the
2910 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2911 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2912 the formula will be stored as the formula for the current column, evaluated
2913 and the current field replaced with the result. If the field contains only
2914 @samp{=}, the previously stored formula for this column is used. For each
2915 column, Org will only remember the most recently used formula. In the
2916 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2917 left-hand side of a column formula cannot be the name of column, it must be
2918 the numeric column reference or @code{$>}.
2920 Instead of typing an equation into the field, you may also use the
2924 @orgcmd{C-c =,org-table-eval-formula}
2925 Install a new formula for the current column and replace current field with
2926 the result of the formula. The command prompts for a formula, with default
2927 taken from the @samp{#+TBLFM} line, applies it to the current field and
2928 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2929 will apply it to that many consecutive fields in the current column.
2932 @node Lookup functions
2933 @subsection Lookup functions
2934 @cindex lookup functions in tables
2935 @cindex table lookup functions
2937 Org has three predefined Emacs Lisp functions for lookups in tables.
2939 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2940 @findex org-lookup-first
2941 Searches for the first element @code{S} in list @code{S-LIST} for which
2945 is @code{t}; returns the value from the corresponding position in list
2946 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2947 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2948 order as the corresponding parameters are in the call to
2949 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2950 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2952 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2953 @findex org-lookup-last
2954 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2955 element for which @code{PREDICATE} is @code{t}.
2956 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2957 @findex org-lookup-all
2958 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2959 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2960 values. This function can not be used by itself in a formula, because it
2961 returns a list of values. However, powerful lookups can be built when this
2962 function is combined with other Emacs Lisp functions.
2965 If the ranges used in these functions contain empty fields, the @code{E} mode
2966 for the formula should usually be specified: otherwise empty fields will not be
2967 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2968 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2969 element of @code{R-LIST}.
2971 These three functions can be used to implement associative arrays, count
2972 matching cells, rank results, group data etc. For practical examples
2973 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2976 @node Editing and debugging formulas
2977 @subsection Editing and debugging formulas
2978 @cindex formula editing
2979 @cindex editing, of table formulas
2981 @vindex org-table-use-standard-references
2982 You can edit individual formulas in the minibuffer or directly in the field.
2983 Org can also prepare a special buffer with all active formulas of a table.
2984 When offering a formula for editing, Org converts references to the standard
2985 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2986 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2987 option @code{org-table-use-standard-references}.
2990 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2991 Edit the formula associated with the current column/field in the
2992 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2993 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2994 Re-insert the active formula (either a
2995 field formula, or a column formula) into the current field, so that you
2996 can edit it directly in the field. The advantage over editing in the
2997 minibuffer is that you can use the command @kbd{C-c ?}.
2998 @orgcmd{C-c ?,org-table-field-info}
2999 While editing a formula in a table field, highlight the field(s)
3000 referenced by the reference at the cursor position in the formula.
3002 @findex org-table-toggle-coordinate-overlays
3004 Toggle the display of row and column numbers for a table, using overlays
3005 (@command{org-table-toggle-coordinate-overlays}). These are updated each
3006 time the table is aligned; you can force it with @kbd{C-c C-c}.
3008 @findex org-table-toggle-formula-debugger
3010 Toggle the formula debugger on and off
3011 (@command{org-table-toggle-formula-debugger}). See below.
3012 @orgcmd{C-c ',org-table-edit-formulas}
3013 Edit all formulas for the current table in a special buffer, where the
3014 formulas will be displayed one per line. If the current field has an
3015 active formula, the cursor in the formula editor will mark it.
3016 While inside the special buffer, Org will automatically highlight
3017 any field or range reference at the cursor position. You may edit,
3018 remove and add formulas, and use the following commands:
3021 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3022 Exit the formula editor and store the modified formulas. With @kbd{C-u}
3023 prefix, also apply the new formulas to the entire table.
3024 @orgcmd{C-c C-q,org-table-fedit-abort}
3025 Exit the formula editor without installing changes.
3026 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3027 Toggle all references in the formula editor between standard (like
3028 @code{B3}) and internal (like @code{@@3$2}).
3029 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3030 Pretty-print or indent Lisp formula at point. When in a line containing
3031 a Lisp formula, format the formula according to Emacs Lisp rules.
3032 Another @key{TAB} collapses the formula back again. In the open
3033 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3034 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3035 Complete Lisp symbols, just like in Emacs Lisp mode.
3037 @kindex S-@key{down}
3038 @kindex S-@key{left}
3039 @kindex S-@key{right}
3040 @findex org-table-fedit-ref-up
3041 @findex org-table-fedit-ref-down
3042 @findex org-table-fedit-ref-left
3043 @findex org-table-fedit-ref-right
3044 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3045 Shift the reference at point. For example, if the reference is
3046 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3047 This also works for relative references and for hline references.
3048 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3049 Move the test line for column formulas in the Org buffer up and
3051 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3052 Scroll the window displaying the table.
3054 @findex org-table-toggle-coordinate-overlays
3056 Turn the coordinate grid in the table on and off.
3060 Making a table field blank does not remove the formula associated with
3061 the field, because that is stored in a different line (the @samp{#+TBLFM}
3062 line)---during the next recalculation the field will be filled again.
3063 To remove a formula from a field, you have to give an empty reply when
3064 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3067 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3068 equations with @kbd{C-c C-c} in that line or with the normal
3069 recalculation commands in the table.
3071 @anchor{Using multiple #+TBLFM lines}
3072 @subsubheading Using multiple #+TBLFM lines
3073 @cindex #+TBLFM line, multiple
3075 @cindex #+TBLFM, switching
3078 You may apply the formula temporarily. This is useful when you
3079 switch the formula. Place multiple @samp{#+TBLFM} lines right
3080 after the table, and then press @kbd{C-c C-c} on the formula to
3081 apply. Here is an example:
3093 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3105 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3106 will get the following result of applying only the first @samp{#+TBLFM} line.
3117 @subsubheading Debugging formulas
3118 @cindex formula debugging
3119 @cindex debugging, of table formulas
3120 When the evaluation of a formula leads to an error, the field content
3121 becomes the string @samp{#ERROR}. If you would like see what is going
3122 on during variable substitution and calculation in order to find a bug,
3123 turn on formula debugging in the @code{Tbl} menu and repeat the
3124 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3125 field. Detailed information will be displayed.
3127 @node Updating the table
3128 @subsection Updating the table
3129 @cindex recomputing table fields
3130 @cindex updating, table
3132 Recalculation of a table is normally not automatic, but needs to be
3133 triggered by a command. See @ref{Advanced features}, for a way to make
3134 recalculation at least semi-automatic.
3136 In order to recalculate a line of a table or the entire table, use the
3140 @orgcmd{C-c *,org-table-recalculate}
3141 Recalculate the current row by first applying the stored column formulas
3142 from left to right, and all field/range formulas in the current row.
3148 Recompute the entire table, line by line. Any lines before the first
3149 hline are left alone, assuming that these are part of the table header.
3151 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3152 Iterate the table by recomputing it until no further changes occur.
3153 This may be necessary if some computed fields use the value of other
3154 fields that are computed @i{later} in the calculation sequence.
3155 @item M-x org-table-recalculate-buffer-tables RET
3156 @findex org-table-recalculate-buffer-tables
3157 Recompute all tables in the current buffer.
3158 @item M-x org-table-iterate-buffer-tables RET
3159 @findex org-table-iterate-buffer-tables
3160 Iterate all tables in the current buffer, in order to converge table-to-table
3164 @node Advanced features
3165 @subsection Advanced features
3167 If you want the recalculation of fields to happen automatically, or if you
3168 want to be able to assign @i{names}@footnote{Such names must start by an
3169 alphabetic character and use only alphanumeric/underscore characters.} to
3170 fields and columns, you need to reserve the first column of the table for
3171 special marking characters.
3174 @orgcmd{C-#,org-table-rotate-recalc-marks}
3175 Rotate the calculation mark in first column through the states @samp{ },
3176 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3177 change all marks in the region.
3180 Here is an example of a table that collects exam results of students and
3181 makes use of these features:
3185 |---+---------+--------+--------+--------+-------+------|
3186 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3187 |---+---------+--------+--------+--------+-------+------|
3188 | ! | | P1 | P2 | P3 | Tot | |
3189 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3190 | ^ | | m1 | m2 | m3 | mt | |
3191 |---+---------+--------+--------+--------+-------+------|
3192 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3193 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3194 |---+---------+--------+--------+--------+-------+------|
3195 | | Average | | | | 25.0 | |
3196 | ^ | | | | | at | |
3197 | $ | max=50 | | | | | |
3198 |---+---------+--------+--------+--------+-------+------|
3199 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3203 @noindent @b{Important}: please note that for these special tables,
3204 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3205 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3206 to the field itself. The column formulas are not applied in rows with
3209 @cindex marking characters, tables
3210 The marking characters have the following meaning:
3214 The fields in this line define names for the columns, so that you may
3215 refer to a column as @samp{$Tot} instead of @samp{$6}.
3217 This row defines names for the fields @emph{above} the row. With such
3218 a definition, any formula in the table may use @samp{$m1} to refer to
3219 the value @samp{10}. Also, if you assign a formula to a names field, it
3220 will be stored as @samp{$name=...}.
3222 Similar to @samp{^}, but defines names for the fields in the row
3225 Fields in this row can define @emph{parameters} for formulas. For
3226 example, if a field in a @samp{$} row contains @samp{max=50}, then
3227 formulas in this table can refer to the value 50 using @samp{$max}.
3228 Parameters work exactly like constants, only that they can be defined on
3231 Fields in this row are automatically recalculated when pressing
3232 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3233 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3234 lines will be left alone by this command.
3236 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3237 not for automatic recalculation. Use this when automatic
3238 recalculation slows down editing too much.
3240 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3241 All lines that should be recalculated should be marked with @samp{#}
3244 Do not export this line. Useful for lines that contain the narrowing
3245 @samp{<N>} markers or column group markers.
3248 Finally, just to whet your appetite for what can be done with the
3249 fantastic @file{calc.el} package, here is a table that computes the Taylor
3250 series of degree @code{n} at location @code{x} for a couple of
3255 |---+-------------+---+-----+--------------------------------------|
3256 | | Func | n | x | Result |
3257 |---+-------------+---+-----+--------------------------------------|
3258 | # | exp(x) | 1 | x | 1 + x |
3259 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3260 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3261 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3262 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3263 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3264 |---+-------------+---+-----+--------------------------------------|
3265 #+TBLFM: $5=taylor($2,$4,$3);n3
3271 @cindex graph, in tables
3272 @cindex plot tables using Gnuplot
3275 Org-Plot can produce graphs of information stored in org tables, either
3276 graphically or in ASCII-art.
3278 @subheading Graphical plots using @file{Gnuplot}
3280 Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
3281 @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3282 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3283 that you have both Gnuplot and Gnuplot mode installed on your system, then
3284 call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
3289 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3290 | Sede | Max cites | H-index |
3291 |-----------+-----------+---------|
3292 | Chile | 257.72 | 21.39 |
3293 | Leeds | 165.77 | 19.68 |
3294 | Sao Paolo | 71.00 | 11.50 |
3295 | Stockholm | 134.19 | 14.33 |
3296 | Morelia | 257.56 | 17.67 |
3300 Notice that Org Plot is smart enough to apply the table's headers as labels.
3301 Further control over the labels, type, content, and appearance of plots can
3302 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3303 for a complete list of Org-plot options. The @code{#+PLOT:} lines are
3304 optional. For more information and examples see the Org-plot tutorial at
3305 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3307 @subsubheading Plot Options
3311 Specify any @command{gnuplot} option to be set when graphing.
3314 Specify the title of the plot.
3317 Specify which column of the table to use as the @code{x} axis.
3320 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3321 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3322 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3326 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3329 Specify a @code{with} option to be inserted for every col being plotted
3330 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3331 Defaults to @code{lines}.
3334 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3337 List of labels to be used for the @code{deps} (defaults to the column headers
3341 Specify an entire line to be inserted in the Gnuplot script.
3344 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3345 flat mapping rather than a @code{3d} slope.
3348 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3349 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3352 If you want total control, you can specify a script file (place the file name
3353 between double-quotes) which will be used to plot. Before plotting, every
3354 instance of @code{$datafile} in the specified script will be replaced with
3355 the path to the generated data file. Note: even if you set this option, you
3356 may still want to specify the plot type, as that can impact the content of
3360 @subheading ASCII bar plots
3362 While the cursor is on a column, typing @kbd{C-c " a} or
3363 @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
3364 ASCII-art bars plot. The plot is implemented through a regular column
3365 formula. When the source column changes, the bar plot may be updated by
3366 refreshing the table, for example typing @kbd{C-u C-c *}.
3370 | Sede | Max cites | |
3371 |---------------+-----------+--------------|
3372 | Chile | 257.72 | WWWWWWWWWWWW |
3373 | Leeds | 165.77 | WWWWWWWh |
3374 | Sao Paolo | 71.00 | WWW; |
3375 | Stockholm | 134.19 | WWWWWW: |
3376 | Morelia | 257.56 | WWWWWWWWWWWH |
3377 | Rochefourchat | 0.00 | |
3378 #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3382 The formula is an elisp call:
3384 (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
3389 is a reference to the source column.
3392 are the minimal and maximal values displayed. Sources values
3393 outside this range are displayed as @samp{too small}
3394 or @samp{too large}.
3397 is the width in characters of the bar-plot. It defaults to @samp{12}.
3405 Like HTML, Org provides links inside a file, external links to
3406 other files, Usenet articles, emails, and much more.
3409 * Link format:: How links in Org are formatted
3410 * Internal links:: Links to other places in the current file
3411 * External links:: URL-like links to the world
3412 * Handling links:: Creating, inserting and following
3413 * Using links outside Org:: Linking from my C source code?
3414 * Link abbreviations:: Shortcuts for writing complex links
3415 * Search options:: Linking to a specific location
3416 * Custom searches:: When the default search is not enough
3420 @section Link format
3422 @cindex format, of links
3424 Org will recognize plain URL-like links and activate them as
3425 clickable links. The general link format, however, looks like this:
3428 [[link][description]] @r{or alternatively} [[link]]
3432 Once a link in the buffer is complete (all brackets present), Org
3433 will change the display so that @samp{description} is displayed instead
3434 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3435 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3436 which by default is an underlined face. You can directly edit the
3437 visible part of a link. Note that this can be either the @samp{link}
3438 part (if there is no description) or the @samp{description} part. To
3439 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3442 If you place the cursor at the beginning or just behind the end of the
3443 displayed text and press @key{BACKSPACE}, you will remove the
3444 (invisible) bracket at that location. This makes the link incomplete
3445 and the internals are again displayed as plain text. Inserting the
3446 missing bracket hides the link internals again. To show the
3447 internal structure of all links, use the menu entry
3448 @code{Org->Hyperlinks->Literal links}.
3450 @node Internal links
3451 @section Internal links
3452 @cindex internal links
3453 @cindex links, internal
3454 @cindex targets, for links
3456 @cindex property, CUSTOM_ID
3457 If the link does not look like a URL, it is considered to be internal in the
3458 current file. The most important case is a link like
3459 @samp{[[#my-custom-id]]} which will link to the entry with the
3460 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3461 to make sure these custom IDs are unique in a file.
3463 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3464 lead to a text search in the current file.
3466 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3467 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3468 point to the corresponding headline. The preferred match for a text link is
3469 a @i{dedicated target}: the same string in double angular brackets, like
3470 @samp{<<My Target>>}.
3473 If no dedicated target exists, the link will then try to match the exact name
3474 of an element within the buffer. Naming is done with the @code{#+NAME}
3475 keyword, which has to be put in the line before the element it refers to, as
3476 in the following example
3485 If none of the above succeeds, Org will search for a headline that is exactly
3486 the link text but may also include a TODO keyword and tags@footnote{To insert
3487 a link targeting a headline, in-buffer completion can be used. Just type
3488 a star followed by a few optional letters into the buffer and press
3489 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3492 During export, internal links will be used to mark objects and assign them
3493 a number. Marked objects will then be referenced by links pointing to them.
3494 In particular, links without a description will appear as the number assigned
3495 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3496 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3497 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3501 - <<target>>another item
3502 Here we refer to item [[target]].
3506 The last sentence will appear as @samp{Here we refer to item 2} when
3509 In non-Org files, the search will look for the words in the link text. In
3510 the above example the search would be for @samp{my target}.
3512 Following a link pushes a mark onto Org's own mark ring. You can
3513 return to the previous position with @kbd{C-c &}. Using this command
3514 several times in direct succession goes back to positions recorded
3518 * Radio targets:: Make targets trigger links in plain text
3522 @subsection Radio targets
3523 @cindex radio targets
3524 @cindex targets, radio
3525 @cindex links, radio targets
3527 Org can automatically turn any occurrences of certain target names
3528 in normal text into a link. So without explicitly creating a link, the
3529 text connects to the target radioing its position. Radio targets are
3530 enclosed by triple angular brackets. For example, a target @samp{<<<My
3531 Target>>>} causes each occurrence of @samp{my target} in normal text to
3532 become activated as a link. The Org file is scanned automatically
3533 for radio targets only when the file is first loaded into Emacs. To
3534 update the target list during editing, press @kbd{C-c C-c} with the
3535 cursor on or at a target.
3537 @node External links
3538 @section External links
3539 @cindex links, external
3540 @cindex external links
3548 @cindex USENET links
3553 Org supports links to files, websites, Usenet and email messages, BBDB
3554 database entries and links to both IRC conversations and their logs.
3555 External links are URL-like locators. They start with a short identifying
3556 string followed by a colon. There can be no space after the colon. The
3557 following list shows examples for each link type.
3560 http://www.astro.uva.nl/~dominik @r{on the web}
3561 doi:10.1000/182 @r{DOI for an electronic resource}
3562 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3563 /home/dominik/images/jupiter.jpg @r{same as above}
3564 file:papers/last.pdf @r{file, relative path}
3565 ./papers/last.pdf @r{same as above}
3566 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3567 /myself@@some.where:papers/last.pdf @r{same as above}
3568 file:sometextfile::NNN @r{file, jump to line number}
3569 file:projects.org @r{another Org file}
3570 file:projects.org::some words @r{text search in Org file}@footnote{
3571 The actual behavior of the search will depend on the value of
3572 the option @code{org-link-search-must-match-exact-headline}. If its value
3573 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3574 exact headline will be matched, ignoring spaces and cookies. If the value is
3575 @code{query-to-create}, then an exact headline will be searched; if it is not
3576 found, then the user will be queried to create it.}
3577 file:projects.org::*task title @r{heading search in Org
3578 file}@footnote{ Headline searches always match the exact headline, ignoring
3579 spaces and cookies. If the headline is not found and the value of the option
3580 @code{org-link-search-must-match-exact-headline} is @code{query-to-create},
3581 then the user will be queried to create it.}
3582 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3583 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3584 news:comp.emacs @r{Usenet link}
3585 mailto:adent@@galaxy.net @r{Mail link}
3586 mhe:folder @r{MH-E folder link}
3587 mhe:folder#id @r{MH-E message link}
3588 rmail:folder @r{RMAIL folder link}
3589 rmail:folder#id @r{RMAIL message link}
3590 gnus:group @r{Gnus group link}
3591 gnus:group#id @r{Gnus article link}
3592 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3593 irc:/irc.com/#emacs/bob @r{IRC link}
3594 info:org#External links @r{Info node or index link}
3595 shell:ls *.org @r{A shell command}
3596 elisp:org-agenda @r{Interactive Elisp command}
3597 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3601 @cindex WANDERLUST links
3602 On top of these built-in link types, some are available through the
3603 @code{contrib/} directory (@pxref{Installation}). For example, these links
3604 to VM or Wanderlust messages are available when you load the corresponding
3605 libraries from the @code{contrib/} directory:
3608 vm:folder @r{VM folder link}
3609 vm:folder#id @r{VM message link}
3610 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3611 vm-imap:account:folder @r{VM IMAP folder link}
3612 vm-imap:account:folder#id @r{VM IMAP message link}
3613 wl:folder @r{WANDERLUST folder link}
3614 wl:folder#id @r{WANDERLUST message link}
3617 For customizing Org to add new link types @ref{Adding hyperlink types}.
3619 A link should be enclosed in double brackets and may contain a descriptive
3620 text to be displayed instead of the URL (@pxref{Link format}), for example:
3623 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3627 If the description is a file name or URL that points to an image, HTML
3628 export (@pxref{HTML export}) will inline the image as a clickable
3629 button. If there is no description at all and the link points to an
3631 that image will be inlined into the exported HTML file.
3633 @cindex square brackets, around links
3634 @cindex plain text external links
3635 Org also finds external links in the normal text and activates them
3636 as links. If spaces must be part of the link (for example in
3637 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3638 about the end of the link, enclose them in square brackets.
3640 @node Handling links
3641 @section Handling links
3642 @cindex links, handling
3644 Org provides methods to create a link in the correct syntax, to
3645 insert it into an Org file, and to follow the link.
3648 @orgcmd{C-c l,org-store-link}
3649 @cindex storing links
3650 Store a link to the current location. This is a @emph{global} command (you
3651 must create the key binding yourself) which can be used in any buffer to
3652 create a link. The link will be stored for later insertion into an Org
3653 buffer (see below). What kind of link will be created depends on the current
3656 @b{Org mode buffers}@*
3657 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3658 to the target. Otherwise it points to the current headline, which will also
3659 be the description@footnote{If the headline contains a timestamp, it will be
3660 removed from the link and result in a wrong link---you should avoid putting
3661 timestamp in the headline.}.
3663 @vindex org-id-link-to-org-use-id
3664 @cindex property, CUSTOM_ID
3665 @cindex property, ID
3666 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3667 will be stored. In addition or alternatively (depending on the value of
3668 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3669 be created and/or used to construct a link@footnote{The library
3670 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3671 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3672 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3673 potentially create two links: a human-readable from the custom ID, and one
3674 that is globally unique and works even if the entry is moved from file to
3675 file. Later, when inserting the link, you need to decide which one to use.
3677 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3678 Pretty much all Emacs mail clients are supported. The link will point to the
3679 current article, or, in some GNUS buffers, to the group. The description is
3680 constructed from the author and the subject.
3682 @b{Web browsers: W3 and W3M}@*
3683 Here the link will be the current URL, with the page title as description.
3685 @b{Contacts: BBDB}@*
3686 Links created in a BBDB buffer will point to the current entry.
3689 @vindex org-irc-link-to-logs
3690 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3691 a @samp{file:/} style link to the relevant point in the logs for the current
3692 conversation is created. Otherwise an @samp{irc:/} style link to the
3693 user/channel/server under the point will be stored.
3696 For any other files, the link will point to the file, with a search string
3697 (@pxref{Search options}) pointing to the contents of the current line. If
3698 there is an active region, the selected words will form the basis of the
3699 search string. If the automatically created link is not working correctly or
3700 accurately enough, you can write custom functions to select the search string
3701 and to do the search for particular file types---see @ref{Custom searches}.
3702 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3705 When the cursor is in an agenda view, the created link points to the
3706 entry referenced by the current line.
3709 @orgcmd{C-c C-l,org-insert-link}
3710 @cindex link completion
3711 @cindex completion, of links
3712 @cindex inserting links
3713 @vindex org-keep-stored-link-after-insertion
3714 @vindex org-link-parameters
3715 Insert a link@footnote{Note that you don't have to use this command to
3716 insert a link. Links in Org are plain text, and you can type or paste them
3717 straight into the buffer. By using this command, the links are automatically
3718 enclosed in double brackets, and you will be asked for the optional
3719 descriptive text.}. This prompts for a link to be inserted into the buffer.
3720 You can just type a link, using text for an internal link, or one of the link
3721 type prefixes mentioned in the examples above. The link will be inserted
3722 into the buffer@footnote{After insertion of a stored link, the link will be
3723 removed from the list of stored links. To keep it in the list later use, use
3724 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3725 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3726 If some text was selected when this command is called, the selected text
3727 becomes the default description.
3729 @b{Inserting stored links}@*
3730 All links stored during the
3731 current session are part of the history for this prompt, so you can access
3732 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3734 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3735 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3736 defined through link abbreviations (@pxref{Link abbreviations}). If you
3737 press @key{RET} after inserting only the @var{prefix}, Org will offer
3738 specific completion support for some link types@footnote{This works if
3739 a completion function is defined in the @samp{:complete} property of a link
3740 in @code{org-link-parameters}.} For example, if you type @kbd{file
3741 @key{RET}}, file name completion (alternative access: @kbd{C-u C-c C-l}, see
3742 below) will be offered, and after @kbd{bbdb @key{RET}} you can complete
3745 @cindex file name completion
3746 @cindex completion, of file names
3747 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3748 a file will be inserted and you may use file name completion to select
3749 the name of the file. The path to the file is inserted relative to the
3750 directory of the current Org file, if the linked file is in the current
3751 directory or in a sub-directory of it, or if the path is written relative
3752 to the current directory using @samp{../}. Otherwise an absolute path
3753 is used, if possible with @samp{~/} for your home directory. You can
3754 force an absolute path with two @kbd{C-u} prefixes.
3756 @item C-c C-l @ @r{(with cursor on existing link)}
3757 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3758 link and description parts of the link.
3760 @cindex following links
3761 @orgcmd{C-c C-o,org-open-at-point}
3762 @vindex org-file-apps
3763 @vindex org-link-frame-setup
3764 Open link at point. This will launch a web browser for URLs (using
3765 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3766 the corresponding links, and execute the command in a shell link. When the
3767 cursor is on an internal link, this command runs the corresponding search.
3768 When the cursor is on a TAG list in a headline, it creates the corresponding
3769 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3770 date. Furthermore, it will visit text and remote files in @samp{file:} links
3771 with Emacs and select a suitable application for local non-text files.
3772 Classification of files is based on file extension only. See option
3773 @code{org-file-apps}. If you want to override the default application and
3774 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3775 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3776 If the cursor is on a headline, but not on a link, offer all links in the
3777 headline and entry text. If you want to setup the frame configuration for
3778 following links, customize @code{org-link-frame-setup}.
3781 @vindex org-return-follows-link
3782 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3789 On links, @kbd{mouse-1} and @kbd{mouse-2} will open the link just as @kbd{C-c
3794 @vindex org-display-internal-link-with-indirect-buffer
3795 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3796 internal links to be displayed in another window@footnote{See the
3797 option @code{org-display-internal-link-with-indirect-buffer}}.
3799 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3800 @cindex inlining images
3801 @cindex images, inlining
3802 @vindex org-startup-with-inline-images
3803 @cindex @code{inlineimages}, STARTUP keyword
3804 @cindex @code{noinlineimages}, STARTUP keyword
3805 Toggle the inline display of linked images. Normally this will only inline
3806 images that have no description part in the link, i.e., images that will also
3807 be inlined during export. When called with a prefix argument, also display
3808 images that do have a link description. You can ask for inline images to be
3809 displayed at startup by configuring the variable
3810 @code{org-startup-with-inline-images}@footnote{with corresponding
3811 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3812 @orgcmd{C-c %,org-mark-ring-push}
3814 Push the current position onto the mark ring, to be able to return
3815 easily. Commands following an internal link do this automatically.
3817 @orgcmd{C-c &,org-mark-ring-goto}
3818 @cindex links, returning to
3819 Jump back to a recorded position. A position is recorded by the
3820 commands following internal links, and by @kbd{C-c %}. Using this
3821 command several times in direct succession moves through a ring of
3822 previously recorded positions.
3824 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3825 @cindex links, finding next/previous
3826 Move forward/backward to the next link in the buffer. At the limit of
3827 the buffer, the search fails once, and then wraps around. The key
3828 bindings for this are really too long; you might want to bind this also
3829 to @kbd{C-n} and @kbd{C-p}
3831 (add-hook 'org-load-hook
3833 (define-key org-mode-map "\C-n" 'org-next-link)
3834 (define-key org-mode-map "\C-p" 'org-previous-link)))
3838 @node Using links outside Org
3839 @section Using links outside Org
3841 You can insert and follow links that have Org syntax not only in
3842 Org, but in any Emacs buffer. For this, you should create two
3843 global commands, like this (please select suitable global keys
3847 (global-set-key "\C-c L" 'org-insert-link-global)
3848 (global-set-key "\C-c o" 'org-open-at-point-global)
3851 @node Link abbreviations
3852 @section Link abbreviations
3853 @cindex link abbreviations
3854 @cindex abbreviation, links
3856 Long URLs can be cumbersome to type, and often many similar links are
3857 needed in a document. For this you can use link abbreviations. An
3858 abbreviated link looks like this
3861 [[linkword:tag][description]]
3865 @vindex org-link-abbrev-alist
3866 where the tag is optional.
3867 The @i{linkword} must be a word, starting with a letter, followed by
3868 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3869 according to the information in the variable @code{org-link-abbrev-alist}
3870 that relates the linkwords to replacement text. Here is an example:
3874 (setq org-link-abbrev-alist
3875 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3876 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3877 ("google" . "http://www.google.com/search?q=")
3878 ("gmap" . "http://maps.google.com/maps?q=%s")
3879 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3880 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3884 If the replacement text contains the string @samp{%s}, it will be
3885 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3886 url-encode the tag (see the example above, where we need to encode
3887 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3888 to a custom function, and replace it by the resulting string.
3890 If the replacement text doesn't contain any specifier, it will simply
3891 be appended to the string in order to create the link.
3893 Instead of a string, you may also specify a function that will be
3894 called with the tag as the only argument to create the link.
3896 With the above setting, you could link to a specific bug with
3897 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3898 @code{[[google:OrgMode]]}, show the map location of the Free Software
3899 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3900 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3901 what the Org author is doing besides Emacs hacking with
3902 @code{[[ads:Dominik,C]]}.
3904 If you need special abbreviations just for a single Org buffer, you
3905 can define them in the file with
3909 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3910 #+LINK: google http://www.google.com/search?q=%s
3914 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3915 complete link abbreviations. You may also define a function that implements
3916 special (e.g., completion) support for inserting such a link with @kbd{C-c
3917 C-l}. Such a function should not accept any arguments, and return the full
3918 link with prefix. You can add a completion function to a link like this:
3921 (org-link-set-parameters ``type'' :complete #'some-function)
3925 @node Search options
3926 @section Search options in file links
3927 @cindex search option in file links
3928 @cindex file links, searching
3930 File links can contain additional information to make Emacs jump to a
3931 particular location in the file when following a link. This can be a
3932 line number or a search option after a double@footnote{For backward
3933 compatibility, line numbers can also follow a single colon.} colon. For
3934 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3935 links}) to a file, it encodes the words in the current line as a search
3936 string that can be used to find this line back later when following the
3937 link with @kbd{C-c C-o}.
3939 Here is the syntax of the different ways to attach a search to a file
3940 link, together with an explanation:
3943 [[file:~/code/main.c::255]]
3944 [[file:~/xx.org::My Target]]
3945 [[file:~/xx.org::*My Target]]
3946 [[file:~/xx.org::#my-custom-id]]
3947 [[file:~/xx.org::/regexp/]]
3954 Search for a link target @samp{<<My Target>>}, or do a text search for
3955 @samp{my target}, similar to the search in internal links, see
3956 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3957 link will become an HTML reference to the corresponding named anchor in
3960 In an Org file, restrict search to headlines.
3962 Link to a heading with a @code{CUSTOM_ID} property
3964 Do a regular expression search for @code{regexp}. This uses the Emacs
3965 command @code{occur} to list all matches in a separate window. If the
3966 target file is in Org mode, @code{org-occur} is used to create a
3967 sparse tree with the matches.
3968 @c If the target file is a directory,
3969 @c @code{grep} will be used to search all files in the directory.
3972 As a degenerate case, a file link with an empty file name can be used
3973 to search the current file. For example, @code{[[file:::find me]]} does
3974 a search for @samp{find me} in the current file, just as
3975 @samp{[[find me]]} would.
3977 @node Custom searches
3978 @section Custom Searches
3979 @cindex custom search strings
3980 @cindex search strings, custom
3982 The default mechanism for creating search strings and for doing the
3983 actual search related to a file link may not work correctly in all
3984 cases. For example, Bib@TeX{} database files have many entries like
3985 @samp{year="1993"} which would not result in good search strings,
3986 because the only unique identification for a Bib@TeX{} entry is the
3989 @vindex org-create-file-search-functions
3990 @vindex org-execute-file-search-functions
3991 If you come across such a problem, you can write custom functions to set
3992 the right search string for a particular file type, and to do the search
3993 for the string in the file. Using @code{add-hook}, these functions need
3994 to be added to the hook variables
3995 @code{org-create-file-search-functions} and
3996 @code{org-execute-file-search-functions}. See the docstring for these
3997 variables for more information. Org actually uses this mechanism
3998 for Bib@TeX{} database files, and you can use the corresponding code as
3999 an implementation example. See the file @file{org-bibtex.el}.
4005 Org mode does not maintain TODO lists as separate documents@footnote{Of
4006 course, you can make a document that contains only long lists of TODO items,
4007 but this is not required.}. Instead, TODO items are an integral part of the
4008 notes file, because TODO items usually come up while taking notes! With Org
4009 mode, simply mark any entry in a tree as being a TODO item. In this way,
4010 information is not duplicated, and the entire context from which the TODO
4011 item emerged is always present.
4013 Of course, this technique for managing TODO items scatters them
4014 throughout your notes file. Org mode compensates for this by providing
4015 methods to give you an overview of all the things that you have to do.
4018 * TODO basics:: Marking and displaying TODO entries
4019 * TODO extensions:: Workflow and assignments
4020 * Progress logging:: Dates and notes for progress
4021 * Priorities:: Some things are more important than others
4022 * Breaking down tasks:: Splitting a task into manageable pieces
4023 * Checkboxes:: Tick-off lists
4027 @section Basic TODO functionality
4029 Any headline becomes a TODO item when it starts with the word
4030 @samp{TODO}, for example:
4033 *** TODO Write letter to Sam Fortune
4037 The most important commands to work with TODO entries are:
4040 @orgcmd{C-c C-t,org-todo}
4041 @cindex cycling, of TODO states
4042 @vindex org-use-fast-todo-selection
4044 Rotate the TODO state of the current item among
4047 ,-> (unmarked) -> TODO -> DONE --.
4048 '--------------------------------'
4051 If TODO keywords have fast access keys (see @ref{Fast access to TODO
4052 states}), you will be prompted for a TODO keyword through the fast selection
4053 interface; this is the default behavior when
4054 @code{org-use-fast-todo-selection} is non-@code{nil}.
4056 The same rotation can also be done ``remotely'' from the timeline and agenda
4057 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
4059 @orgkey{C-u C-c C-t}
4060 When TODO keywords have no selection keys, select a specific keyword using
4061 completion; otherwise force cycling through TODO states with no prompt. When
4062 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
4063 selection interface.
4065 @kindex S-@key{right}
4066 @kindex S-@key{left}
4067 @item S-@key{right} @ @r{/} @ S-@key{left}
4068 @vindex org-treat-S-cursor-todo-selection-as-state-change
4069 Select the following/preceding TODO state, similar to cycling. Useful
4070 mostly if more than two TODO states are possible (@pxref{TODO
4071 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
4072 with @code{shift-selection-mode}. See also the variable
4073 @code{org-treat-S-cursor-todo-selection-as-state-change}.
4074 @orgcmd{C-c / t,org-show-todo-tree}
4075 @cindex sparse tree, for TODO
4076 @vindex org-todo-keywords
4077 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
4078 entire buffer, but shows all TODO items (with not-DONE state) and the
4079 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
4080 / T}), search for a specific TODO@. You will be prompted for the keyword,
4081 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4082 entries that match any one of these keywords. With a numeric prefix argument
4083 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4084 With two prefix arguments, find all TODO states, both un-done and done.
4085 @orgcmd{C-c a t,org-todo-list}
4086 Show the global TODO list. Collects the TODO items (with not-DONE states)
4087 from all agenda files (@pxref{Agenda views}) into a single buffer. The new
4088 buffer will be in @code{agenda-mode}, which provides commands to examine and
4089 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4090 @xref{Global TODO list}, for more information.
4091 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4092 Insert a new TODO entry below the current one.
4096 @vindex org-todo-state-tags-triggers
4097 Changing a TODO state can also trigger tag changes. See the docstring of the
4098 option @code{org-todo-state-tags-triggers} for details.
4100 @node TODO extensions
4101 @section Extended use of TODO keywords
4102 @cindex extended TODO keywords
4104 @vindex org-todo-keywords
4105 By default, marked TODO entries have one of only two states: TODO and
4106 DONE@. Org mode allows you to classify TODO items in more complex ways
4107 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
4108 special setup, the TODO keyword system can work differently in different
4111 Note that @i{tags} are another way to classify headlines in general and
4112 TODO items in particular (@pxref{Tags}).
4115 * Workflow states:: From TODO to DONE in steps
4116 * TODO types:: I do this, Fred does the rest
4117 * Multiple sets in one file:: Mixing it all, and still finding your way
4118 * Fast access to TODO states:: Single letter selection of a state
4119 * Per-file keywords:: Different files, different requirements
4120 * Faces for TODO keywords:: Highlighting states
4121 * TODO dependencies:: When one task needs to wait for others
4124 @node Workflow states
4125 @subsection TODO keywords as workflow states
4126 @cindex TODO workflow
4127 @cindex workflow states as TODO keywords
4129 You can use TODO keywords to indicate different @emph{sequential} states
4130 in the process of working on an item, for example@footnote{Changing
4131 this variable only becomes effective after restarting Org mode in a
4135 (setq org-todo-keywords
4136 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4139 The vertical bar separates the TODO keywords (states that @emph{need
4140 action}) from the DONE states (which need @emph{no further action}). If
4141 you don't provide the separator bar, the last state is used as the DONE
4143 @cindex completion, of TODO keywords
4144 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4145 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4146 also use a numeric prefix argument to quickly select a specific state. For
4147 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4148 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4149 define many keywords, you can use in-buffer completion
4150 (@pxref{Completion}) or even a special one-key selection scheme
4151 (@pxref{Fast access to TODO states}) to insert these words into the
4152 buffer. Changing a TODO state can be logged with a timestamp, see
4153 @ref{Tracking TODO state changes}, for more information.
4156 @subsection TODO keywords as types
4158 @cindex names as TODO keywords
4159 @cindex types as TODO keywords
4161 The second possibility is to use TODO keywords to indicate different
4162 @emph{types} of action items. For example, you might want to indicate
4163 that items are for ``work'' or ``home''. Or, when you work with several
4164 people on a single project, you might want to assign action items
4165 directly to persons, by using their names as TODO keywords. This would
4166 be set up like this:
4169 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4172 In this case, different keywords do not indicate a sequence, but rather
4173 different types. So the normal work flow would be to assign a task to a
4174 person, and later to mark it DONE@. Org mode supports this style by adapting
4175 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4176 @kbd{t} command in the timeline and agenda buffers.}. When used several
4177 times in succession, it will still cycle through all names, in order to first
4178 select the right type for a task. But when you return to the item after some
4179 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4180 to DONE@. Use prefix arguments or completion to quickly select a specific
4181 name. You can also review the items of a specific TODO type in a sparse tree
4182 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4183 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4184 from all agenda files into a single buffer, you would use the numeric prefix
4185 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4187 @node Multiple sets in one file
4188 @subsection Multiple keyword sets in one file
4189 @cindex TODO keyword sets
4191 Sometimes you may want to use different sets of TODO keywords in
4192 parallel. For example, you may want to have the basic
4193 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4194 separate state indicating that an item has been canceled (so it is not
4195 DONE, but also does not require action). Your setup would then look
4199 (setq org-todo-keywords
4200 '((sequence "TODO" "|" "DONE")
4201 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4202 (sequence "|" "CANCELED")))
4205 The keywords should all be different, this helps Org mode to keep track
4206 of which subsequence should be used for a given entry. In this setup,
4207 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4208 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4209 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4210 select the correct sequence. Besides the obvious ways like typing a
4211 keyword or using completion, you may also apply the following commands:
4214 @kindex C-S-@key{right}
4215 @kindex C-S-@key{left}
4216 @kindex C-u C-u C-c C-t
4217 @item C-u C-u C-c C-t
4218 @itemx C-S-@key{right}
4219 @itemx C-S-@key{left}
4220 These keys jump from one TODO subset to the next. In the above example,
4221 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4222 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4223 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4224 @code{shift-selection-mode} (@pxref{Conflicts}).
4225 @kindex S-@key{right}
4226 @kindex S-@key{left}
4229 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4230 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4231 from @code{DONE} to @code{REPORT} in the example above. See also
4232 @ref{Conflicts}, for a discussion of the interaction with
4233 @code{shift-selection-mode}.
4236 @node Fast access to TODO states
4237 @subsection Fast access to TODO states
4239 If you would like to quickly change an entry to an arbitrary TODO state
4240 instead of cycling through the states, you can set up keys for single-letter
4241 access to the states. This is done by adding the selection character after
4242 each keyword, in parentheses@footnote{All characters are allowed except
4243 @code{@@^!}, which have a special meaning here.}. For example:
4246 (setq org-todo-keywords
4247 '((sequence "TODO(t)" "|" "DONE(d)")
4248 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4249 (sequence "|" "CANCELED(c)")))
4252 @vindex org-fast-tag-selection-include-todo
4253 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4254 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4255 keyword from an entry.@footnote{Check also the option
4256 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4257 state through the tags interface (@pxref{Setting tags}), in case you like to
4258 mingle the two concepts. Note that this means you need to come up with
4259 unique keys across both sets of keywords.}
4261 @node Per-file keywords
4262 @subsection Setting up keywords for individual files
4263 @cindex keyword options
4264 @cindex per-file keywords
4269 It can be very useful to use different aspects of the TODO mechanism in
4270 different files. For file-local settings, you need to add special lines to
4271 the file which set the keywords and interpretation for that file only. For
4272 example, to set one of the two examples discussed above, you need one of the
4273 following lines anywhere in the file:
4276 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4278 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4279 interpretation, but it means the same as @code{#+TODO}), or
4281 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4284 A setup for using several sets in parallel would be:
4288 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4292 @cindex completion, of option keywords
4294 @noindent To make sure you are using the correct keyword, type
4295 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4297 @cindex DONE, final TODO keyword
4298 Remember that the keywords after the vertical bar (or the last keyword
4299 if no bar is there) must always mean that the item is DONE (although you
4300 may use a different word). After changing one of these lines, use
4301 @kbd{C-c C-c} with the cursor still in the line to make the changes
4302 known to Org mode@footnote{Org mode parses these lines only when
4303 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4304 cursor in a line starting with @samp{#+} is simply restarting Org mode
4305 for the current buffer.}.
4307 @node Faces for TODO keywords
4308 @subsection Faces for TODO keywords
4309 @cindex faces, for TODO keywords
4311 @vindex org-todo @r{(face)}
4312 @vindex org-done @r{(face)}
4313 @vindex org-todo-keyword-faces
4314 Org mode highlights TODO keywords with special faces: @code{org-todo}
4315 for keywords indicating that an item still has to be acted upon, and
4316 @code{org-done} for keywords indicating that an item is finished. If
4317 you are using more than 2 different states, you might want to use
4318 special faces for some of them. This can be done using the option
4319 @code{org-todo-keyword-faces}. For example:
4323 (setq org-todo-keyword-faces
4324 '(("TODO" . org-warning) ("STARTED" . "yellow")
4325 ("CANCELED" . (:foreground "blue" :weight bold))))
4329 While using a list with face properties as shown for CANCELED @emph{should}
4330 work, this does not always seem to be the case. If necessary, define a
4331 special face and use that. A string is interpreted as a color. The option
4332 @code{org-faces-easy-properties} determines if that color is interpreted as a
4333 foreground or a background color.
4335 @node TODO dependencies
4336 @subsection TODO dependencies
4337 @cindex TODO dependencies
4338 @cindex dependencies, of TODO states
4339 @cindex TODO dependencies, NOBLOCKING
4341 @vindex org-enforce-todo-dependencies
4342 @cindex property, ORDERED
4343 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4344 dependencies. Usually, a parent TODO task should not be marked DONE until
4345 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4346 there is a logical sequence to a number of (sub)tasks, so that one task
4347 cannot be acted upon before all siblings above it are done. If you customize
4348 the option @code{org-enforce-todo-dependencies}, Org will block entries
4349 from changing state to DONE while they have children that are not DONE@.
4350 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4351 will be blocked until all earlier siblings are marked DONE@. Here is an
4355 * TODO Blocked until (two) is done
4364 ** TODO b, needs to wait for (a)
4365 ** TODO c, needs to wait for (a) and (b)
4368 You can ensure an entry is never blocked by using the @code{NOBLOCKING}
4372 * This entry is never blocked
4379 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4380 @vindex org-track-ordered-property-with-tag
4381 @cindex property, ORDERED
4382 Toggle the @code{ORDERED} property of the current entry. A property is used
4383 for this behavior because this should be local to the current entry, not
4384 inherited like a tag. However, if you would like to @i{track} the value of
4385 this property with a tag for better visibility, customize the option
4386 @code{org-track-ordered-property-with-tag}.
4387 @orgkey{C-u C-u C-u C-c C-t}
4388 Change TODO state, circumventing any state blocking.
4391 @vindex org-agenda-dim-blocked-tasks
4392 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4393 that cannot be closed because of such dependencies will be shown in a dimmed
4394 font or even made invisible in agenda views (@pxref{Agenda views}).
4396 @cindex checkboxes and TODO dependencies
4397 @vindex org-enforce-todo-dependencies
4398 You can also block changes of TODO states by looking at checkboxes
4399 (@pxref{Checkboxes}). If you set the option
4400 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4401 checkboxes will be blocked from switching to DONE.
4403 If you need more complex dependency structures, for example dependencies
4404 between entries in different trees or files, check out the contributed
4405 module @file{org-depend.el}.
4408 @node Progress logging
4409 @section Progress logging
4410 @cindex progress logging
4411 @cindex logging, of progress
4413 Org mode can automatically record a timestamp and possibly a note when
4414 you mark a TODO item as DONE, or even each time you change the state of
4415 a TODO item. This system is highly configurable; settings can be on a
4416 per-keyword basis and can be localized to a file or even a subtree. For
4417 information on how to clock working time for a task, see @ref{Clocking
4421 * Closing items:: When was this entry marked DONE?
4422 * Tracking TODO state changes:: When did the status change?
4423 * Tracking your habits:: How consistent have you been?
4427 @subsection Closing items
4429 The most basic logging is to keep track of @emph{when} a certain TODO
4430 item was finished. This is achieved with@footnote{The corresponding
4431 in-buffer setting is: @code{#+STARTUP: logdone}}
4434 (setq org-log-done 'time)
4437 @vindex org-closed-keep-when-no-todo
4439 Then each time you turn an entry from a TODO (not-done) state into any of the
4440 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4441 the headline. If you turn the entry back into a TODO item through further
4442 state cycling, that line will be removed again. If you turn the entry back
4443 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4444 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4445 non-@code{nil}. If you want to record a note along with the timestamp,
4446 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4450 (setq org-log-done 'note)
4454 You will then be prompted for a note, and that note will be stored below
4455 the entry with a @samp{Closing Note} heading.
4457 In the timeline (@pxref{Timeline}) and in the agenda
4458 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4459 display the TODO items with a @samp{CLOSED} timestamp on each day,
4460 giving you an overview of what has been done.
4462 @node Tracking TODO state changes
4463 @subsection Tracking TODO state changes
4464 @cindex drawer, for state change recording
4466 @vindex org-log-states-order-reversed
4467 @vindex org-log-into-drawer
4468 @cindex property, LOG_INTO_DRAWER
4469 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4470 might want to keep track of when a state change occurred and maybe take a
4471 note about this change. You can either record just a timestamp, or a
4472 time-stamped note for a change. These records will be inserted after the
4473 headline as an itemized list, newest first@footnote{See the option
4474 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4475 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4476 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4477 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4478 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4479 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4480 overrule the setting of this variable for a subtree by setting a
4481 @code{LOG_INTO_DRAWER} property.
4483 Since it is normally too much to record a note for every state, Org mode
4484 expects configuration on a per-keyword basis for this. This is achieved by
4485 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4486 with timestamp) in parentheses after each keyword. For example, with the
4490 (setq org-todo-keywords
4491 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4494 To record a timestamp without a note for TODO keywords configured with
4495 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4498 @vindex org-log-done
4499 You not only define global TODO keywords and fast access keys, but also
4500 request that a time is recorded when the entry is set to
4501 DONE@footnote{It is possible that Org mode will record two timestamps
4502 when you are using both @code{org-log-done} and state change logging.
4503 However, it will never prompt for two notes---if you have configured
4504 both, the state change recording note will take precedence and cancel
4505 the @samp{Closing Note}.}, and that a note is recorded when switching to
4506 WAIT or CANCELED@. The setting for WAIT is even more special: the
4507 @samp{!} after the slash means that in addition to the note taken when
4508 entering the state, a timestamp should be recorded when @i{leaving} the
4509 WAIT state, if and only if the @i{target} state does not configure
4510 logging for entering it. So it has no effect when switching from WAIT
4511 to DONE, because DONE is configured to record a timestamp only. But
4512 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4513 setting now triggers a timestamp even though TODO has no logging
4516 You can use the exact same syntax for setting logging preferences local
4519 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4522 @cindex property, LOGGING
4523 In order to define logging settings that are local to a subtree or a
4524 single item, define a LOGGING property in this entry. Any non-empty
4525 LOGGING property resets all logging settings to @code{nil}. You may then turn
4526 on logging for this specific tree using STARTUP keywords like
4527 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4528 settings like @code{TODO(!)}. For example
4531 * TODO Log each state with only a time
4533 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4535 * TODO Only log when switching to WAIT, and when repeating
4537 :LOGGING: WAIT(@@) logrepeat
4539 * TODO No logging at all
4545 @node Tracking your habits
4546 @subsection Tracking your habits
4549 Org has the ability to track the consistency of a special category of TODOs,
4550 called ``habits''. A habit has the following properties:
4554 You have enabled the @code{habits} module by customizing @code{org-modules}.
4556 The habit is a TODO item, with a TODO keyword representing an open state.
4558 The property @code{STYLE} is set to the value @code{habit}.
4560 The TODO has a scheduled date, usually with a @code{.+} style repeat
4561 interval. A @code{++} style may be appropriate for habits with time
4562 constraints, e.g., must be done on weekends, or a @code{+} style for an
4563 unusual habit that can have a backlog, e.g., weekly reports.
4565 The TODO may also have minimum and maximum ranges specified by using the
4566 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4567 three days, but at most every two days.
4569 You must also have state logging for the @code{DONE} state enabled
4570 (@pxref{Tracking TODO state changes}), in order for historical data to be
4571 represented in the consistency graph. If it is not enabled it is not an
4572 error, but the consistency graphs will be largely meaningless.
4575 To give you an idea of what the above rules look like in action, here's an
4576 actual habit with some history:
4580 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4583 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4585 - State "DONE" from "TODO" [2009-10-15 Thu]
4586 - State "DONE" from "TODO" [2009-10-12 Mon]
4587 - State "DONE" from "TODO" [2009-10-10 Sat]
4588 - State "DONE" from "TODO" [2009-10-04 Sun]
4589 - State "DONE" from "TODO" [2009-10-02 Fri]
4590 - State "DONE" from "TODO" [2009-09-29 Tue]
4591 - State "DONE" from "TODO" [2009-09-25 Fri]
4592 - State "DONE" from "TODO" [2009-09-19 Sat]
4593 - State "DONE" from "TODO" [2009-09-16 Wed]
4594 - State "DONE" from "TODO" [2009-09-12 Sat]
4597 What this habit says is: I want to shave at most every 2 days (given by the
4598 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4599 today is the 15th, then the habit first appears in the agenda on Oct 17,
4600 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4601 after four days have elapsed.
4603 What's really useful about habits is that they are displayed along with a
4604 consistency graph, to show how consistent you've been at getting that task
4605 done in the past. This graph shows every day that the task was done over the
4606 past three weeks, with colors for each day. The colors used are:
4610 If the task wasn't to be done yet on that day.
4612 If the task could have been done on that day.
4614 If the task was going to be overdue the next day.
4616 If the task was overdue on that day.
4619 In addition to coloring each day, the day is also marked with an asterisk if
4620 the task was actually done that day, and an exclamation mark to show where
4621 the current day falls in the graph.
4623 There are several configuration variables that can be used to change the way
4624 habits are displayed in the agenda.
4627 @item org-habit-graph-column
4628 The buffer column at which the consistency graph should be drawn. This will
4629 overwrite any text in that column, so it is a good idea to keep your habits'
4630 titles brief and to the point.
4631 @item org-habit-preceding-days
4632 The amount of history, in days before today, to appear in consistency graphs.
4633 @item org-habit-following-days
4634 The number of days after today that will appear in consistency graphs.
4635 @item org-habit-show-habits-only-for-today
4636 If non-@code{nil}, only show habits in today's agenda view. This is set to true by
4640 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4641 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4642 bring them back. They are also subject to tag filtering, if you have habits
4643 which should only be done in certain contexts, for example.
4649 If you use Org mode extensively, you may end up with enough TODO items that
4650 it starts to make sense to prioritize them. Prioritizing can be done by
4651 placing a @emph{priority cookie} into the headline of a TODO item, like this
4654 *** TODO [#A] Write letter to Sam Fortune
4658 @vindex org-priority-faces
4659 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4660 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4661 treated just like priority @samp{B}. Priorities make a difference only for
4662 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4663 have no inherent meaning to Org mode. The cookies can be highlighted with
4664 special faces by customizing @code{org-priority-faces}.
4666 Priorities can be attached to any outline node; they do not need to be TODO
4672 @findex org-priority
4673 Set the priority of the current headline (@command{org-priority}). The
4674 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4675 When you press @key{SPC} instead, the priority cookie is removed from the
4676 headline. The priorities can also be changed ``remotely'' from the timeline
4677 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4679 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4680 @vindex org-priority-start-cycle-with-default
4681 Increase/decrease priority of current headline@footnote{See also the option
4682 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4683 also used to modify timestamps (@pxref{Creating timestamps}). See also
4684 @ref{Conflicts}, for a discussion of the interaction with
4685 @code{shift-selection-mode}.
4688 @vindex org-highest-priority
4689 @vindex org-lowest-priority
4690 @vindex org-default-priority
4691 You can change the range of allowed priorities by setting the options
4692 @code{org-highest-priority}, @code{org-lowest-priority}, and
4693 @code{org-default-priority}. For an individual buffer, you may set
4694 these values (highest, lowest, default) like this (please make sure that
4695 the highest priority is earlier in the alphabet than the lowest
4698 @cindex #+PRIORITIES
4703 @node Breaking down tasks
4704 @section Breaking tasks down into subtasks
4705 @cindex tasks, breaking down
4706 @cindex statistics, for TODO items
4708 @vindex org-agenda-todo-list-sublevels
4709 It is often advisable to break down large tasks into smaller, manageable
4710 subtasks. You can do this by creating an outline tree below a TODO item,
4711 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4712 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4713 the overview over the fraction of subtasks that are already completed, insert
4714 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4715 be updated each time the TODO status of a child changes, or when pressing
4716 @kbd{C-c C-c} on the cookie. For example:
4719 * Organize Party [33%]
4720 ** TODO Call people [1/2]
4724 ** DONE Talk to neighbor
4727 @cindex property, COOKIE_DATA
4728 If a heading has both checkboxes and TODO children below it, the meaning of
4729 the statistics cookie become ambiguous. Set the property
4730 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4733 @vindex org-hierarchical-todo-statistics
4734 If you would like to have the statistics cookie count any TODO entries in the
4735 subtree (not just direct children), configure
4736 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4737 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4741 * Parent capturing statistics [2/20]
4743 :COOKIE_DATA: todo recursive
4747 If you would like a TODO entry to automatically change to DONE
4748 when all children are done, you can use the following setup:
4751 (defun org-summary-todo (n-done n-not-done)
4752 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4753 (let (org-log-done org-log-states) ; turn off logging
4754 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4756 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4760 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4761 large number of subtasks (@pxref{Checkboxes}).
4768 @vindex org-list-automatic-rules
4769 Every item in a plain list@footnote{With the exception of description
4770 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4771 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4772 it with the string @samp{[ ]}. This feature is similar to TODO items
4773 (@pxref{TODO items}), but is more lightweight. Checkboxes are not included
4774 in the global TODO list, so they are often great to split a task into a
4775 number of simple steps. Or you can use them in a shopping list. To toggle a
4776 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4777 @file{org-mouse.el}).
4779 Here is an example of a checkbox list.
4782 * TODO Organize party [2/4]
4783 - [-] call people [1/3]
4788 - [ ] think about what music to play
4789 - [X] talk to the neighbors
4792 Checkboxes work hierarchically, so if a checkbox item has children that
4793 are checkboxes, toggling one of the children checkboxes will make the
4794 parent checkbox reflect if none, some, or all of the children are
4797 @cindex statistics, for checkboxes
4798 @cindex checkbox statistics
4799 @cindex property, COOKIE_DATA
4800 @vindex org-checkbox-hierarchical-statistics
4801 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4802 indicating how many checkboxes present in this entry have been checked off,
4803 and the total number of checkboxes present. This can give you an idea on how
4804 many checkboxes remain, even without opening a folded entry. The cookies can
4805 be placed into a headline or into (the first line of) a plain list item.
4806 Each cookie covers checkboxes of direct children structurally below the
4807 headline/item on which the cookie appears@footnote{Set the option
4808 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4809 count all checkboxes below the cookie, not just those belonging to direct
4810 children.}. You have to insert the cookie yourself by typing either
4811 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4812 result, as in the examples above. With @samp{[%]} you get information about
4813 the percentage of checkboxes checked (in the above example, this would be
4814 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4815 count either checkboxes below the heading or TODO states of children, and it
4816 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4817 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4819 @cindex blocking, of checkboxes
4820 @cindex checkbox blocking
4821 @cindex property, ORDERED
4822 If the current outline node has an @code{ORDERED} property, checkboxes must
4823 be checked off in sequence, and an error will be thrown if you try to check
4824 off a box while there are unchecked boxes above it.
4826 @noindent The following commands work with checkboxes:
4829 @orgcmd{C-c C-c,org-toggle-checkbox}
4830 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4831 With a single prefix argument, add an empty checkbox or remove the current
4832 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4833 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4834 considered to be an intermediate state.
4835 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4836 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4837 double prefix argument, set it to @samp{[-]}, which is considered to be an
4841 If there is an active region, toggle the first checkbox in the region
4842 and set all remaining boxes to the same status as the first. With a prefix
4843 arg, add or remove the checkbox for all items in the region.
4845 If the cursor is in a headline, toggle checkboxes in the region between
4846 this headline and the next (so @emph{not} the entire subtree).
4848 If there is no active region, just toggle the checkbox at point.
4850 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4851 Insert a new item with a checkbox. This works only if the cursor is already
4852 in a plain list item (@pxref{Plain lists}).
4853 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4854 @vindex org-track-ordered-property-with-tag
4855 @cindex property, ORDERED
4856 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4857 be checked off in sequence. A property is used for this behavior because
4858 this should be local to the current entry, not inherited like a tag.
4859 However, if you would like to @i{track} the value of this property with a tag
4860 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4861 @orgcmd{C-c #,org-update-statistics-cookies}
4862 Update the statistics cookie in the current outline entry. When called with
4863 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4864 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4865 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4866 changing TODO states. If you delete boxes/entries or add/change them by
4867 hand, use this command to get things back into sync.
4873 @cindex headline tagging
4874 @cindex matching, tags
4875 @cindex sparse tree, tag based
4877 An excellent way to implement labels and contexts for cross-correlating
4878 information is to assign @i{tags} to headlines. Org mode has extensive
4881 @vindex org-tag-faces
4882 Every headline can contain a list of tags; they occur at the end of the
4883 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4884 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4885 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4886 Tags will by default be in bold face with the same color as the headline.
4887 You may specify special faces for specific tags using the option
4888 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4889 (@pxref{Faces for TODO keywords}).
4892 * Tag inheritance:: Tags use the tree structure of the outline
4893 * Setting tags:: How to assign tags to a headline
4894 * Tag hierarchy:: Create a hierarchy of tags
4895 * Tag searches:: Searching for combinations of tags
4898 @node Tag inheritance
4899 @section Tag inheritance
4900 @cindex tag inheritance
4901 @cindex inheritance, of tags
4902 @cindex sublevels, inclusion into tags match
4904 @i{Tags} make use of the hierarchical structure of outline trees. If a
4905 heading has a certain tag, all subheadings will inherit the tag as
4906 well. For example, in the list
4909 * Meeting with the French group :work:
4910 ** Summary by Frank :boss:notes:
4911 *** TODO Prepare slides for him :action:
4915 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4916 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4917 explicitly marked with those tags. You can also set tags that all entries in
4918 a file should inherit just as if these tags were defined in a hypothetical
4919 level zero that surrounds the entire file. Use a line like this@footnote{As
4920 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4921 changes in the line.}:
4925 #+FILETAGS: :Peter:Boss:Secret:
4929 @vindex org-use-tag-inheritance
4930 @vindex org-tags-exclude-from-inheritance
4931 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4932 To turn it off entirely, use @code{org-use-tag-inheritance}.
4934 @vindex org-tags-match-list-sublevels
4935 When a headline matches during a tags search while tag inheritance is turned
4936 on, all the sublevels in the same tree will (for a simple match form) match
4937 as well@footnote{This is only true if the search does not involve more
4938 complex tests including properties (@pxref{Property searches}).}. The list
4939 of matches may then become very long. If you only want to see the first tags
4940 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4943 @vindex org-agenda-use-tag-inheritance
4944 Tag inheritance is relevant when the agenda search tries to match a tag,
4945 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4946 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4947 have your tags correctly set in the agenda, so that tag filtering works fine,
4948 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4949 this: the default value includes all agenda types, but setting this to @code{nil}
4950 can really speed up agenda generation.
4953 @section Setting tags
4954 @cindex setting tags
4955 @cindex tags, setting
4958 Tags can simply be typed into the buffer at the end of a headline.
4959 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4960 also a special command for inserting tags:
4963 @orgcmd{C-c C-q,org-set-tags-command}
4964 @cindex completion, of tags
4965 @vindex org-tags-column
4966 Enter new tags for the current headline. Org mode will either offer
4967 completion or a special single-key interface for setting tags, see
4968 below. After pressing @key{RET}, the tags will be inserted and aligned
4969 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4970 tags in the current buffer will be aligned to that column, just to make
4971 things look nice. TAGS are automatically realigned after promotion,
4972 demotion, and TODO state changes (@pxref{TODO basics}).
4974 @orgcmd{C-c C-c,org-set-tags-command}
4975 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4978 @vindex org-tag-alist
4979 Org supports tag insertion based on a @emph{list of tags}. By
4980 default this list is constructed dynamically, containing all tags
4981 currently used in the buffer. You may also globally specify a hard list
4982 of tags with the variable @code{org-tag-alist}. Finally you can set
4983 the default tags for a given file with lines like
4987 #+TAGS: @@work @@home @@tennisclub
4988 #+TAGS: laptop car pc sailboat
4991 If you have globally defined your preferred set of tags using the
4992 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4993 in a specific file, add an empty TAGS option line to that file:
4999 @vindex org-tag-persistent-alist
5000 If you have a preferred set of tags that you would like to use in every file,
5001 in addition to those defined on a per-file basis by TAGS option lines, then
5002 you may specify a list of tags with the variable
5003 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
5004 by adding a STARTUP option line to that file:
5010 By default Org mode uses the standard minibuffer completion facilities for
5011 entering tags. However, it also implements another, quicker, tag selection
5012 method called @emph{fast tag selection}. This allows you to select and
5013 deselect tags with just a single key press. For this to work well you should
5014 assign unique letters to most of your commonly used tags. You can do this
5015 globally by configuring the variable @code{org-tag-alist} in your
5016 @file{.emacs} file. For example, you may find the need to tag many items in
5017 different files with @samp{:@@home:}. In this case you can set something
5021 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
5024 @noindent If the tag is only relevant to the file you are working on, then you
5025 can instead set the TAGS option line as:
5028 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
5031 @noindent The tags interface will show the available tags in a splash
5032 window. If you want to start a new line after a specific tag, insert
5033 @samp{\n} into the tag list
5036 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
5039 @noindent or write them in two lines:
5042 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
5043 #+TAGS: laptop(l) pc(p)
5047 You can also group together tags that are mutually exclusive by using
5051 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
5054 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
5055 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
5057 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
5058 these lines to activate any changes.
5061 To set these mutually exclusive groups in the variable @code{org-tag-alist},
5062 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
5063 of the braces. Similarly, you can use @code{:newline} to indicate a line
5064 break. The previous example would be set globally by the following
5068 (setq org-tag-alist '((:startgroup . nil)
5069 ("@@work" . ?w) ("@@home" . ?h)
5070 ("@@tennisclub" . ?t)
5072 ("laptop" . ?l) ("pc" . ?p)))
5075 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
5076 automatically present you with a special interface, listing inherited tags,
5077 the tags of the current headline, and a list of all valid tags with
5078 corresponding keys@footnote{Keys will automatically be assigned to tags which
5079 have no configured keys.}. In this interface, you can use the following
5084 Pressing keys assigned to tags will add or remove them from the list of
5085 tags in the current line. Selecting a tag in a group of mutually
5086 exclusive tags will turn off any other tags from that group.
5089 Enter a tag in the minibuffer, even if the tag is not in the predefined
5090 list. You will be able to complete on all tags present in the buffer.
5091 You can also add several tags: just separate them with a comma.
5095 Clear all tags for this line.
5098 Accept the modified set.
5100 Abort without installing changes.
5102 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5104 Turn off groups of mutually exclusive tags. Use this to (as an
5105 exception) assign several tags from such a group.
5107 Toggle auto-exit after the next change (see below).
5108 If you are using expert mode, the first @kbd{C-c} will display the
5113 This method lets you assign tags to a headline with very few keys. With
5114 the above setup, you could clear the current tags and set @samp{@@home},
5115 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5116 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
5117 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5118 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
5119 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5120 @key{RET} @key{RET}}.
5122 @vindex org-fast-tag-selection-single-key
5123 If you find that most of the time you need only a single key press to
5124 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5125 Then you no longer have to press @key{RET} to exit fast tag selection---it
5126 will immediately exit after the first change. If you then occasionally
5127 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5128 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5129 instead of @kbd{C-c C-c}). If you set the variable to the value
5130 @code{expert}, the special window is not even shown for single-key tag
5131 selection, it comes up only when you press an extra @kbd{C-c}.
5134 @section Tag hierarchy
5137 @cindex tags, groups
5138 @cindex tag hierarchy
5139 Tags can be defined in hierarchies. A tag can be defined as a @emph{group
5140 tag} for a set of other tags. The group tag can be seen as the ``broader
5141 term'' for its set of tags. Defining multiple @emph{group tags} and nesting
5142 them creates a tag hierarchy.
5144 One use-case is to create a taxonomy of terms (tags) that can be used to
5145 classify nodes in a document or set of documents.
5147 When you search for a group tag, it will return matches for all members in
5148 the group and its subgroup. In an agenda view, filtering by a group tag will
5149 display or hide headlines tagged with at least one of the members of the
5150 group or any of its subgroups. This makes tag searches and filters even more
5153 You can set group tags by using brackets and inserting a colon between the
5154 group tag and its related tags---beware that all whitespaces are mandatory so
5155 that Org can parse this line correctly:
5158 #+TAGS: [ GTD : Control Persp ]
5161 In this example, @samp{GTD} is the @emph{group tag} and it is related to two
5162 other tags: @samp{Control}, @samp{Persp}. Defining @samp{Control} and
5163 @samp{Persp} as group tags creates an hierarchy of tags:
5166 #+TAGS: [ Control : Context Task ]
5167 #+TAGS: [ Persp : Vision Goal AOF Project ]
5170 That can conceptually be seen as a hierarchy of tags:
5184 You can use the @code{:startgrouptag}, @code{:grouptags} and
5185 @code{:endgrouptag} keyword directly when setting @code{org-tag-alist}
5189 (setq org-tag-alist '((:startgrouptag)
5203 The tags in a group can be mutually exclusive if using the same group syntax
5204 as is used for grouping mutually exclusive tags together; using curly
5208 #+TAGS: @{ Context : @@Home @@Work @@Call @}
5211 When setting @code{org-tag-alist} you can use @code{:startgroup} &
5212 @code{:endgroup} instead of @code{:startgrouptag} & @code{:endgrouptag} to
5213 make the tags mutually exclusive.
5215 Furthermore, the members of a @emph{group tag} can also be regular
5216 expressions, creating the possibility of a more dynamic and rule-based
5217 tag structure. The regular expressions in the group must be specified
5218 within @{ @}. Here is an expanded example:
5221 #+TAGS: [ Vision : @{V@@@.+@} ]
5222 #+TAGS: [ Goal : @{G@@@.+@} ]
5223 #+TAGS: [ AOF : @{AOF@@@.+@} ]
5224 #+TAGS: [ Project : @{P@@@.+@} ]
5227 Searching for the tag @samp{Project} will now list all tags also including
5228 regular expression matches for @samp{P@@@.+}, and similarly for tag searches on
5229 @samp{Vision}, @samp{Goal} and @samp{AOF}. For example, this would work well
5230 for a project tagged with a common project-identifier, e.g. @samp{P@@2014_OrgTags}.
5233 @vindex org-group-tags
5234 If you want to ignore group tags temporarily, toggle group tags support
5235 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5236 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5239 @section Tag searches
5240 @cindex tag searches
5241 @cindex searching for tags
5243 Once a system of tags has been set up, it can be used to collect related
5244 information into special lists.
5247 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5248 Create a sparse tree with all headlines matching a tags/property/TODO search.
5249 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5250 @xref{Matching tags and properties}.
5251 @orgcmd{C-c a m,org-tags-view}
5252 Create a global list of tag matches from all agenda files. @xref{Matching
5253 tags and properties}.
5254 @orgcmd{C-c a M,org-tags-view}
5255 @vindex org-tags-match-list-sublevels
5256 Create a global list of tag matches from all agenda files, but check
5257 only TODO items and force checking subitems (see the option
5258 @code{org-tags-match-list-sublevels}).
5261 These commands all prompt for a match string which allows basic Boolean logic
5262 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5263 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5264 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5265 string is rich and allows also matching against TODO keywords, entry levels
5266 and properties. For a complete description with many examples, see
5267 @ref{Matching tags and properties}.
5270 @node Properties and columns
5271 @chapter Properties and columns
5274 A property is a key-value pair associated with an entry. Properties can be
5275 set so they are associated with a single entry, with every entry in a tree,
5276 or with every entry in an Org mode file.
5278 There are two main applications for properties in Org mode. First,
5279 properties are like tags, but with a value. Imagine maintaining a file where
5280 you document bugs and plan releases for a piece of software. Instead of
5281 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5282 property, say @code{:Release:}, that in different subtrees has different
5283 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5284 implement (very basic) database capabilities in an Org buffer. Imagine
5285 keeping track of your music CDs, where properties could be things such as the
5286 album, artist, date of release, number of tracks, and so on.
5288 Properties can be conveniently edited and viewed in column view
5289 (@pxref{Column view}).
5292 * Property syntax:: How properties are spelled out
5293 * Special properties:: Access to other Org mode features
5294 * Property searches:: Matching property values
5295 * Property inheritance:: Passing values down the tree
5296 * Column view:: Tabular viewing and editing
5297 * Property API:: Properties for Lisp programmers
5300 @node Property syntax
5301 @section Property syntax
5302 @cindex property syntax
5303 @cindex drawer, for properties
5305 Properties are key-value pairs. When they are associated with a single entry
5306 or with a tree they need to be inserted into a special drawer
5307 (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
5308 right below a headline, and its planning line (@pxref{Deadlines and
5309 scheduling}) when applicable. Each property is specified on a single line,
5310 with the key (surrounded by colons) first, and the value after it. Keys are
5311 case-insensitives. Here is an example:
5316 *** Goldberg Variations
5318 :Title: Goldberg Variations
5319 :Composer: J.S. Bach
5321 :Publisher: Deutsche Grammophon
5326 Depending on the value of @code{org-use-property-inheritance}, a property set
5327 this way will either be associated with a single entry, or the subtree
5328 defined by the entry, see @ref{Property inheritance}.
5330 You may define the allowed values for a particular property @samp{:Xyz:}
5331 by setting a property @samp{:Xyz_ALL:}. This special property is
5332 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5333 the entire tree. When allowed values are defined, setting the
5334 corresponding property becomes easier and is less prone to typing
5335 errors. For the example with the CD collection, we can predefine
5336 publishers and the number of disks in a box like this:
5341 :NDisks_ALL: 1 2 3 4
5342 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5346 If you want to set properties that can be inherited by any entry in a
5347 file, use a line like
5348 @cindex property, _ALL
5351 #+PROPERTY: NDisks_ALL 1 2 3 4
5354 Contrary to properties set from a special drawer, you have to refresh the
5355 buffer with @kbd{C-c C-c} to activate this change.
5357 If you want to add to the value of an existing property, append a @code{+} to
5358 the property name. The following results in the property @code{var} having
5359 the value ``foo=1 bar=2''.
5362 #+PROPERTY: var foo=1
5363 #+PROPERTY: var+ bar=2
5366 It is also possible to add to the values of inherited properties. The
5367 following results in the @code{genres} property having the value ``Classic
5368 Baroque'' under the @code{Goldberg Variations} subtree.
5376 *** Goldberg Variations
5378 :Title: Goldberg Variations
5379 :Composer: J.S. Bach
5381 :Publisher: Deutsche Grammophon
5386 Note that a property can only have one entry per Drawer.
5388 @vindex org-global-properties
5389 Property values set with the global variable
5390 @code{org-global-properties} can be inherited by all entries in all
5394 The following commands help to work with properties:
5397 @orgcmd{M-@key{TAB},pcomplete}
5398 After an initial colon in a line, complete property keys. All keys used
5399 in the current file will be offered as possible completions.
5400 @orgcmd{C-c C-x p,org-set-property}
5401 Set a property. This prompts for a property name and a value. If
5402 necessary, the property drawer is created as well.
5403 @item C-u M-x org-insert-drawer RET
5404 @cindex org-insert-drawer
5405 Insert a property drawer into the current entry. The drawer will be
5406 inserted early in the entry, but after the lines with planning
5407 information like deadlines.
5408 @orgcmd{C-c C-c,org-property-action}
5409 With the cursor in a property drawer, this executes property commands.
5410 @orgcmd{C-c C-c s,org-set-property}
5411 Set a property in the current entry. Both the property and the value
5412 can be inserted using completion.
5413 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5414 Switch property at point to the next/previous allowed value.
5415 @orgcmd{C-c C-c d,org-delete-property}
5416 Remove a property from the current entry.
5417 @orgcmd{C-c C-c D,org-delete-property-globally}
5418 Globally remove a property, from all entries in the current file.
5419 @orgcmd{C-c C-c c,org-compute-property-at-point}
5420 Compute the property at point, using the operator and scope from the
5421 nearest column format definition.
5424 @node Special properties
5425 @section Special properties
5426 @cindex properties, special
5428 Special properties provide an alternative access method to Org mode features,
5429 like the TODO state or the priority of an entry, discussed in the previous
5430 chapters. This interface exists so that you can include these states in
5431 a column view (@pxref{Column view}), or to use them in queries. The
5432 following property names are special and should not be used as keys in the
5435 @cindex property, special, ALLTAGS
5436 @cindex property, special, BLOCKED
5437 @cindex property, special, CLOCKSUM
5438 @cindex property, special, CLOCKSUM_T
5439 @cindex property, special, CLOSED
5440 @cindex property, special, DEADLINE
5441 @cindex property, special, FILE
5442 @cindex property, special, ITEM
5443 @cindex property, special, PRIORITY
5444 @cindex property, special, SCHEDULED
5445 @cindex property, special, TAGS
5446 @cindex property, special, TIMESTAMP
5447 @cindex property, special, TIMESTAMP_IA
5448 @cindex property, special, TODO
5450 ALLTAGS @r{All tags, including inherited ones.}
5451 BLOCKED @r{"t" if task is currently blocked by children or siblings.}
5452 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5453 @r{must be run first to compute the values in the current buffer.}
5454 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5455 @r{@code{org-clock-sum-today} must be run first to compute the}
5456 @r{values in the current buffer.}
5457 CLOSED @r{When was this entry closed?}
5458 DEADLINE @r{The deadline time string, without the angular brackets.}
5459 FILE @r{The filename the entry is located in.}
5460 ITEM @r{The headline of the entry.}
5461 PRIORITY @r{The priority of the entry, a string with a single letter.}
5462 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5463 TAGS @r{The tags defined directly in the headline.}
5464 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5465 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5466 TODO @r{The TODO keyword of the entry.}
5469 @node Property searches
5470 @section Property searches
5471 @cindex properties, searching
5472 @cindex searching, of properties
5474 To create sparse trees and special lists with selection based on properties,
5475 the same commands are used as for tag searches (@pxref{Tag searches}).
5478 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5479 Create a sparse tree with all matching entries. With a
5480 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5481 @orgcmd{C-c a m,org-tags-view}
5482 Create a global list of tag/property matches from all agenda files.
5483 @xref{Matching tags and properties}.
5484 @orgcmd{C-c a M,org-tags-view}
5485 @vindex org-tags-match-list-sublevels
5486 Create a global list of tag matches from all agenda files, but check
5487 only TODO items and force checking of subitems (see the option
5488 @code{org-tags-match-list-sublevels}).
5491 The syntax for the search string is described in @ref{Matching tags and
5494 There is also a special command for creating sparse trees based on a
5499 Create a sparse tree based on the value of a property. This first
5500 prompts for the name of a property, and then for a value. A sparse tree
5501 is created with all entries that define this property with the given
5502 value. If you enclose the value in curly braces, it is interpreted as
5503 a regular expression and matched against the property values.
5506 @node Property inheritance
5507 @section Property Inheritance
5508 @cindex properties, inheritance
5509 @cindex inheritance, of properties
5511 @vindex org-use-property-inheritance
5512 The outline structure of Org mode documents lends itself to an
5513 inheritance model of properties: if the parent in a tree has a certain
5514 property, the children can inherit this property. Org mode does not
5515 turn this on by default, because it can slow down property searches
5516 significantly and is often not needed. However, if you find inheritance
5517 useful, you can turn it on by setting the variable
5518 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5519 all properties inherited from the parent, to a list of properties
5520 that should be inherited, or to a regular expression that matches
5521 inherited properties. If a property has the value @code{nil}, this is
5522 interpreted as an explicit undefine of the property, so that inheritance
5523 search will stop at this value and return @code{nil}.
5525 Org mode has a few properties for which inheritance is hard-coded, at
5526 least for the special applications for which they are used:
5528 @cindex property, COLUMNS
5531 The @code{:COLUMNS:} property defines the format of column view
5532 (@pxref{Column view}). It is inherited in the sense that the level
5533 where a @code{:COLUMNS:} property is defined is used as the starting
5534 point for a column view table, independently of the location in the
5535 subtree from where columns view is turned on.
5537 @cindex property, CATEGORY
5538 For agenda view, a category set through a @code{:CATEGORY:} property
5539 applies to the entire subtree.
5541 @cindex property, ARCHIVE
5542 For archiving, the @code{:ARCHIVE:} property may define the archive
5543 location for the entire subtree (@pxref{Moving subtrees}).
5545 @cindex property, LOGGING
5546 The LOGGING property may define logging settings for an entry or a
5547 subtree (@pxref{Tracking TODO state changes}).
5551 @section Column view
5553 A great way to view and edit properties in an outline tree is
5554 @emph{column view}. In column view, each outline node is turned into a
5555 table row. Columns in this table provide access to properties of the
5556 entries. Org mode implements columns by overlaying a tabular structure
5557 over the headline of each item. While the headlines have been turned
5558 into a table row, you can still change the visibility of the outline
5559 tree. For example, you get a compact table by switching to CONTENTS
5560 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5561 is active), but you can still open, read, and edit the entry below each
5562 headline. Or, you can switch to column view after executing a sparse
5563 tree command and in this way get a table only for the selected items.
5564 Column view also works in agenda buffers (@pxref{Agenda views}) where
5565 queries have collected selected items, possibly from a number of files.
5568 * Defining columns:: The COLUMNS format property
5569 * Using column view:: How to create and use column view
5570 * Capturing column view:: A dynamic block for column view
5573 @node Defining columns
5574 @subsection Defining columns
5575 @cindex column view, for properties
5576 @cindex properties, column view
5578 Setting up a column view first requires defining the columns. This is
5579 done by defining a column format line.
5582 * Scope of column definitions:: Where defined, where valid?
5583 * Column attributes:: Appearance and content of a column
5586 @node Scope of column definitions
5587 @subsubsection Scope of column definitions
5589 To define a column format for an entire file, use a line like
5593 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5596 To specify a format that only applies to a specific tree, add a
5597 @code{:COLUMNS:} property to the top node of that tree, for example:
5600 ** Top node for columns view
5602 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5606 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5607 for the entry itself, and for the entire subtree below it. Since the
5608 column definition is part of the hierarchical structure of the document,
5609 you can define columns on level 1 that are general enough for all
5610 sublevels, and more specific columns further down, when you edit a
5611 deeper part of the tree.
5613 @node Column attributes
5614 @subsubsection Column attributes
5615 A column definition sets the attributes of a column. The general
5616 definition looks like this:
5619 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5623 Except for the percent sign and the property name, all items are
5624 optional. The individual parts have the following meaning:
5627 @var{width} @r{An integer specifying the width of the column in characters.}
5628 @r{If omitted, the width will be determined automatically.}
5629 @var{property} @r{The property that should be edited in this column.}
5630 @r{Special properties representing meta data are allowed here}
5631 @r{as well (@pxref{Special properties})}
5632 @var{title} @r{The header text for the column. If omitted, the property}
5634 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5635 @r{parent nodes are computed from the children@footnote{If
5636 more than one summary type apply to the property, the parent
5637 values are computed according to the first of them.}.}
5638 @r{Supported summary types are:}
5639 @{+@} @r{Sum numbers in this column.}
5640 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5641 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5642 @{min@} @r{Smallest number in column.}
5643 @{max@} @r{Largest number.}
5644 @{mean@} @r{Arithmetic mean of numbers.}
5645 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5646 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5647 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5648 @{:@} @r{Sum times, HH:MM, plain numbers are
5649 hours@footnote{A time can also be a duration, using effort
5650 modifiers defined in @code{org-effort-durations}, e.g.,
5651 @samp{3d 1h}. If any value in the column is as such, the
5652 summary will also be an effort duration.}.}
5653 @{:min@} @r{Smallest time value in column.}
5654 @{:max@} @r{Largest time value.}
5655 @{:mean@} @r{Arithmetic mean of time values.}
5656 @{@@min@} @r{Minimum age@footnote{An age is defined as
5657 a duration since a given time-stamp (@pxref{Timestamps}). It
5658 can also be expressed as days, hours, minutes and seconds,
5659 identified by @samp{d}, @samp{h}, @samp{m} and @samp{s}
5660 suffixes, all mandatory, e.g., @samp{0d 13h 0m 10s}.} (in
5661 days/hours/mins/seconds).}
5662 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5663 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5664 @{est+@} @r{Add @samp{low-high} estimates.}
5667 The @code{est+} summary type requires further explanation. It is used for
5668 combining estimates, expressed as @samp{low-high} ranges or plain numbers.
5669 For example, instead of estimating a particular task will take 5 days, you
5670 might estimate it as 5--6 days if you're fairly confident you know how much
5671 work is required, or 1--10 days if you don't really know what needs to be
5672 done. Both ranges average at 5.5 days, but the first represents a more
5673 predictable delivery.
5675 When combining a set of such estimates, simply adding the lows and highs
5676 produces an unrealistically wide result. Instead, @code{est+} adds the
5677 statistical mean and variance of the sub-tasks, generating a final estimate
5678 from the sum. For example, suppose you had ten tasks, each of which was
5679 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5680 of 5 to 20 days, representing what to expect if everything goes either
5681 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5682 full job more realistically, at 10--15 days.
5684 Numbers are right-aligned when a format specifier with an explicit width like
5685 @code{%5d} or @code{%5.1f} is used.
5687 @vindex org-columns-summary-types
5688 You can also define custom summary types by setting
5689 @code{org-columns-summary-types}, which see.
5691 Here is an example for a complete columns definition, along with allowed
5695 :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.}
5696 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5697 :Owner_ALL: Tammy Mark Karl Lisa Don
5698 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5699 :Approved_ALL: "[ ]" "[X]"
5703 The first column, @samp{%25ITEM}, means the first 25 characters of the
5704 item itself, i.e., of the headline. You probably always should start the
5705 column definition with the @samp{ITEM} specifier. The other specifiers
5706 create columns @samp{Owner} with a list of names as allowed values, for
5707 @samp{Status} with four different possible values, and for a checkbox
5708 field @samp{Approved}. When no width is given after the @samp{%}
5709 character, the column will be exactly as wide as it needs to be in order
5710 to fully display all values. The @samp{Approved} column does have a
5711 modified title (@samp{Approved?}, with a question mark). Summaries will
5712 be created for the @samp{Time_Estimate} column by adding time duration
5713 expressions like HH:MM, and for the @samp{Approved} column, by providing
5714 an @samp{[X]} status if all children have been checked. The
5715 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5716 sums of CLOCK intervals in the subtree, either for all clocks or just for
5719 @node Using column view
5720 @subsection Using column view
5723 @tsubheading{Turning column view on and off}
5724 @orgcmd{C-c C-x C-c,org-columns}
5725 @vindex org-columns-default-format
5726 Turn on column view. If the cursor is before the first headline in the file,
5727 or the function called with the universal prefix argument, column view is
5728 turned on for the entire file, using the @code{#+COLUMNS} definition. If the
5729 cursor is somewhere inside the outline, this command searches the hierarchy,
5730 up from point, for a @code{:COLUMNS:} property that defines a format. When
5731 one is found, the column view table is established for the tree starting at
5732 the entry that contains the @code{:COLUMNS:} property. If no such property
5733 is found, the format is taken from the @code{#+COLUMNS} line or from the
5734 variable @code{org-columns-default-format}, and column view is established
5735 for the current entry and its subtree.
5736 @orgcmd{r,org-columns-redo}
5737 Recreate the column view, to include recent changes made in the buffer.
5738 @orgcmd{g,org-columns-redo}
5740 @orgcmd{q,org-columns-quit}
5742 @tsubheading{Editing values}
5743 @item @key{left} @key{right} @key{up} @key{down}
5744 Move through the column view from field to field.
5745 @kindex S-@key{left}
5746 @kindex S-@key{right}
5747 @item S-@key{left}/@key{right}
5748 Switch to the next/previous allowed value of the field. For this, you
5749 have to have specified allowed values for a property.
5751 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5752 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5753 Same as @kbd{S-@key{left}/@key{right}}
5754 @orgcmd{e,org-columns-edit-value}
5755 Edit the property at point. For the special properties, this will
5756 invoke the same interface that you normally use to change that
5757 property. For example, when editing a TAGS property, the tag completion
5758 or fast selection interface will pop up.
5759 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5760 When there is a checkbox at point, toggle it.
5761 @orgcmd{v,org-columns-show-value}
5762 View the full value of this property. This is useful if the width of
5763 the column is smaller than that of the value.
5764 @orgcmd{a,org-columns-edit-allowed}
5765 Edit the list of allowed values for this property. If the list is found
5766 in the hierarchy, the modified value is stored there. If no list is
5767 found, the new value is stored in the first entry that is part of the
5768 current column view.
5769 @tsubheading{Modifying the table structure}
5770 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5771 Make the column narrower/wider by one character.
5772 @orgcmd{S-M-@key{right},org-columns-new}
5773 Insert a new column, to the left of the current column.
5774 @orgcmd{S-M-@key{left},org-columns-delete}
5775 Delete the current column.
5778 @node Capturing column view
5779 @subsection Capturing column view
5781 Since column view is just an overlay over a buffer, it cannot be
5782 exported or printed directly. If you want to capture a column view, use
5783 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5784 of this block looks like this:
5786 @cindex #+BEGIN, columnview
5789 #+BEGIN: columnview :hlines 1 :id "label"
5794 @noindent This dynamic block has the following parameters:
5798 This is the most important parameter. Column view is a feature that is
5799 often localized to a certain (sub)tree, and the capture block might be
5800 at a different location in the file. To identify the tree whose view to
5801 capture, you can use 4 values:
5802 @cindex property, ID
5804 local @r{use the tree in which the capture block is located}
5805 global @r{make a global view, including all headings in the file}
5806 "file:@var{path-to-file}"
5807 @r{run column view at the top of this file}
5808 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5809 @r{property with the value @i{label}. You can use}
5810 @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5811 @r{the current entry and copy it to the kill-ring.}
5814 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5815 an hline before each headline with level @code{<= @var{N}}.
5817 When set to @code{t}, force column groups to get vertical lines.
5819 When set to a number, don't capture entries below this level.
5820 @item :skip-empty-rows
5821 When set to @code{t}, skip rows where the only non-empty specifier of the
5822 column view is @code{ITEM}.
5824 When non-@code{nil}, indent each @code{ITEM} field according to its level.
5829 The following commands insert or update the dynamic block:
5832 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5833 Insert a dynamic block capturing a column view. You will be prompted
5834 for the scope or ID of the view.
5835 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5836 Update dynamic block at point. The cursor needs to be in the
5837 @code{#+BEGIN} line of the dynamic block.
5838 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5839 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5840 you have several clock table blocks, column-capturing blocks or other dynamic
5844 You can add formulas to the column view table and you may add plotting
5845 instructions in front of the table---these will survive an update of the
5846 block. If there is a @code{#+TBLFM:} after the table, the table will
5847 actually be recalculated automatically after an update.
5849 An alternative way to capture and process property values into a table is
5850 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5851 package@footnote{Contributed packages are not part of Emacs, but are
5852 distributed with the main distribution of Org (visit
5853 @uref{http://orgmode.org}).}. It provides a general API to collect
5854 properties from entries in a certain scope, and arbitrary Lisp expressions to
5855 process these values before inserting them into a table or a dynamic block.
5858 @section The Property API
5859 @cindex properties, API
5860 @cindex API, for properties
5862 There is a full API for accessing and changing properties. This API can
5863 be used by Emacs Lisp programs to work with properties and to implement
5864 features based on them. For more information see @ref{Using the
5867 @node Dates and times
5868 @chapter Dates and times
5874 To assist project planning, TODO items can be labeled with a date and/or
5875 a time. The specially formatted string carrying the date and time
5876 information is called a @emph{timestamp} in Org mode. This may be a
5877 little confusing because timestamp is often used to indicate when
5878 something was created or last changed. However, in Org mode this term
5879 is used in a much wider sense.
5882 * Timestamps:: Assigning a time to a tree entry
5883 * Creating timestamps:: Commands which insert timestamps
5884 * Deadlines and scheduling:: Planning your work
5885 * Clocking work time:: Tracking how long you spend on a task
5886 * Effort estimates:: Planning work effort in advance
5887 * Timers:: Notes with a running timer
5892 @section Timestamps, deadlines, and scheduling
5894 @cindex ranges, time
5899 A timestamp is a specification of a date (possibly with a time or a range of
5900 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5901 simplest form, the day name is optional when you type the date yourself.
5902 However, any dates inserted or modified by Org will add that day name, for
5903 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5904 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5905 date/time format. To use an alternative format, see @ref{Custom time
5906 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5907 tree entry. Its presence causes entries to be shown on specific dates in the
5908 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5911 @item Plain timestamp; Event; Appointment
5914 A simple timestamp just assigns a date/time to an item. This is just
5915 like writing down an appointment or event in a paper agenda. In the
5916 timeline and agenda displays, the headline of an entry associated with a
5917 plain timestamp will be shown exactly on that date.
5920 * Meet Peter at the movies
5921 <2006-11-01 Wed 19:15>
5922 * Discussion on climate change
5923 <2006-11-02 Thu 20:00-22:00>
5926 @item Timestamp with repeater interval
5927 @cindex timestamp, with repeater interval
5928 A timestamp may contain a @emph{repeater interval}, indicating that it
5929 applies not only on the given date, but again and again after a certain
5930 interval of N days (d), weeks (w), months (m), or years (y). The
5931 following will show up in the agenda every Wednesday:
5934 * Pick up Sam at school
5935 <2007-05-16 Wed 12:30 +1w>
5938 @item Diary-style sexp entries
5939 For more complex date specifications, Org mode supports using the special
5940 sexp diary entries implemented in the Emacs calendar/diary
5941 package@footnote{When working with the standard diary sexp functions, you
5942 need to be very careful with the order of the arguments. That order depends
5943 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5944 versions, @code{european-calendar-style}). For example, to specify a date
5945 December 1, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5946 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5947 the settings. This has been the source of much confusion. Org mode users
5948 can resort to special versions of these functions like @code{org-date} or
5949 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5950 functions, but with stable ISO order of arguments (year, month, day) wherever
5951 applicable, independent of the value of @code{calendar-date-style}.}. For
5952 example with optional time
5955 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5956 <%%(diary-float t 4 2)>
5959 @item Time/Date range
5962 Two timestamps connected by @samp{--} denote a range. The headline
5963 will be shown on the first and last day of the range, and on any dates
5964 that are displayed and fall in the range. Here is an example:
5967 ** Meeting in Amsterdam
5968 <2004-08-23 Mon>--<2004-08-26 Thu>
5971 @item Inactive timestamp
5972 @cindex timestamp, inactive
5973 @cindex inactive timestamp
5974 Just like a plain timestamp, but with square brackets instead of
5975 angular ones. These timestamps are inactive in the sense that they do
5976 @emph{not} trigger an entry to show up in the agenda.
5979 * Gillian comes late for the fifth time
5985 @node Creating timestamps
5986 @section Creating timestamps
5987 @cindex creating timestamps
5988 @cindex timestamps, creating
5990 For Org mode to recognize timestamps, they need to be in the specific
5991 format. All commands listed below produce timestamps in the correct
5995 @orgcmd{C-c .,org-time-stamp}
5996 Prompt for a date and insert a corresponding timestamp. When the cursor is
5997 at an existing timestamp in the buffer, the command is used to modify this
5998 timestamp instead of inserting a new one. When this command is used twice in
5999 succession, a time range is inserted.
6001 @orgcmd{C-c !,org-time-stamp-inactive}
6002 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
6009 @vindex org-time-stamp-rounding-minutes
6010 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
6011 contains date and time. The default time can be rounded to multiples of 5
6012 minutes, see the option @code{org-time-stamp-rounding-minutes}.
6015 Normalize timestamp, insert/fix day name if missing or wrong.
6017 @orgcmd{C-c <,org-date-from-calendar}
6018 Insert a timestamp corresponding to the cursor date in the Calendar.
6020 @orgcmd{C-c >,org-goto-calendar}
6021 Access the Emacs calendar for the current date. If there is a
6022 timestamp in the current line, go to the corresponding date
6025 @orgcmd{C-c C-o,org-open-at-point}
6026 Access the agenda for the date given by the timestamp or -range at
6027 point (@pxref{Weekly/daily agenda}).
6029 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
6030 Change date at cursor by one day. These key bindings conflict with
6031 shift-selection and related modes (@pxref{Conflicts}).
6033 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
6034 Change the item under the cursor in a timestamp. The cursor can be on a
6035 year, month, day, hour or minute. When the timestamp contains a time range
6036 like @samp{15:30-16:30}, modifying the first time will also shift the second,
6037 shifting the time block with constant length. To change the length, modify
6038 the second time. Note that if the cursor is in a headline and not at a
6039 timestamp, these same keys modify the priority of an item.
6040 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
6041 related modes (@pxref{Conflicts}).
6043 @orgcmd{C-c C-y,org-evaluate-time-range}
6044 @cindex evaluate time range
6045 Evaluate a time range by computing the difference between start and end.
6046 With a prefix argument, insert result after the time range (in a table: into
6047 the following column).
6052 * The date/time prompt:: How Org mode helps you entering date and time
6053 * Custom time format:: Making dates look different
6056 @node The date/time prompt
6057 @subsection The date/time prompt
6058 @cindex date, reading in minibuffer
6059 @cindex time, reading in minibuffer
6061 @vindex org-read-date-prefer-future
6062 When Org mode prompts for a date/time, the default is shown in default
6063 date/time format, and the prompt therefore seems to ask for a specific
6064 format. But it will in fact accept date/time information in a variety of
6065 formats. Generally, the information should start at the beginning of the
6066 string. Org mode will find whatever information is in
6067 there and derive anything you have not specified from the @emph{default date
6068 and time}. The default is usually the current date and time, but when
6069 modifying an existing timestamp, or when entering the second stamp of a
6070 range, it is taken from the stamp in the buffer. When filling in
6071 information, Org mode assumes that most of the time you will want to enter a
6072 date in the future: if you omit the month/year and the given day/month is
6073 @i{before} today, it will assume that you mean a future date@footnote{See the
6074 variable @code{org-read-date-prefer-future}. You may set that variable to
6075 the symbol @code{time} to even make a time before now shift the date to
6076 tomorrow.}. If the date has been automatically shifted into the future, the
6077 time prompt will show this with @samp{(=>F).}
6079 For example, let's assume that today is @b{June 13, 2006}. Here is how
6080 various inputs will be interpreted, the items filled in by Org mode are
6084 3-2-5 @result{} 2003-02-05
6085 2/5/3 @result{} 2003-02-05
6086 14 @result{} @b{2006}-@b{06}-14
6087 12 @result{} @b{2006}-@b{07}-12
6088 2/5 @result{} @b{2007}-02-05
6089 Fri @result{} nearest Friday after the default date
6090 sep 15 @result{} @b{2006}-09-15
6091 feb 15 @result{} @b{2007}-02-15
6092 sep 12 9 @result{} 2009-09-12
6093 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
6094 22 sept 0:34 @result{} @b{2006}-09-22 00:34
6095 w4 @result{} ISO week for of the current year @b{2006}
6096 2012 w4 fri @result{} Friday of ISO week 4 in 2012
6097 2012-w04-5 @result{} Same as above
6100 Furthermore you can specify a relative date by giving, as the @emph{first}
6101 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
6102 indicate change in hours, days, weeks, months, or years. With a single plus
6103 or minus, the date is always relative to today. With a double plus or minus,
6104 it is relative to the default date. If instead of a single letter, you use
6105 the abbreviation of day name, the date will be the Nth such day, e.g.:
6110 +4d @result{} four days from today
6111 +4 @result{} same as above
6112 +2w @result{} two weeks from today
6113 ++5 @result{} five days from default date
6114 +2tue @result{} second Tuesday from now
6115 -wed @result{} last Wednesday
6118 @vindex parse-time-months
6119 @vindex parse-time-weekdays
6120 The function understands English month and weekday abbreviations. If
6121 you want to use unabbreviated names and/or other languages, configure
6122 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
6124 @vindex org-read-date-force-compatible-dates
6125 Not all dates can be represented in a given Emacs implementation. By default
6126 Org mode forces dates into the compatibility range 1970--2037 which works on
6127 all Emacs implementations. If you want to use dates outside of this range,
6128 read the docstring of the variable
6129 @code{org-read-date-force-compatible-dates}.
6131 You can specify a time range by giving start and end times or by giving a
6132 start time and a duration (in HH:MM format). Use one or two dash(es) as the
6133 separator in the former case and use '+' as the separator in the latter
6137 11am-1:15pm @result{} 11:00-13:15
6138 11am--1:15pm @result{} same as above
6139 11am+2:15 @result{} same as above
6142 @cindex calendar, for selecting date
6143 @vindex org-popup-calendar-for-date-prompt
6144 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6145 you don't need/want the calendar, configure the variable
6146 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
6147 prompt, either by clicking on a date in the calendar, or by pressing
6148 @key{RET}, the date selected in the calendar will be combined with the
6149 information entered at the prompt. You can control the calendar fully
6150 from the minibuffer:
6157 @kindex S-@key{right}
6158 @kindex S-@key{left}
6159 @kindex S-@key{down}
6161 @kindex M-S-@key{right}
6162 @kindex M-S-@key{left}
6164 @kindex M-S-@key{down}
6165 @kindex M-S-@key{up}
6168 @key{RET} @r{Choose date at cursor in calendar.}
6169 mouse-1 @r{Select date by clicking on it.}
6170 S-@key{right}/@key{left} @r{One day forward/backward.}
6171 S-@key{down}/@key{up} @r{One week forward/backward.}
6172 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6173 > / < @r{Scroll calendar forward/backward by one month.}
6174 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
6175 M-S-@key{down}/@key{up} @r{Scroll calendar forward/backward by one year.}
6178 @vindex org-read-date-display-live
6179 The actions of the date/time prompt may seem complex, but I assure you they
6180 will grow on you, and you will start getting annoyed by pretty much any other
6181 way of entering a date/time out there. To help you understand what is going
6182 on, the current interpretation of your input will be displayed live in the
6183 minibuffer@footnote{If you find this distracting, turn the display off with
6184 @code{org-read-date-display-live}.}.
6186 @node Custom time format
6187 @subsection Custom time format
6188 @cindex custom date/time format
6189 @cindex time format, custom
6190 @cindex date format, custom
6192 @vindex org-display-custom-times
6193 @vindex org-time-stamp-custom-formats
6194 Org mode uses the standard ISO notation for dates and times as it is
6195 defined in ISO 8601. If you cannot get used to this and require another
6196 representation of date and time to keep you happy, you can get it by
6197 customizing the options @code{org-display-custom-times} and
6198 @code{org-time-stamp-custom-formats}.
6201 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6202 Toggle the display of custom formats for dates and times.
6206 Org mode needs the default format for scanning, so the custom date/time
6207 format does not @emph{replace} the default format---instead it is put
6208 @emph{over} the default format using text properties. This has the
6209 following consequences:
6212 You cannot place the cursor onto a timestamp anymore, only before or
6215 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6216 each component of a timestamp. If the cursor is at the beginning of
6217 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6218 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6219 time will be changed by one minute.
6221 If the timestamp contains a range of clock times or a repeater, these
6222 will not be overlaid, but remain in the buffer as they were.
6224 When you delete a timestamp character-by-character, it will only
6225 disappear from the buffer after @emph{all} (invisible) characters
6226 belonging to the ISO timestamp have been removed.
6228 If the custom timestamp format is longer than the default and you are
6229 using dates in tables, table alignment will be messed up. If the custom
6230 format is shorter, things do work as expected.
6234 @node Deadlines and scheduling
6235 @section Deadlines and scheduling
6237 A timestamp may be preceded by special keywords to facilitate planning:
6241 @cindex DEADLINE keyword
6243 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6244 to be finished on that date.
6246 @vindex org-deadline-warning-days
6247 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6248 On the deadline date, the task will be listed in the agenda. In
6249 addition, the agenda for @emph{today} will carry a warning about the
6250 approaching or missed deadline, starting
6251 @code{org-deadline-warning-days} before the due date, and continuing
6252 until the entry is marked DONE@. An example:
6255 *** TODO write article about the Earth for the Guide
6256 DEADLINE: <2004-02-29 Sun>
6257 The editor in charge is [[bbdb:Ford Prefect]]
6260 You can specify a different lead time for warnings for a specific
6261 deadline using the following syntax. Here is an example with a warning
6262 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6263 deactivated if the task gets scheduled and you set
6264 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6267 @cindex SCHEDULED keyword
6269 Meaning: you are planning to start working on that task on the given
6272 @vindex org-agenda-skip-scheduled-if-done
6273 The headline will be listed under the given date@footnote{It will still
6274 be listed on that date after it has been marked DONE@. If you don't like
6275 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6276 addition, a reminder that the scheduled date has passed will be present
6277 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6278 the task will automatically be forwarded until completed.
6281 *** TODO Call Trillian for a date on New Years Eve.
6282 SCHEDULED: <2004-12-25 Sat>
6285 @vindex org-scheduled-delay-days
6286 @vindex org-agenda-skip-scheduled-delay-if-deadline
6287 If you want to @emph{delay} the display of this task in the agenda, use
6288 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6289 25th but will appear two days later. In case the task contains a repeater,
6290 the delay is considered to affect all occurrences; if you want the delay to
6291 only affect the first scheduled occurrence of the task, use @code{--2d}
6292 instead. See @code{org-scheduled-delay-days} and
6293 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6294 control this globally or per agenda.
6297 @b{Important:} Scheduling an item in Org mode should @i{not} be
6298 understood in the same way that we understand @i{scheduling a meeting}.
6299 Setting a date for a meeting is just a simple appointment, you should
6300 mark this entry with a simple plain timestamp, to get this item shown
6301 on the date where it applies. This is a frequent misunderstanding by
6302 Org users. In Org mode, @i{scheduling} means setting a date when you
6303 want to start working on an action item.
6306 You may use timestamps with repeaters in scheduling and deadline
6307 entries. Org mode will issue early and late warnings based on the
6308 assumption that the timestamp represents the @i{nearest instance} of
6309 the repeater. However, the use of diary sexp entries like
6311 @code{<%%(diary-float t 42)>}
6313 in scheduling and deadline timestamps is limited. Org mode does not
6314 know enough about the internals of each sexp function to issue early and
6315 late warnings. However, it will show the item on each day where the
6319 * Inserting deadline/schedule:: Planning items
6320 * Repeated tasks:: Items that show up again and again
6323 @node Inserting deadline/schedule
6324 @subsection Inserting deadlines or schedules
6326 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6327 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6328 any text between this line and the headline.} a deadline or to schedule
6333 @orgcmd{C-c C-d,org-deadline}
6334 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6335 in the line directly following the headline. Any CLOSED timestamp will be
6336 removed. When called with a prefix arg, an existing deadline will be removed
6337 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6338 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6339 and @code{nologredeadline}}, a note will be taken when changing an existing
6342 @orgcmd{C-c C-s,org-schedule}
6343 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6344 happen in the line directly following the headline. Any CLOSED timestamp
6345 will be removed. When called with a prefix argument, remove the scheduling
6346 date from the entry. Depending on the variable
6347 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6348 keywords @code{logreschedule}, @code{lognotereschedule}, and
6349 @code{nologreschedule}}, a note will be taken when changing an existing
6352 @orgcmd{C-c / d,org-check-deadlines}
6353 @cindex sparse tree, for deadlines
6354 @vindex org-deadline-warning-days
6355 Create a sparse tree with all deadlines that are either past-due, or
6356 which will become due within @code{org-deadline-warning-days}.
6357 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6358 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6359 all deadlines due tomorrow.
6361 @orgcmd{C-c / b,org-check-before-date}
6362 Sparse tree for deadlines and scheduled items before a given date.
6364 @orgcmd{C-c / a,org-check-after-date}
6365 Sparse tree for deadlines and scheduled items after a given date.
6368 Note that @code{org-schedule} and @code{org-deadline} supports
6369 setting the date by indicating a relative time: e.g., +1d will set
6370 the date to the next day after today, and --1w will set the date
6371 to the previous week before any current timestamp.
6373 @node Repeated tasks
6374 @subsection Repeated tasks
6375 @cindex tasks, repeated
6376 @cindex repeated tasks
6378 Some tasks need to be repeated again and again. Org mode helps to
6379 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6380 or plain timestamp. In the following example
6382 ** TODO Pay the rent
6383 DEADLINE: <2005-10-01 Sat +1m>
6386 the @code{+1m} is a repeater; the intended interpretation is that the task
6387 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6388 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6389 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6390 and a special warning period in a deadline entry, the repeater should come
6391 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6393 @vindex org-todo-repeat-to-state
6394 Deadlines and scheduled items produce entries in the agenda when they are
6395 over-due, so it is important to be able to mark such an entry as completed
6396 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6397 keyword DONE, it will no longer produce entries in the agenda. The problem
6398 with this is, however, that then also the @emph{next} instance of the
6399 repeated entry will not be active. Org mode deals with this in the following
6400 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6401 shift the base date of the repeating timestamp by the repeater interval, and
6402 immediately set the entry state back to TODO@footnote{In fact, the target
6403 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6404 the variable @code{org-todo-repeat-to-state}. If neither of these is
6405 specified, the target state defaults to the first state of the TODO state
6406 sequence.}. In the example above, setting the state to DONE would actually
6407 switch the date like this:
6410 ** TODO Pay the rent
6411 DEADLINE: <2005-11-01 Tue +1m>
6414 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6415 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6417 @vindex org-log-repeat
6418 A timestamp@footnote{You can change this using the option
6419 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6420 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6421 will also be prompted for a note.} will be added under the deadline, to keep
6422 a record that you actually acted on the previous instance of this deadline.
6424 As a consequence of shifting the base date, this entry will no longer be
6425 visible in the agenda when checking past dates, but all future instances
6428 With the @samp{+1m} cookie, the date shift will always be exactly one
6429 month. So if you have not paid the rent for three months, marking this
6430 entry DONE will still keep it as an overdue deadline. Depending on the
6431 task, this may not be the best way to handle it. For example, if you
6432 forgot to call your father for 3 weeks, it does not make sense to call
6433 him 3 times in a single day to make up for it. Finally, there are tasks
6434 like changing batteries which should always repeat a certain time
6435 @i{after} the last time you did it. For these tasks, Org mode has
6436 special repeaters @samp{++} and @samp{.+}. For example:
6440 DEADLINE: <2008-02-10 Sun ++1w>
6441 Marking this DONE will shift the date by at least one week,
6442 but also by as many weeks as it takes to get this date into
6443 the future. However, it stays on a Sunday, even if you called
6444 and marked it done on Saturday.
6445 ** TODO Empty kitchen trash
6446 DEADLINE: <2008-02-08 Fri 20:00 ++1d>
6447 Marking this DONE will shift the date by at least one day, and
6448 also by as many days as it takes to get the timestamp into the
6449 future. Since there is a time in the timestamp, the next
6450 deadline in the future will be on today's date if you
6451 complete the task before 20:00.
6452 ** TODO Check the batteries in the smoke detectors
6453 DEADLINE: <2005-11-01 Tue .+1m>
6454 Marking this DONE will shift the date to one month after
6458 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6459 You may have both scheduling and deadline information for a specific task.
6460 If the repeater is set for the scheduling information only, you probably want
6461 the repeater to be ignored after the deadline. If so, set the variable
6462 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6463 @code{repeated-after-deadline}. However, any scheduling information without
6464 a repeater is no longer relevant once the task is done, and thus, removed
6465 upon repeating the task. If you want both scheduling and deadline
6466 information to repeat after the same interval, set the same repeater for both
6469 An alternative to using a repeater is to create a number of copies of a task
6470 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6471 created for this purpose, it is described in @ref{Structure editing}.
6474 @node Clocking work time
6475 @section Clocking work time
6476 @cindex clocking time
6477 @cindex time clocking
6479 Org mode allows you to clock the time you spend on specific tasks in a
6480 project. When you start working on an item, you can start the clock. When
6481 you stop working on that task, or when you mark the task done, the clock is
6482 stopped and the corresponding time interval is recorded. It also computes
6483 the total time spent on each subtree@footnote{Clocking only works if all
6484 headings are indented with less than 30 stars. This is a hardcoded
6485 limitation of @code{lmax} in @code{org-clock-sum}.} of a project.
6486 And it remembers a history or tasks recently clocked, so that you can jump
6487 quickly between a number of tasks absorbing your time.
6489 To save the clock history across Emacs sessions, use
6491 (setq org-clock-persist 'history)
6492 (org-clock-persistence-insinuate)
6494 When you clock into a new task after resuming Emacs, the incomplete
6495 clock@footnote{To resume the clock under the assumption that you have worked
6496 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6497 will be found (@pxref{Resolving idle time}) and you will be prompted about
6501 * Clocking commands:: Starting and stopping a clock
6502 * The clock table:: Detailed reports
6503 * Resolving idle time:: Resolving time when you've been idle
6506 @node Clocking commands
6507 @subsection Clocking commands
6510 @orgcmd{C-c C-x C-i,org-clock-in}
6511 @vindex org-clock-into-drawer
6512 @vindex org-clock-continuously
6513 @cindex property, LOG_INTO_DRAWER
6514 Start the clock on the current item (clock-in). This inserts the CLOCK
6515 keyword together with a timestamp. If this is not the first clocking of
6516 this item, the multiple CLOCK lines will be wrapped into a
6517 @code{:LOGBOOK:} drawer (see also the variable
6518 @code{org-clock-into-drawer}). You can also overrule
6519 the setting of this variable for a subtree by setting a
6520 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6521 When called with a @kbd{C-u} prefix argument,
6522 select the task from a list of recently clocked tasks. With two @kbd{C-u
6523 C-u} prefixes, clock into the task at point and mark it as the default task;
6524 the default task will then always be available with letter @kbd{d} when
6525 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6526 continuous clocking by starting the clock when the last clock stopped.@*
6527 @cindex property: CLOCK_MODELINE_TOTAL
6528 @cindex property: LAST_REPEAT
6529 @vindex org-clock-modeline-total
6530 While the clock is running, the current clocking time is shown in the mode
6531 line, along with the title of the task. The clock time shown will be all
6532 time ever clocked for this task and its children. If the task has an effort
6533 estimate (@pxref{Effort estimates}), the mode line displays the current
6534 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6535 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6536 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6537 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6538 will be shown. More control over what time is shown can be exercised with
6539 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6540 @code{current} to show only the current clocking instance, @code{today} to
6541 show all time clocked on this task today (see also the variable
6542 @code{org-extend-today-until}), @code{all} to include all time, or
6543 @code{auto} which is the default@footnote{See also the variable
6544 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6545 mode line entry will pop up a menu with clocking options.
6547 @orgcmd{C-c C-x C-o,org-clock-out}
6548 @vindex org-log-note-clock-out
6549 Stop the clock (clock-out). This inserts another timestamp at the same
6550 location where the clock was last started. It also directly computes
6551 the resulting time and inserts it after the time range as @samp{=>
6552 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6553 possibility to record an additional note together with the clock-out
6554 timestamp@footnote{The corresponding in-buffer setting is:
6555 @code{#+STARTUP: lognoteclock-out}}.
6556 @orgcmd{C-c C-x C-x,org-clock-in-last}
6557 @vindex org-clock-continuously
6558 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6559 select the task from the clock history. With two @kbd{C-u} prefixes,
6560 force continuous clocking by starting the clock when the last clock
6562 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6563 Update the effort estimate for the current clock task.
6566 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6567 Recompute the time interval after changing one of the timestamps. This
6568 is only necessary if you edit the timestamps directly. If you change
6569 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6570 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6571 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6572 clock duration keeps the same.
6573 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6574 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6575 the one of the previous (or the next clock) timestamp by the same duration.
6576 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6577 by five minutes, then the clocked-in timestamp of the next clock will be
6578 increased by five minutes.
6579 @orgcmd{C-c C-t,org-todo}
6580 Changing the TODO state of an item to DONE automatically stops the clock
6581 if it is running in this same item.
6582 @orgcmd{C-c C-x C-q,org-clock-cancel}
6583 Cancel the current clock. This is useful if a clock was started by
6584 mistake, or if you ended up working on something else.
6585 @orgcmd{C-c C-x C-j,org-clock-goto}
6586 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6587 prefix arg, select the target task from a list of recently clocked tasks.
6588 @orgcmd{C-c C-x C-d,org-clock-display}
6589 @vindex org-remove-highlights-with-change
6590 Display time summaries for each subtree in the current buffer. This puts
6591 overlays at the end of each headline, showing the total time recorded under
6592 that heading, including the time of any subheadings. You can use visibility
6593 cycling to study the tree, but the overlays disappear when you change the
6594 buffer (see variable @code{org-remove-highlights-with-change}) or press
6598 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6599 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6600 worked on or closed during a day.
6602 @strong{Important:} note that both @code{org-clock-out} and
6603 @code{org-clock-in-last} can have a global key binding and will not
6604 modify the window disposition.
6606 @node The clock table
6607 @subsection The clock table
6608 @cindex clocktable, dynamic block
6609 @cindex report, of clocked time
6611 Org mode can produce quite complex reports based on the time clocking
6612 information. Such a report is called a @emph{clock table}, because it is
6613 formatted as one or several Org tables.
6616 @orgcmd{C-c C-x C-r,org-clock-report}
6617 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6618 report as an Org mode table into the current file. When the cursor is
6619 at an existing clock table, just update it. When called with a prefix
6620 argument, jump to the first clock report in the current document and
6621 update it. The clock table always includes also trees with
6622 @code{:ARCHIVE:} tag.
6623 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6624 Update dynamic block at point. The cursor needs to be in the
6625 @code{#+BEGIN} line of the dynamic block.
6626 @orgkey{C-u C-c C-x C-u}
6627 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6628 you have several clock table blocks in a buffer.
6629 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6630 Shift the current @code{:block} interval and update the table. The cursor
6631 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6632 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6636 Here is an example of the frame for a clock table as it is inserted into the
6637 buffer with the @kbd{C-c C-x C-r} command:
6639 @cindex #+BEGIN, clocktable
6641 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6645 @vindex org-clocktable-defaults
6646 The @samp{BEGIN} line specifies a number of options to define the scope,
6647 structure, and formatting of the report. Defaults for all these options can
6648 be configured in the variable @code{org-clocktable-defaults}.
6650 @noindent First there are options that determine which clock entries are to
6653 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6654 @r{Clocks at deeper levels will be summed into the upper level.}
6655 :scope @r{The scope to consider. This can be any of the following:}
6656 nil @r{the current buffer or narrowed region}
6657 file @r{the full current buffer}
6658 subtree @r{the subtree where the clocktable is located}
6659 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6660 tree @r{the surrounding level 1 tree}
6661 agenda @r{all agenda files}
6662 ("file"..) @r{scan these files}
6663 file-with-archives @r{current file and its archives}
6664 agenda-with-archives @r{all agenda files, including archives}
6665 :block @r{The time block to consider. This block is specified either}
6666 @r{absolutely, or relative to the current time and may be any of}
6668 2007-12-31 @r{New year eve 2007}
6669 2007-12 @r{December 2007}
6670 2007-W50 @r{ISO-week 50 in 2007}
6671 2007-Q2 @r{2nd quarter in 2007}
6672 2007 @r{the year 2007}
6673 today, yesterday, today-@var{N} @r{a relative day}
6674 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6675 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6676 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6678 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6679 :tstart @r{A time string specifying when to start considering times.}
6680 @r{Relative times like @code{"<-2w>"} can also be used. See}
6681 @r{@ref{Matching tags and properties} for relative time syntax.}
6682 :tend @r{A time string specifying when to stop considering times.}
6683 @r{Relative times like @code{"<now>"} can also be used. See}
6684 @r{@ref{Matching tags and properties} for relative time syntax.}
6685 :wstart @r{The starting day of the week. The default is 1 for monday.}
6686 :mstart @r{The starting day of the month. The default 1 is for the first}
6687 @r{day of the month.}
6688 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6689 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6690 :stepskip0 @r{Do not show steps that have zero time.}
6691 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6692 :tags @r{A tags match to select entries that should contribute. See}
6693 @r{@ref{Matching tags and properties} for the match syntax.}
6696 Then there are options which determine the formatting of the table. These
6697 options are interpreted by the function @code{org-clocktable-write-default},
6698 but you can specify your own function using the @code{:formatter} parameter.
6700 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6701 :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".}
6702 :link @r{Link the item headlines in the table to their origins.}
6703 :narrow @r{An integer to limit the width of the headline column in}
6704 @r{the org table. If you write it like @samp{50!}, then the}
6705 @r{headline will also be shortened in export.}
6706 :indent @r{Indent each headline field according to its level.}
6707 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6708 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6709 :level @r{Should a level number column be included?}
6710 :sort @r{A cons cell like containing the column to sort and a sorting type.}
6711 @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6712 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6713 @r{All are overwritten except if there is an explicit @code{:narrow}}
6714 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6715 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6716 :properties @r{List of properties that should be shown in the table. Each}
6717 @r{property will get its own column.}
6718 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6719 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6720 @r{As a special case, @samp{:formula %} adds a column with % time.}
6721 @r{If you do not specify a formula here, any existing formula}
6722 @r{below the clock table will survive updates and be evaluated.}
6723 :formatter @r{A function to format clock data and insert it into the buffer.}
6725 To get a clock summary of the current level 1 tree, for the current
6726 day, you could write
6728 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6732 and to use a specific time range you could write@footnote{Note that all
6733 parameters must be specified in a single line---the line is broken here
6734 only to fit it into the manual.}
6736 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6737 :tend "<2006-08-10 Thu 12:00>"
6740 A range starting a week ago and ending right now could be written as
6742 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6745 A summary of the current subtree with % times would be
6747 #+BEGIN: clocktable :scope subtree :link t :formula %
6750 A horizontally compact representation of everything clocked during last week
6753 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6757 @node Resolving idle time
6758 @subsection Resolving idle time and continuous clocking
6760 @subsubheading Resolving idle time
6761 @cindex resolve idle time
6762 @vindex org-clock-x11idle-program-name
6764 @cindex idle, resolve, dangling
6765 If you clock in on a work item, and then walk away from your
6766 computer---perhaps to take a phone call---you often need to ``resolve'' the
6767 time you were away by either subtracting it from the current clock, or
6768 applying it to another one.
6770 @vindex org-clock-idle-time
6771 By customizing the variable @code{org-clock-idle-time} to some integer, such
6772 as 10 or 15, Emacs can alert you when you get back to your computer after
6773 being idle for that many minutes@footnote{On computers using Mac OS X,
6774 idleness is based on actual user idleness, not just Emacs' idle time. For
6775 X11, you can install a utility program @file{x11idle.c}, available in the
6776 @code{contrib/scripts} directory of the Org git distribution, or install the
6777 @file{xprintidle} package and set it to the variable
6778 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6779 same general treatment of idleness. On other systems, idle time refers to
6780 Emacs idle time only.}, and ask what you want to do with the idle time.
6781 There will be a question waiting for you when you get back, indicating how
6782 much idle time has passed (constantly updated with the current amount), as
6783 well as a set of choices to correct the discrepancy:
6787 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6788 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6789 effectively changing nothing, or enter a number to keep that many minutes.
6791 If you use the shift key and press @kbd{K}, it will keep however many minutes
6792 you request and then immediately clock out of that task. If you keep all of
6793 the minutes, this is the same as just clocking out of the current task.
6795 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6796 the clock, and then check back in from the moment you returned.
6798 To keep none of the minutes and just clock out at the start of the away time,
6799 use the shift key and press @kbd{S}. Remember that using shift will always
6800 leave you clocked out, no matter which option you choose.
6802 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6803 canceling you subtract the away time, and the resulting clock amount is less
6804 than a minute, the clock will still be canceled rather than clutter up the
6805 log with an empty entry.
6808 What if you subtracted those away minutes from the current clock, and now
6809 want to apply them to a new clock? Simply clock in to any task immediately
6810 after the subtraction. Org will notice that you have subtracted time ``on
6811 the books'', so to speak, and will ask if you want to apply those minutes to
6812 the next task you clock in on.
6814 There is one other instance when this clock resolution magic occurs. Say you
6815 were clocked in and hacking away, and suddenly your cat chased a mouse who
6816 scared a hamster that crashed into your UPS's power button! You suddenly
6817 lose all your buffers, but thanks to auto-save you still have your recent Org
6818 mode changes, including your last clock in.
6820 If you restart Emacs and clock into any task, Org will notice that you have a
6821 dangling clock which was never clocked out from your last session. Using
6822 that clock's starting time as the beginning of the unaccounted-for period,
6823 Org will ask how you want to resolve that time. The logic and behavior is
6824 identical to dealing with away time due to idleness; it is just happening due
6825 to a recovery event rather than a set amount of idle time.
6827 You can also check all the files visited by your Org agenda for dangling
6828 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6830 @subsubheading Continuous clocking
6831 @cindex continuous clocking
6832 @vindex org-clock-continuously
6834 You may want to start clocking from the time when you clocked out the
6835 previous task. To enable this systematically, set @code{org-clock-continuously}
6836 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6837 last clocked entry for this session, and start the new clock from there.
6839 If you only want this from time to time, use three universal prefix arguments
6840 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6842 @node Effort estimates
6843 @section Effort estimates
6844 @cindex effort estimates
6846 @cindex property, Effort
6847 If you want to plan your work in a very detailed way, or if you need to
6848 produce offers with quotations of the estimated work effort, you may want to
6849 assign effort estimates to entries. If you are also clocking your work, you
6850 may later want to compare the planned effort with the actual working time,
6851 a great way to improve planning estimates. Effort estimates are stored in
6852 a special property @code{EFFORT}. You can set the effort for an entry with
6853 the following commands:
6856 @orgcmd{C-c C-x e,org-set-effort}
6857 Set the effort estimate for the current entry. With a numeric prefix
6858 argument, set it to the Nth allowed value (see below). This command is also
6859 accessible from the agenda with the @kbd{e} key.
6860 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6861 Modify the effort estimate of the item currently being clocked.
6864 Clearly the best way to work with effort estimates is through column view
6865 (@pxref{Column view}). You should start by setting up discrete values for
6866 effort estimates, and a @code{COLUMNS} format that displays these values
6867 together with clock sums (if you want to clock your time). For a specific
6871 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6872 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6876 @vindex org-global-properties
6877 @vindex org-columns-default-format
6878 or, even better, you can set up these values globally by customizing the
6879 variables @code{org-global-properties} and @code{org-columns-default-format}.
6880 In particular if you want to use this setup also in the agenda, a global
6881 setup may be advised.
6883 The way to assign estimates to individual items is then to switch to column
6884 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6885 value. The values you enter will immediately be summed up in the hierarchy.
6886 In the column next to it, any clocked time will be displayed.
6888 @vindex org-agenda-columns-add-appointments-to-effort-sum
6889 If you switch to column view in the daily/weekly agenda, the effort column
6890 will summarize the estimated work effort for each day@footnote{Please note
6891 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6892 column view}).}, and you can use this to find space in your schedule. To get
6893 an overview of the entire part of the day that is committed, you can set the
6894 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6895 appointments on a day that take place over a specified time interval will
6896 then also be added to the load estimate of the day.
6898 Effort estimates can be used in secondary agenda filtering that is triggered
6899 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6900 these estimates defined consistently, two or three key presses will narrow
6901 down the list to stuff that fits into an available time slot.
6904 @section Taking notes with a timer
6905 @cindex relative timer
6906 @cindex countdown timer
6909 Org provides two types of timers. There is a relative timer that counts up,
6910 which can be useful when taking notes during, for example, a meeting or
6911 a video viewing. There is also a countdown timer.
6913 The relative and countdown are started with separate commands.
6916 @orgcmd{C-c C-x 0,org-timer-start}
6917 Start or reset the relative timer. By default, the timer is set to 0. When
6918 called with a @kbd{C-u} prefix, prompt the user for a starting offset. If
6919 there is a timer string at point, this is taken as the default, providing a
6920 convenient way to restart taking notes after a break in the process. When
6921 called with a double prefix argument @kbd{C-u C-u}, change all timer strings
6922 in the active region by a certain amount. This can be used to fix timer
6923 strings if the timer was not started at exactly the right moment.
6924 @orgcmd{C-c C-x ;,org-timer-set-timer}
6925 Start a countdown timer. The user is prompted for a duration.
6926 @code{org-timer-default-timer} sets the default countdown value. Giving a
6927 prefix numeric argument overrides this default value. This command is
6928 available as @kbd{;} in agenda buffers.
6931 Once started, relative and countdown timers are controlled with the same
6935 @orgcmd{C-c C-x .,org-timer}
6936 Insert the value of the current relative or countdown timer into the buffer.
6937 If no timer is running, the relative timer will be started. When called with
6938 a prefix argument, the relative timer is restarted.
6939 @orgcmd{C-c C-x -,org-timer-item}
6940 Insert a description list item with the value of the current relative or
6941 countdown timer. With a prefix argument, first reset the relative timer to
6943 @orgcmd{M-@key{RET},org-insert-heading}
6944 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6946 @orgcmd{C-c C-x @comma{},org-timer-pause-or-continue}
6947 Pause the timer, or continue it if it is already paused.
6948 @orgcmd{C-c C-x _,org-timer-stop}
6949 Stop the timer. After this, you can only start a new timer, not continue the
6950 old one. This command also removes the timer from the mode line.
6953 @node Capture - Refile - Archive
6954 @chapter Capture - Refile - Archive
6957 An important part of any organization system is the ability to quickly
6958 capture new ideas and tasks, and to associate reference material with them.
6959 Org does this using a process called @i{capture}. It also can store files
6960 related to a task (@i{attachments}) in a special directory. Once in the
6961 system, tasks and projects need to be moved around. Moving completed project
6962 trees to an archive file keeps the system compact and fast.
6965 * Capture:: Capturing new stuff
6966 * Attachments:: Add files to tasks
6967 * RSS feeds:: Getting input from RSS feeds
6968 * Protocols:: External (e.g., Browser) access to Emacs and Org
6969 * Refile and copy:: Moving/copying a tree from one place to another
6970 * Archiving:: What to do with finished projects
6977 Capture lets you quickly store notes with little interruption of your work
6978 flow. Org's method for capturing new items is heavily inspired by John
6979 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6980 used a special setup for @file{remember.el}, then replaced it with
6981 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6982 been completely replaced by @file{org-capture.el}.
6984 If your configuration depends on @file{org-remember.el}, you need to update
6985 it and use the setup described below. To convert your
6986 @code{org-remember-templates}, run the command
6988 @kbd{M-x org-capture-import-remember-templates RET}
6990 @noindent and then customize the new variable with @kbd{M-x
6991 customize-variable org-capture-templates}, check the result, and save the
6995 * Setting up capture:: Where notes will be stored
6996 * Using capture:: Commands to invoke and terminate capture
6997 * Capture templates:: Define the outline of different note types
7000 @node Setting up capture
7001 @subsection Setting up capture
7003 The following customization sets a default target file for notes, and defines
7004 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
7005 suggestion.} for capturing new material.
7007 @vindex org-default-notes-file
7010 (setq org-default-notes-file (concat org-directory "/notes.org"))
7011 (define-key global-map "\C-cc" 'org-capture)
7016 @subsection Using capture
7019 @orgcmd{C-c c,org-capture}
7020 Call the command @code{org-capture}. Note that this key binding is global and
7021 not active by default: you need to install it. If you have templates
7023 defined @pxref{Capture templates}, it will offer these templates for
7024 selection or use a new Org outline node as the default template. It will
7025 insert the template into the target file and switch to an indirect buffer
7026 narrowed to this new node. You may then insert the information you want.
7028 @orgcmd{C-c C-c,org-capture-finalize}
7029 Once you have finished entering information into the capture buffer, @kbd{C-c
7030 C-c} will return you to the window configuration before the capture process,
7031 so that you can resume your work without further distraction. When called
7032 with a prefix arg, finalize and then jump to the captured item.
7034 @orgcmd{C-c C-w,org-capture-refile}
7035 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
7036 a different place. Please realize that this is a normal refiling command
7037 that will be executed---so the cursor position at the moment you run this
7038 command is important. If you have inserted a tree with a parent and
7039 children, first move the cursor back to the parent. Any prefix argument
7040 given to this command will be passed on to the @code{org-refile} command.
7042 @orgcmd{C-c C-k,org-capture-kill}
7043 Abort the capture process and return to the previous state.
7047 You can also call @code{org-capture} in a special way from the agenda, using
7048 the @kbd{k c} key combination. With this access, any timestamps inserted by
7049 the selected capture template will default to the cursor date in the agenda,
7050 rather than to the current date.
7052 To find the locations of the last stored capture, use @code{org-capture} with
7057 Visit the target location of a capture template. You get to select the
7058 template in the usual way.
7059 @orgkey{C-u C-u C-c c}
7060 Visit the last stored capture item in its buffer.
7063 @vindex org-capture-bookmark
7064 @cindex org-capture-last-stored
7065 You can also jump to the bookmark @code{org-capture-last-stored}, which will
7066 automatically be created unless you set @code{org-capture-bookmark} to
7069 To insert the capture at point in an Org buffer, call @code{org-capture} with
7070 a @code{C-0} prefix argument.
7072 @node Capture templates
7073 @subsection Capture templates
7074 @cindex templates, for Capture
7076 You can use templates for different types of capture items, and
7077 for different target locations. The easiest way to create such templates is
7078 through the customize interface.
7082 Customize the variable @code{org-capture-templates}.
7085 Before we give the formal description of template definitions, let's look at
7086 an example. Say you would like to use one template to create general TODO
7087 entries, and you want to put these entries under the heading @samp{Tasks} in
7088 your file @file{~/org/gtd.org}. Also, a date tree in the file
7089 @file{journal.org} should capture journal entries. A possible configuration
7094 (setq org-capture-templates
7095 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
7096 "* TODO %?\n %i\n %a")
7097 ("j" "Journal" entry (file+datetree "~/org/journal.org")
7098 "* %?\nEntered on %U\n %i\n %a")))
7102 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
7106 [[file:@var{link to where you initiated capture}]]
7110 During expansion of the template, @code{%a} has been replaced by a link to
7111 the location from where you called the capture command. This can be
7112 extremely useful for deriving tasks from emails, for example. You fill in
7113 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7114 place where you started the capture process.
7116 To define special keys to capture to a particular template without going
7117 through the interactive template selection, you can create your key binding
7121 (define-key global-map "\C-cx"
7122 (lambda () (interactive) (org-capture nil "x")))
7126 * Template elements:: What is needed for a complete template entry
7127 * Template expansion:: Filling in information about time and context
7128 * Templates in contexts:: Only show a template in a specific context
7131 @node Template elements
7132 @subsubsection Template elements
7134 Now lets look at the elements of a template definition. Each entry in
7135 @code{org-capture-templates} is a list with the following items:
7139 The keys that will select the template, as a string, characters
7140 only, for example @code{"a"} for a template to be selected with a
7141 single key, or @code{"bt"} for selection with two keys. When using
7142 several keys, keys using the same prefix key must be sequential
7143 in the list and preceded by a 2-element entry explaining the
7144 prefix key, for example
7146 ("b" "Templates for marking stuff to buy")
7148 @noindent If you do not define a template for the @kbd{C} key, this key will
7149 be used to open the customize buffer for this complex variable.
7152 A short string describing the template, which will be shown during
7156 The type of entry, a symbol. Valid values are:
7160 An Org mode node, with a headline. Will be filed as the child of the target
7161 entry or as a top-level entry. The target file should be an Org mode file.
7163 A plain list item, placed in the first plain list at the target
7164 location. Again the target file should be an Org file.
7166 A checkbox item. This only differs from the plain list item by the
7169 a new line in the first table at the target location. Where exactly the
7170 line will be inserted depends on the properties @code{:prepend} and
7171 @code{:table-line-pos} (see below).
7173 Text to be inserted as it is.
7177 @vindex org-default-notes-file
7178 Specification of where the captured item should be placed. In Org mode
7179 files, targets usually define a node. Entries will become children of this
7180 node. Other types will be added to the table or list in the body of this
7181 node. Most target specifications contain a file name. If that file name is
7182 the empty string, it defaults to @code{org-default-notes-file}. A file can
7183 also be given as a variable, function, or Emacs Lisp form. When an absolute
7184 path is not specified for a target, it is taken as relative to
7185 @code{org-directory}.
7190 @item (file "path/to/file")
7191 Text will be placed at the beginning or end of that file.
7193 @item (id "id of existing org entry")
7194 Filing as child of this entry, or in the body of the entry.
7196 @item (file+headline "path/to/file" "node headline")
7197 Fast configuration if the target heading is unique in the file.
7199 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7200 For non-unique headings, the full path is safer.
7202 @item (file+regexp "path/to/file" "regexp to find location")
7203 Use a regular expression to position the cursor.
7205 @item (file+datetree "path/to/file")
7206 Will create a heading in a date tree for today's date@footnote{Datetree
7207 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7208 and @code{* 2013} in your file, the capture will refile the note to the first
7211 @item (file+datetree+prompt "path/to/file")
7212 Will create a heading in a date tree, but will prompt for the date.
7214 @item (file+weektree "path/to/file")
7215 Will create a heading in a week tree for today's date. Week trees are sorted
7216 by week and not by month unlike datetrees.
7218 @item (file+weektree+prompt "path/to/file")
7219 Will create a heading in a week tree, but will prompt for the date.
7221 @item (file+function "path/to/file" function-finding-location)
7222 A function to find the right location in the file.
7225 File to the entry that is currently being clocked.
7227 @item (function function-finding-location)
7228 Most general way: write your own function which both visits
7229 the file and moves point to the right location.
7233 The template for creating the capture item. If you leave this empty, an
7234 appropriate default template will be used. Otherwise this is a string with
7235 escape codes, which will be replaced depending on time and context of the
7236 capture call. The string with escapes may be loaded from a template file,
7237 using the special syntax @code{(file "path/to/template")}. See below for
7241 The rest of the entry is a property list of additional options.
7242 Recognized properties are:
7246 Normally new captured information will be appended at
7247 the target location (last child, last table line, last list item...).
7248 Setting this property will change that.
7250 @item :immediate-finish
7251 When set, do not offer to edit the information, just
7252 file it away immediately. This makes sense if the template only needs
7253 information that can be added automatically.
7256 Set this to the number of lines to insert
7257 before and after the new item. Default 0, only common other value is 1.
7260 Start the clock in this item.
7263 Keep the clock running when filing the captured entry.
7266 If starting the capture interrupted a clock, restart that clock when finished
7267 with the capture. Note that @code{:clock-keep} has precedence over
7268 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7269 run and the previous one will not be resumed.
7272 Do not narrow the target buffer, simply show the full buffer. Default is to
7273 narrow it so that you only see the new material.
7275 @item :table-line-pos
7276 Specification of the location in the table where the new line should be
7277 inserted. It can be a string, a variable holding a string or a function
7278 returning a string. The string should look like @code{"II-3"} meaning that
7279 the new line should become the third line before the second horizontal
7283 If the target file was not yet visited when capture was invoked, kill the
7284 buffer again after capture is completed.
7288 @node Template expansion
7289 @subsubsection Template expansion
7291 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7292 these sequences literally, escape the @kbd{%} with a backslash.} allow
7293 dynamic insertion of content. The templates are expanded in the order given here:
7296 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7297 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7298 @r{For convenience, %:keyword (see below) placeholders}
7299 @r{within the expression will be expanded prior to this.}
7300 @r{The sexp must return a string.}
7301 %<...> @r{The result of format-time-string on the ... format specification.}
7302 %t @r{Timestamp, date only.}
7303 %T @r{Timestamp, with date and time.}
7304 %u, %U @r{Like the above, but inactive timestamps.}
7305 %i @r{Initial content, the region when capture is called while the}
7306 @r{region is active.}
7307 @r{The entire text will be indented like @code{%i} itself.}
7308 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7309 %A @r{Like @code{%a}, but prompt for the description part.}
7310 %l @r{Like %a, but only insert the literal link.}
7311 %c @r{Current kill ring head.}
7312 %x @r{Content of the X clipboard.}
7313 %k @r{Title of the currently clocked task.}
7314 %K @r{Link to the currently clocked task.}
7315 %n @r{User name (taken from @code{user-full-name}).}
7316 %f @r{File visited by current buffer when org-capture was called.}
7317 %F @r{Full path of the file or directory visited by current buffer.}
7318 %:keyword @r{Specific information for certain link types, see below.}
7319 %^g @r{Prompt for tags, with completion on tags in target file.}
7320 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7321 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7322 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7323 %^C @r{Interactive selection of which kill or clip to use.}
7324 %^L @r{Like @code{%^C}, but insert as link.}
7325 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7326 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7327 @r{You may specify a default value and a completion table with}
7328 @r{%^@{prompt|default|completion2|completion3...@}.}
7329 @r{The arrow keys access a prompt-specific history.}
7330 %\\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7331 @r{a number, starting from 1.}
7332 %? @r{After completing the template, position cursor here.}
7336 For specific link types, the following keywords will be
7337 defined@footnote{If you define your own link types (@pxref{Adding
7338 hyperlink types}), any property you store with
7339 @code{org-store-link-props} can be accessed in capture templates in a
7342 @vindex org-from-is-user-regexp
7344 Link type | Available keywords
7345 ---------------------------------+----------------------------------------------
7346 bbdb | %:name %:company
7347 irc | %:server %:port %:nick
7348 vm, vm-imap, wl, mh, mew, rmail, | %:type %:subject %:message-id
7349 gnus, notmuch | %:from %:fromname %:fromaddress
7350 | %:to %:toname %:toaddress
7351 | %:date @r{(message date header field)}
7352 | %:date-timestamp @r{(date as active timestamp)}
7353 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7354 | %: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}.}}
7355 gnus | %:group, @r{for messages also all email fields}
7357 info | %:file %:node
7362 To place the cursor after template expansion use:
7365 %? @r{After completing the template, position cursor here.}
7368 @node Templates in contexts
7369 @subsubsection Templates in contexts
7371 @vindex org-capture-templates-contexts
7372 To control whether a capture template should be accessible from a specific
7373 context, you can customize @code{org-capture-templates-contexts}. Let's say
7374 for example that you have a capture template @code{"p"} for storing Gnus
7375 emails containing patches. Then you would configure this option like this:
7378 (setq org-capture-templates-contexts
7379 '(("p" (in-mode . "message-mode"))))
7382 You can also tell that the command key @code{"p"} should refer to another
7383 template. In that case, add this command key like this:
7386 (setq org-capture-templates-contexts
7387 '(("p" "q" (in-mode . "message-mode"))))
7390 See the docstring of the variable for more information.
7393 @section Attachments
7396 @vindex org-attach-directory
7397 It is often useful to associate reference material with an outline node/task.
7398 Small chunks of plain text can simply be stored in the subtree of a project.
7399 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7400 files that live elsewhere on your computer or in the cloud, like emails or
7401 source code files belonging to a project. Another method is @i{attachments},
7402 which are files located in a directory belonging to an outline node. Org
7403 uses directories named by the unique ID of each entry. These directories are
7404 located in the @file{data} directory which lives in the same directory where
7405 your Org file lives@footnote{If you move entries or Org files from one
7406 directory to another, you may want to configure @code{org-attach-directory}
7407 to contain an absolute path.}. If you initialize this directory with
7408 @code{git init}, Org will automatically commit changes when it sees them.
7409 The attachment system has been contributed to Org by John Wiegley.
7411 In cases where it seems better to do so, you can also attach a directory of your
7412 choice to an entry. You can also make children inherit the attachment
7413 directory from a parent, so that an entire subtree uses the same attached
7416 @noindent The following commands deal with attachments:
7419 @orgcmd{C-c C-a,org-attach}
7420 The dispatcher for commands related to the attachment system. After these
7421 keys, a list of commands is displayed and you must press an additional key
7422 to select a command:
7425 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7426 @vindex org-attach-method
7427 Select a file and move it into the task's attachment directory. The file
7428 will be copied, moved, or linked, depending on @code{org-attach-method}.
7429 Note that hard links are not supported on all systems.
7435 Attach a file using the copy/move/link method.
7436 Note that hard links are not supported on all systems.
7438 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7439 Create a new attachment as an Emacs buffer.
7441 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7442 Synchronize the current task with its attachment directory, in case you added
7443 attachments yourself.
7445 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7446 @vindex org-file-apps
7447 Open current task's attachment. If there is more than one, prompt for a
7448 file name first. Opening will follow the rules set by @code{org-file-apps}.
7449 For more details, see the information on following hyperlinks
7450 (@pxref{Handling links}).
7452 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7453 Also open the attachment, but force opening the file in Emacs.
7455 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7456 Open the current task's attachment directory.
7458 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7459 Also open the directory, but force using @command{dired} in Emacs.
7461 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7462 Select and delete a single attachment.
7464 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7465 Delete all of a task's attachments. A safer way is to open the directory in
7466 @command{dired} and delete from there.
7468 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7469 @cindex property, ATTACH_DIR
7470 Set a specific directory as the entry's attachment directory. This works by
7471 putting the directory path into the @code{ATTACH_DIR} property.
7473 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7474 @cindex property, ATTACH_DIR_INHERIT
7475 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7476 same directory for attachments as the parent does.
7485 Org can add and change entries based on information found in RSS feeds and
7486 Atom feeds. You could use this to make a task out of each new podcast in a
7487 podcast feed. Or you could use a phone-based note-creating service on the
7488 web to import tasks into Org. To access feeds, configure the variable
7489 @code{org-feed-alist}. The docstring of this variable has detailed
7490 information. Here is just an example:
7494 (setq org-feed-alist
7496 "http://rss.slashdot.org/Slashdot/slashdot"
7497 "~/txt/org/feeds.org" "Slashdot Entries")))
7502 will configure that new items from the feed provided by
7503 @code{rss.slashdot.org} will result in new entries in the file
7504 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7505 the following command is used:
7508 @orgcmd{C-c C-x g,org-feed-update-all}
7510 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7512 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7513 Prompt for a feed name and go to the inbox configured for this feed.
7516 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7517 it will store information about the status of items in the feed, to avoid
7518 adding the same item several times.
7520 For more information, including how to read atom feeds, see
7521 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7524 @section Protocols for external access
7525 @cindex protocols, for external access
7528 You can set up Org for handling protocol calls from outside applications that
7529 are passed to Emacs through the @file{emacsserver}. For example, you can
7530 configure bookmarks in your web browser to send a link to the current page to
7531 Org and create a note from it using capture (@pxref{Capture}). Or you
7532 could create a bookmark that will tell Emacs to open the local source file of
7533 a remote website you are looking at with the browser. See
7534 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7535 documentation and setup instructions.
7537 @node Refile and copy
7538 @section Refile and copy
7539 @cindex refiling notes
7540 @cindex copying notes
7542 When reviewing the captured data, you may want to refile or to copy some of
7543 the entries into a different list, for example into a project. Cutting,
7544 finding the right location, and then pasting the note is cumbersome. To
7545 simplify this process, you can use the following special command:
7548 @orgcmd{C-c M-w,org-copy}
7550 Copying works like refiling, except that the original note is not deleted.
7551 @orgcmd{C-c C-w,org-refile}
7553 @vindex org-reverse-note-order
7554 @vindex org-refile-targets
7555 @vindex org-refile-use-outline-path
7556 @vindex org-outline-path-complete-in-steps
7557 @vindex org-refile-allow-creating-parent-nodes
7558 @vindex org-log-refile
7559 @vindex org-refile-use-cache
7560 @vindex org-refile-keep
7561 Refile the entry or region at point. This command offers possible locations
7562 for refiling the entry and lets you select one with completion. The item (or
7563 all items in the region) is filed below the target heading as a subitem.
7564 Depending on @code{org-reverse-note-order}, it will be either the first or
7566 By default, all level 1 headlines in the current buffer are considered to be
7567 targets, but you can have more complex definitions across a number of files.
7568 See the variable @code{org-refile-targets} for details. If you would like to
7569 select a location via a file-path-like completion along the outline path, see
7570 the variables @code{org-refile-use-outline-path} and
7571 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7572 create new nodes as new parents for refiling on the fly, check the
7573 variable @code{org-refile-allow-creating-parent-nodes}.
7574 When the variable @code{org-log-refile}@footnote{with corresponding
7575 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7576 and @code{nologrefile}} is set, a timestamp or a note will be
7577 recorded when an entry has been refiled.
7578 @orgkey{C-u C-c C-w}
7579 Use the refile interface to jump to a heading.
7580 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7581 Jump to the location where @code{org-refile} last moved a tree to.
7583 Refile as the child of the item currently being clocked.
7585 Refile and keep the entry in place. Also see @code{org-refile-keep} to make
7586 this the default behavior, and beware that this may result in duplicated
7587 @code{ID} properties.
7588 @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}
7589 Clear the target cache. Caching of refile targets can be turned on by
7590 setting @code{org-refile-use-cache}. To make the command see new possible
7591 targets, you have to clear the cache with this command.
7598 When a project represented by a (sub)tree is finished, you may want
7599 to move the tree out of the way and to stop it from contributing to the
7600 agenda. Archiving is important to keep your working files compact and global
7601 searches like the construction of agenda views fast.
7604 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7605 @vindex org-archive-default-command
7606 Archive the current entry using the command specified in the variable
7607 @code{org-archive-default-command}.
7611 * Moving subtrees:: Moving a tree to an archive file
7612 * Internal archiving:: Switch off a tree but keep it in the file
7615 @node Moving subtrees
7616 @subsection Moving a tree to the archive file
7617 @cindex external archiving
7619 The most common archiving action is to move a project tree to another file,
7623 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7624 @vindex org-archive-location
7625 Archive the subtree starting at the cursor position to the location
7626 given by @code{org-archive-location}.
7627 @orgkey{C-u C-c C-x C-s}
7628 Check if any direct children of the current headline could be moved to
7629 the archive. To do this, each subtree is checked for open TODO entries.
7630 If none are found, the command offers to move it to the archive
7631 location. If the cursor is @emph{not} on a headline when this command
7632 is invoked, the level 1 trees will be checked.
7633 @orgkey{C-u C-u C-c C-x C-s}
7634 As above, but check subtree for timestamps instead of TODO entries. The
7635 command will offer to archive the subtree if it @emph{does} contain a
7636 timestamp, and that timestamp is in the past.
7639 @cindex archive locations
7640 The default archive location is a file in the same directory as the
7641 current file, with the name derived by appending @file{_archive} to the
7642 current file name. You can also choose what heading to file archived
7643 items under, with the possibility to add them to a datetree in a file.
7644 For information and examples on how to specify the file and the heading,
7645 see the documentation string of the variable
7646 @code{org-archive-location}.
7648 There is also an in-buffer option for setting this variable, for example:
7652 #+ARCHIVE: %s_done::
7655 @cindex property, ARCHIVE
7657 If you would like to have a special ARCHIVE location for a single entry
7658 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7659 location as the value (@pxref{Properties and columns}).
7661 @vindex org-archive-save-context-info
7662 When a subtree is moved, it receives a number of special properties that
7663 record context information like the file from where the entry came, its
7664 outline path the archiving time etc. Configure the variable
7665 @code{org-archive-save-context-info} to adjust the amount of information
7669 @node Internal archiving
7670 @subsection Internal archiving
7672 If you want to just switch off (for agenda views) certain subtrees without
7673 moving them to a different file, you can use the @code{ARCHIVE tag}.
7675 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7676 its location in the outline tree, but behaves in the following way:
7679 @vindex org-cycle-open-archived-trees
7680 It does not open when you attempt to do so with a visibility cycling
7681 command (@pxref{Visibility cycling}). You can force cycling archived
7682 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7683 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7684 @code{show-all} will open archived subtrees.
7686 @vindex org-sparse-tree-open-archived-trees
7687 During sparse tree construction (@pxref{Sparse trees}), matches in
7688 archived subtrees are not exposed, unless you configure the option
7689 @code{org-sparse-tree-open-archived-trees}.
7691 @vindex org-agenda-skip-archived-trees
7692 During agenda view construction (@pxref{Agenda views}), the content of
7693 archived trees is ignored unless you configure the option
7694 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7695 be included. In the agenda you can press @kbd{v a} to get archives
7696 temporarily included.
7698 @vindex org-export-with-archived-trees
7699 Archived trees are not exported (@pxref{Exporting}), only the headline
7700 is. Configure the details using the variable
7701 @code{org-export-with-archived-trees}.
7703 @vindex org-columns-skip-archived-trees
7704 Archived trees are excluded from column view unless the variable
7705 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7708 The following commands help manage the ARCHIVE tag:
7711 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7712 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7713 the headline changes to a shadowed face, and the subtree below it is
7715 @orgkey{C-u C-c C-x a}
7716 Check if any direct children of the current headline should be archived.
7717 To do this, each subtree is checked for open TODO entries. If none are
7718 found, the command offers to set the ARCHIVE tag for the child. If the
7719 cursor is @emph{not} on a headline when this command is invoked, the
7720 level 1 trees will be checked.
7721 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7722 Cycle a tree even if it is tagged with ARCHIVE.
7723 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7724 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7725 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7726 entry becomes a child of that sibling and in this way retains a lot of its
7727 original context, including inherited tags and approximate position in the
7733 @chapter Agenda views
7734 @cindex agenda views
7736 Due to the way Org works, TODO items, time-stamped items, and
7737 tagged headlines can be scattered throughout a file or even a number of
7738 files. To get an overview of open action items, or of events that are
7739 important for a particular date, this information must be collected,
7740 sorted and displayed in an organized way.
7742 Org can select items based on various criteria and display them
7743 in a separate buffer. Seven different view types are provided:
7747 an @emph{agenda} that is like a calendar and shows information
7750 a @emph{TODO list} that covers all unfinished
7753 a @emph{match view}, showings headlines based on the tags, properties, and
7754 TODO state associated with them,
7756 a @emph{timeline view} that shows all events in a single Org file,
7757 in time-sorted view,
7759 a @emph{text search view} that shows all entries from multiple files
7760 that contain specified keywords,
7762 a @emph{stuck projects view} showing projects that currently don't move
7765 @emph{custom views} that are special searches and combinations of different
7770 The extracted information is displayed in a special @emph{agenda
7771 buffer}. This buffer is read-only, but provides commands to visit the
7772 corresponding locations in the original Org files, and even to
7773 edit these files remotely.
7775 @vindex org-agenda-window-setup
7776 @vindex org-agenda-restore-windows-after-quit
7777 Two variables control how the agenda buffer is displayed and whether the
7778 window configuration is restored when the agenda exits:
7779 @code{org-agenda-window-setup} and
7780 @code{org-agenda-restore-windows-after-quit}.
7783 * Agenda files:: Files being searched for agenda information
7784 * Agenda dispatcher:: Keyboard access to agenda views
7785 * Built-in agenda views:: What is available out of the box?
7786 * Presentation and sorting:: How agenda items are prepared for display
7787 * Agenda commands:: Remote editing of Org trees
7788 * Custom agenda views:: Defining special searches and views
7789 * Exporting agenda views:: Writing a view to a file
7790 * Agenda column view:: Using column view for collected entries
7794 @section Agenda files
7795 @cindex agenda files
7796 @cindex files for agenda
7798 @vindex org-agenda-files
7799 The information to be shown is normally collected from all @emph{agenda
7800 files}, the files listed in the variable
7801 @code{org-agenda-files}@footnote{If the value of that variable is not a
7802 list, but a single file name, then the list of agenda files will be
7803 maintained in that external file.}. If a directory is part of this list,
7804 all files with the extension @file{.org} in this directory will be part
7807 Thus, even if you only work with a single Org file, that file should
7808 be put into the list@footnote{When using the dispatcher, pressing
7809 @kbd{<} before selecting a command will actually limit the command to
7810 the current file, and ignore @code{org-agenda-files} until the next
7811 dispatcher command.}. You can customize @code{org-agenda-files}, but
7812 the easiest way to maintain it is through the following commands
7814 @cindex files, adding to agenda list
7816 @orgcmd{C-c [,org-agenda-file-to-front}
7817 Add current file to the list of agenda files. The file is added to
7818 the front of the list. If it was already in the list, it is moved to
7819 the front. With a prefix argument, file is added/moved to the end.
7820 @orgcmd{C-c ],org-remove-file}
7821 Remove current file from the list of agenda files.
7823 @cindex cycling, of agenda files
7824 @orgcmd{C-',org-cycle-agenda-files}
7826 Cycle through agenda file list, visiting one file after the other.
7827 @kindex M-x org-iswitchb
7828 @item M-x org-iswitchb RET
7829 Command to use an @code{iswitchb}-like interface to switch to and between Org
7834 The Org menu contains the current list of files and can be used
7835 to visit any of them.
7837 If you would like to focus the agenda temporarily on a file not in
7838 this list, or on just one file in the list, or even on only a subtree in a
7839 file, then this can be done in different ways. For a single agenda command,
7840 you may press @kbd{<} once or several times in the dispatcher
7841 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7842 extended period, use the following commands:
7845 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7846 Permanently restrict the agenda to the current subtree. When with a
7847 prefix argument, or with the cursor before the first headline in a file,
7848 the agenda scope is set to the entire file. This restriction remains in
7849 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7850 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7851 agenda view, the new restriction takes effect immediately.
7852 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7853 Remove the permanent restriction created by @kbd{C-c C-x <}.
7857 When working with @file{speedbar.el}, you can use the following commands in
7861 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7862 Permanently restrict the agenda to the item---either an Org file or a subtree
7863 in such a file---at the cursor in the Speedbar frame.
7864 If there is a window displaying an agenda view, the new restriction takes
7866 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7867 Lift the restriction.
7870 @node Agenda dispatcher
7871 @section The agenda dispatcher
7872 @cindex agenda dispatcher
7873 @cindex dispatching agenda commands
7874 The views are created through a dispatcher, which should be bound to a
7875 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7876 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7877 is accessed and list keyboard access to commands accordingly. After
7878 pressing @kbd{C-c a}, an additional letter is required to execute a
7879 command. The dispatcher offers the following default commands:
7883 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7885 Create a list of all TODO items (@pxref{Global TODO list}).
7887 Create a list of headlines matching a TAGS expression (@pxref{Matching
7888 tags and properties}).
7890 Create the timeline view for the current buffer (@pxref{Timeline}).
7892 Create a list of entries selected by a boolean expression of keywords
7893 and/or regular expressions that must or must not occur in the entry.
7895 @vindex org-agenda-text-search-extra-files
7896 Search for a regular expression in all agenda files and additionally in
7897 the files listed in @code{org-agenda-text-search-extra-files}. This
7898 uses the Emacs command @code{multi-occur}. A prefix argument can be
7899 used to specify the number of context lines for each match, default is
7902 Create a list of stuck projects (@pxref{Stuck projects}).
7904 Restrict an agenda command to the current buffer@footnote{For backward
7905 compatibility, you can also press @kbd{1} to restrict to the current
7906 buffer.}. After pressing @kbd{<}, you still need to press the character
7907 selecting the command.
7909 If there is an active region, restrict the following agenda command to
7910 the region. Otherwise, restrict it to the current subtree@footnote{For
7911 backward compatibility, you can also press @kbd{0} to restrict to the
7912 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7913 character selecting the command.
7916 @cindex agenda, sticky
7917 @vindex org-agenda-sticky
7918 Toggle sticky agenda views. By default, Org maintains only a single agenda
7919 buffer and rebuilds it each time you change the view, to make sure everything
7920 is always up to date. If you often switch between agenda views and the build
7921 time bothers you, you can turn on sticky agenda buffers or make this the
7922 default by customizing the variable @code{org-agenda-sticky}. With sticky
7923 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7924 it will only switch to the selected one, and you need to update the agenda by
7925 hand with @kbd{r} or @kbd{g} when needed. You can toggle sticky agenda view
7926 any time with @code{org-toggle-sticky-agenda}.
7929 You can also define custom commands that will be accessible through the
7930 dispatcher, just like the default commands. This includes the
7931 possibility to create extended agenda buffers that contain several
7932 blocks together, for example the weekly agenda, the global TODO list and
7933 a number of special tags matches. @xref{Custom agenda views}.
7935 @node Built-in agenda views
7936 @section The built-in agenda views
7938 In this section we describe the built-in views.
7941 * Weekly/daily agenda:: The calendar page with current tasks
7942 * Global TODO list:: All unfinished action items
7943 * Matching tags and properties:: Structured information with fine-tuned search
7944 * Timeline:: Time-sorted view for single file
7945 * Search view:: Find entries by searching for text
7946 * Stuck projects:: Find projects you need to review
7949 @node Weekly/daily agenda
7950 @subsection The weekly/daily agenda
7952 @cindex weekly agenda
7953 @cindex daily agenda
7955 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7956 paper agenda, showing all the tasks for the current week or day.
7959 @cindex org-agenda, command
7960 @orgcmd{C-c a a,org-agenda-list}
7961 Compile an agenda for the current week from a list of Org files. The agenda
7962 shows the entries for each day. With a numeric prefix@footnote{For backward
7963 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7964 listed before the agenda. This feature is deprecated, use the dedicated TODO
7965 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7966 C-c a a}) you may set the number of days to be displayed.
7969 @vindex org-agenda-span
7970 @vindex org-agenda-ndays
7971 @vindex org-agenda-start-day
7972 @vindex org-agenda-start-on-weekday
7973 The default number of days displayed in the agenda is set by the variable
7974 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7975 variable can be set to any number of days you want to see by default in the
7976 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7977 @code{year}. For weekly agendas, the default is to start on the previous
7978 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7979 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7980 start the agenda ten days from today in the future.
7982 Remote editing from the agenda buffer means, for example, that you can
7983 change the dates of deadlines and appointments from the agenda buffer.
7984 The commands available in the Agenda buffer are listed in @ref{Agenda
7987 @subsubheading Calendar/Diary integration
7988 @cindex calendar integration
7989 @cindex diary integration
7991 Emacs contains the calendar and diary by Edward M. Reingold. The
7992 calendar displays a three-month calendar with holidays from different
7993 countries and cultures. The diary allows you to keep track of
7994 anniversaries, lunar phases, sunrise/set, recurrent appointments
7995 (weekly, monthly) and more. In this way, it is quite complementary to
7996 Org. It can be very useful to combine output from Org with
7999 In order to include entries from the Emacs diary into Org mode's
8000 agenda, you only need to customize the variable
8003 (setq org-agenda-include-diary t)
8006 @noindent After that, everything will happen automatically. All diary
8007 entries including holidays, anniversaries, etc., will be included in the
8008 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
8009 @key{RET} can be used from the agenda buffer to jump to the diary
8010 file in order to edit existing diary entries. The @kbd{i} command to
8011 insert new entries for the current date works in the agenda buffer, as
8012 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
8013 Sunrise/Sunset times, show lunar phases and to convert to other
8014 calendars, respectively. @kbd{c} can be used to switch back and forth
8015 between calendar and agenda.
8017 If you are using the diary only for sexp entries and holidays, it is
8018 faster to not use the above setting, but instead to copy or even move
8019 the entries into an Org file. Org mode evaluates diary-style sexp
8020 entries, and does it faster because there is no overhead for first
8021 creating the diary display. Note that the sexp entries must start at
8022 the left margin, no whitespace is allowed before them. For example,
8023 the following segment of an Org file will be processed and entries
8024 will be made in the agenda:
8031 %%(org-calendar-holiday) ; special function for holiday names
8037 %%(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
8038 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
8041 @subsubheading Anniversaries from BBDB
8042 @cindex BBDB, anniversaries
8043 @cindex anniversaries, from BBDB
8045 If you are using the Big Brothers Database to store your contacts, you will
8046 very likely prefer to store anniversaries in BBDB rather than in a
8047 separate Org or diary file. Org supports this and will show BBDB
8048 anniversaries as part of the agenda. All you need to do is to add the
8049 following to one of your agenda files:
8056 %%(org-bbdb-anniversaries)
8059 You can then go ahead and define anniversaries for a BBDB record. Basically,
8060 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
8061 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
8062 followed by a space and the class of the anniversary (@samp{birthday} or
8063 @samp{wedding}, or a format string). If you omit the class, it will default to
8064 @samp{birthday}. Here are a few examples, the header for the file
8065 @file{org-bbdb.el} contains more detailed information.
8071 2008-04-14 %s released version 6.01 of org mode, %d years ago
8074 After a change to BBDB, or for the first agenda display during an Emacs
8075 session, the agenda display will suffer a short delay as Org updates its
8076 hash with anniversaries. However, from then on things will be very fast---much
8077 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
8078 in an Org or Diary file.
8080 If you would like to see upcoming anniversaries with a bit of forewarning,
8081 you can use the following instead:
8088 %%(org-bbdb-anniversaries-future 3)
8091 That will give you three days' warning: on the anniversary date itself and the
8092 two days prior. The argument is optional: if omitted, it defaults to 7.
8094 @subsubheading Appointment reminders
8095 @cindex @file{appt.el}
8096 @cindex appointment reminders
8100 Org can interact with Emacs appointments notification facility. To add the
8101 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
8102 This command lets you filter through the list of your appointments and add
8103 only those belonging to a specific category or matching a regular expression.
8104 It also reads a @code{APPT_WARNTIME} property which will then override the
8105 value of @code{appt-message-warning-time} for this appointment. See the
8106 docstring for details.
8108 @node Global TODO list
8109 @subsection The global TODO list
8110 @cindex global TODO list
8111 @cindex TODO list, global
8113 The global TODO list contains all unfinished TODO items formatted and
8114 collected into a single place.
8117 @orgcmd{C-c a t,org-todo-list}
8118 Show the global TODO list. This collects the TODO items from all agenda
8119 files (@pxref{Agenda views}) into a single buffer. By default, this lists
8120 items with a state the is not a DONE state. The buffer is in
8121 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
8122 entries directly from that buffer (@pxref{Agenda commands}).
8123 @orgcmd{C-c a T,org-todo-list}
8124 @cindex TODO keyword matching
8125 @vindex org-todo-keywords
8126 Like the above, but allows selection of a specific TODO keyword. You can
8127 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
8128 prompted for a keyword, and you may also specify several keywords by
8129 separating them with @samp{|} as the boolean OR operator. With a numeric
8130 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
8132 The @kbd{r} key in the agenda buffer regenerates it, and you can give
8133 a prefix argument to this command to change the selected TODO keyword,
8134 for example @kbd{3 r}. If you often need a search for a specific
8135 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
8136 Matching specific TODO keywords can also be done as part of a tags
8137 search (@pxref{Tag searches}).
8140 Remote editing of TODO items means that you can change the state of a
8141 TODO entry with a single key press. The commands available in the
8142 TODO list are described in @ref{Agenda commands}.
8144 @cindex sublevels, inclusion into TODO list
8145 Normally the global TODO list simply shows all headlines with TODO
8146 keywords. This list can become very long. There are two ways to keep
8150 @vindex org-agenda-todo-ignore-scheduled
8151 @vindex org-agenda-todo-ignore-deadlines
8152 @vindex org-agenda-todo-ignore-timestamp
8153 @vindex org-agenda-todo-ignore-with-date
8154 Some people view a TODO item that has been @emph{scheduled} for execution or
8155 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8156 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8157 @code{org-agenda-todo-ignore-deadlines},
8158 @code{org-agenda-todo-ignore-timestamp} and/or
8159 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8162 @vindex org-agenda-todo-list-sublevels
8163 TODO items may have sublevels to break up the task into subtasks. In
8164 such cases it may be enough to list only the highest level TODO headline
8165 and omit the sublevels from the global list. Configure the variable
8166 @code{org-agenda-todo-list-sublevels} to get this behavior.
8169 @node Matching tags and properties
8170 @subsection Matching tags and properties
8171 @cindex matching, of tags
8172 @cindex matching, of properties
8176 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8177 or have properties (@pxref{Properties and columns}), you can select headlines
8178 based on this metadata and collect them into an agenda buffer. The match
8179 syntax described here also applies when creating sparse trees with @kbd{C-c /
8183 @orgcmd{C-c a m,org-tags-view}
8184 Produce a list of all headlines that match a given set of tags. The
8185 command prompts for a selection criterion, which is a boolean logic
8186 expression with tags, like @samp{+work+urgent-withboss} or
8187 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
8188 define a custom command for it (@pxref{Agenda dispatcher}).
8189 @orgcmd{C-c a M,org-tags-view}
8190 @vindex org-tags-match-list-sublevels
8191 @vindex org-agenda-tags-todo-honor-ignore-options
8192 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8193 not-DONE state and force checking subitems (see variable
8194 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
8195 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
8196 specific TODO keywords together with a tags match is also possible, see
8200 The commands available in the tags list are described in @ref{Agenda
8203 @subsubheading Match syntax
8205 @cindex Boolean logic, for tag/property searches
8206 A search string can use Boolean operators @samp{&} for @code{AND} and
8207 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8208 Parentheses are not implemented. Each element in the search is either a
8209 tag, a regular expression matching tags, or an expression like
8210 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8211 property value. Each element may be preceded by @samp{-}, to select
8212 against it, and @samp{+} is syntactic sugar for positive selection. The
8213 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8214 present. Here are some examples, using only tags.
8218 Select headlines tagged @samp{:work:}.
8220 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8222 Select headlines tagged @samp{:work:}, but discard those also tagged
8225 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8226 @item work|laptop+night
8227 Like before, but require the @samp{:laptop:} lines to be tagged also
8231 @cindex regular expressions, with tags search
8232 Instead of a tag, you may also specify a regular expression enclosed in curly
8233 braces. For example,
8234 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8235 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8237 @cindex group tags, as regular expressions
8238 Group tags (@pxref{Tag hierarchy}) are expanded as regular expressions. E.g.,
8239 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8240 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8241 and searching for @samp{-work} will search for all headlines but those with
8242 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8244 @cindex TODO keyword matching, with tags search
8245 @cindex level, require for tags/property match
8246 @cindex category, require for tags/property match
8247 @vindex org-odd-levels-only
8248 You may also test for properties (@pxref{Properties and columns}) at the same
8249 time as matching tags. The properties may be real properties, or special
8250 properties that represent other metadata (@pxref{Special properties}). For
8251 example, the ``property'' @code{TODO} represents the TODO keyword of the
8252 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8255 In addition to the @ref{Special properties}, one other ``property'' can also
8256 be used. @code{LEVEL} represents the level of an entry. So a search
8257 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8258 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8259 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8260 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8262 Here are more examples:
8265 @item work+TODO="WAITING"
8266 Select @samp{:work:}-tagged TODO lines with the specific TODO
8267 keyword @samp{WAITING}.
8268 @item work+TODO="WAITING"|home+TODO="WAITING"
8269 Waiting tasks both at work and at home.
8272 When matching properties, a number of different operators can be used to test
8273 the value of a property. Here is a complex example:
8276 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8277 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8281 The type of comparison will depend on how the comparison value is written:
8284 If the comparison value is a plain number, a numerical comparison is done,
8285 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8286 @samp{>=}, and @samp{<>}.
8288 If the comparison value is enclosed in double-quotes,
8289 a string comparison is done, and the same operators are allowed.
8291 If the comparison value is enclosed in double-quotes @emph{and} angular
8292 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8293 assumed to be date/time specifications in the standard Org way, and the
8294 comparison will be done accordingly. Special values that will be recognized
8295 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8296 @code{"<tomorrow>"} for these days at 00:00 hours, i.e., without a time
8297 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8298 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8299 respectively, can be used.
8301 If the comparison value is enclosed
8302 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8303 regexp matches the property value, and @samp{<>} meaning that it does not
8307 So the search string in the example finds entries tagged @samp{:work:} but
8308 not @samp{:boss:}, which also have a priority value @samp{A}, a
8309 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8310 property that is numerically smaller than 2, a @samp{:With:} property that is
8311 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8312 on or after October 11, 2008.
8314 You can configure Org mode to use property inheritance during a search, but
8315 beware that this can slow down searches considerably. See @ref{Property
8316 inheritance}, for details.
8318 For backward compatibility, and also for typing speed, there is also a
8319 different way to test TODO states in a search. For this, terminate the
8320 tags/property part of the search string (which may include several terms
8321 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8322 expression just for TODO keywords. The syntax is then similar to that for
8323 tags, but should be applied with care: for example, a positive selection on
8324 several TODO keywords cannot meaningfully be combined with boolean AND@.
8325 However, @emph{negative selection} combined with AND can be meaningful. To
8326 make sure that only lines are checked that actually have any TODO keyword
8327 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8328 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8329 not match TODO keywords in a DONE state. Examples:
8333 Same as @samp{work+TODO="WAITING"}
8334 @item work/!-WAITING-NEXT
8335 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8337 @item work/!+WAITING|+NEXT
8338 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8343 @subsection Timeline for a single file
8344 @cindex timeline, single file
8345 @cindex time-sorted view
8347 The timeline summarizes all time-stamped items from a single Org mode
8348 file in a @emph{time-sorted view}. The main purpose of this command is
8349 to give an overview over events in a project.
8352 @orgcmd{C-c a L,org-timeline}
8353 Show a time-sorted view of the Org file, with all time-stamped items.
8354 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8355 (scheduled or not) are also listed under the current date.
8359 The commands available in the timeline buffer are listed in
8360 @ref{Agenda commands}.
8363 @subsection Search view
8366 @cindex searching, for text
8368 This agenda view is a general text search facility for Org mode entries.
8369 It is particularly useful to find notes.
8372 @orgcmd{C-c a s,org-search-view}
8373 This is a special search that lets you select entries by matching a substring
8374 or specific words using a boolean logic.
8376 For example, the search string @samp{computer equipment} will find entries
8377 that contain @samp{computer equipment} as a substring. If the two words are
8378 separated by more space or a line break, the search will still match.
8379 Search view can also search for specific keywords in the entry, using Boolean
8380 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8381 will search for note entries that contain the keywords @code{computer}
8382 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8383 not matched by the regular expression @code{8\.11[bg]}, meaning to
8384 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8385 word search, other @samp{+} characters are optional. For more details, see
8386 the docstring of the command @code{org-search-view}.
8388 @vindex org-agenda-text-search-extra-files
8389 Note that in addition to the agenda files, this command will also search
8390 the files listed in @code{org-agenda-text-search-extra-files}.
8392 @node Stuck projects
8393 @subsection Stuck projects
8394 @pindex GTD, Getting Things Done
8396 If you are following a system like David Allen's GTD to organize your
8397 work, one of the ``duties'' you have is a regular review to make sure
8398 that all projects move along. A @emph{stuck} project is a project that
8399 has no defined next actions, so it will never show up in the TODO lists
8400 Org mode produces. During the review, you need to identify such
8401 projects and define next actions for them.
8404 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8405 List projects that are stuck.
8408 @vindex org-stuck-projects
8409 Customize the variable @code{org-stuck-projects} to define what a stuck
8410 project is and how to find it.
8413 You almost certainly will have to configure this view before it will
8414 work for you. The built-in default assumes that all your projects are
8415 level-2 headlines, and that a project is not stuck if it has at least
8416 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8418 Let's assume that you, in your own way of using Org mode, identify
8419 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8420 indicate a project that should not be considered yet. Let's further
8421 assume that the TODO keyword DONE marks finished projects, and that NEXT
8422 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8423 is a next action even without the NEXT tag. Finally, if the project
8424 contains the special word IGNORE anywhere, it should not be listed
8425 either. In this case you would start by identifying eligible projects
8426 with a tags/todo match@footnote{@xref{Tag searches}.}
8427 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8428 IGNORE in the subtree to identify projects that are not stuck. The
8429 correct customization for this is
8432 (setq org-stuck-projects
8433 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8437 Note that if a project is identified as non-stuck, the subtree of this entry
8438 will still be searched for stuck projects.
8440 @node Presentation and sorting
8441 @section Presentation and sorting
8442 @cindex presentation, of agenda items
8444 @vindex org-agenda-prefix-format
8445 @vindex org-agenda-tags-column
8446 Before displaying items in an agenda view, Org mode visually prepares the
8447 items and sorts them. Each item occupies a single line. The line starts
8448 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8449 of the item and other important information. You can customize in which
8450 column tags will be displayed through @code{org-agenda-tags-column}. You can
8451 also customize the prefix using the option @code{org-agenda-prefix-format}.
8452 This prefix is followed by a cleaned-up version of the outline headline
8453 associated with the item.
8456 * Categories:: Not all tasks are equal
8457 * Time-of-day specifications:: How the agenda knows the time
8458 * Sorting agenda items:: The order of things
8459 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8463 @subsection Categories
8467 The category is a broad label assigned to each agenda item. By default, the
8468 category is simply derived from the file name, but you can also specify it
8469 with a special line in the buffer, like this:
8476 @cindex property, CATEGORY
8477 If you would like to have a special CATEGORY for a single entry or a
8478 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8479 special category you want to apply as the value.
8482 The display in the agenda buffer looks best if the category is not
8483 longer than 10 characters.
8486 You can set up icons for category by customizing the
8487 @code{org-agenda-category-icon-alist} variable.
8489 @node Time-of-day specifications
8490 @subsection Time-of-day specifications
8491 @cindex time-of-day specification
8493 Org mode checks each agenda item for a time-of-day specification. The
8494 time can be part of the timestamp that triggered inclusion into the
8495 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8496 ranges can be specified with two timestamps, like
8498 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8500 In the headline of the entry itself, a time(range) may also appear as
8501 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8502 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8503 specifications in diary entries are recognized as well.
8505 For agenda display, Org mode extracts the time and displays it in a
8506 standard 24 hour format as part of the prefix. The example times in
8507 the previous paragraphs would end up in the agenda like this:
8510 8:30-13:00 Arthur Dent lies in front of the bulldozer
8511 12:45...... Ford Prefect arrives and takes Arthur to the pub
8512 19:00...... The Vogon reads his poem
8513 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8517 If the agenda is in single-day mode, or for the display of today, the
8518 timed entries are embedded in a time grid, like
8521 8:00...... ------------------
8522 8:30-13:00 Arthur Dent lies in front of the bulldozer
8523 10:00...... ------------------
8524 12:00...... ------------------
8525 12:45...... Ford Prefect arrives and takes Arthur to the pub
8526 14:00...... ------------------
8527 16:00...... ------------------
8528 18:00...... ------------------
8529 19:00...... The Vogon reads his poem
8530 20:00...... ------------------
8531 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8534 @vindex org-agenda-use-time-grid
8535 @vindex org-agenda-time-grid
8536 The time grid can be turned on and off with the variable
8537 @code{org-agenda-use-time-grid}, and can be configured with
8538 @code{org-agenda-time-grid}.
8540 @node Sorting agenda items
8541 @subsection Sorting agenda items
8542 @cindex sorting, of agenda items
8543 @cindex priorities, of agenda items
8544 Before being inserted into a view, the items are sorted. How this is
8545 done depends on the type of view.
8548 @vindex org-agenda-files
8549 For the daily/weekly agenda, the items for each day are sorted. The
8550 default order is to first collect all items containing an explicit
8551 time-of-day specification. These entries will be shown at the beginning
8552 of the list, as a @emph{schedule} for the day. After that, items remain
8553 grouped in categories, in the sequence given by @code{org-agenda-files}.
8554 Within each category, items are sorted by priority (@pxref{Priorities}),
8555 which is composed of the base priority (2000 for priority @samp{A}, 1000
8556 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8557 overdue scheduled or deadline items.
8559 For the TODO list, items remain in the order of categories, but within
8560 each category, sorting takes place according to priority
8561 (@pxref{Priorities}). The priority used for sorting derives from the
8562 priority cookie, with additions depending on how close an item is to its due
8565 For tags matches, items are not sorted at all, but just appear in the
8566 sequence in which they are found in the agenda files.
8569 @vindex org-agenda-sorting-strategy
8570 Sorting can be customized using the variable
8571 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8572 the estimated effort of an entry (@pxref{Effort estimates}).
8574 @node Filtering/limiting agenda items
8575 @subsection Filtering/limiting agenda items
8577 Agenda built-in or customized commands are statically defined. Agenda
8578 filters and limits provide two ways of dynamically narrowing down the list of
8579 agenda entries: @emph{filters} and @emph{limits}. Filters only act on the
8580 display of the items, while limits take effect before the list of agenda
8581 entries is built. Filters are more often used interactively, while limits are
8582 mostly useful when defined as local variables within custom agenda commands.
8584 @subsubheading Filtering in the agenda
8585 @cindex filtering, by tag, category, top headline and effort, in agenda
8586 @cindex tag filtering, in agenda
8587 @cindex category filtering, in agenda
8588 @cindex top headline filtering, in agenda
8589 @cindex effort filtering, in agenda
8590 @cindex query editing, in agenda
8593 @orgcmd{/,org-agenda-filter-by-tag}
8594 @vindex org-agenda-tag-filter-preset
8595 Filter the agenda view with respect to a tag and/or effort estimates. The
8596 difference between this and a custom agenda command is that filtering is very
8597 fast, so that you can switch quickly between different filters without having
8598 to recreate the agenda.@footnote{Custom commands can preset a filter by
8599 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8600 filter will then be applied to the view and persist as a basic filter through
8601 refreshes and more secondary filtering. The filter is a global property of
8602 the entire agenda view---in a block agenda, you should only set this in the
8603 global options section, not in the section of an individual block.}
8605 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8606 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8607 tag (including any tags that do not have a selection character). The command
8608 then hides all entries that do not contain or inherit this tag. When called
8609 with prefix arg, remove the entries that @emph{do} have the tag. A second
8610 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8611 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8612 will be narrowed by requiring or forbidding the selected additional tag.
8613 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8614 immediately use the @kbd{\} command.
8616 Org also supports automatic, context-aware tag filtering. If the variable
8617 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8618 that function can decide which tags should be excluded from the agenda
8619 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8620 as a sub-option key and runs the auto exclusion logic. For example, let's
8621 say you use a @code{Net} tag to identify tasks which need network access, an
8622 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8623 calls. You could auto-exclude these tags based on the availability of the
8624 Internet, and outside of business hours, with something like this:
8628 (defun org-my-auto-exclude-function (tag)
8630 ((string= tag "Net")
8631 (/= 0 (call-process "/sbin/ping" nil nil nil
8632 "-c1" "-q" "-t1" "mail.gnu.org")))
8633 ((or (string= tag "Errand") (string= tag "Call"))
8634 (let ((hour (nth 2 (decode-time))))
8635 (or (< hour 8) (> hour 21)))))
8638 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8649 @item @r{in} search view
8650 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8651 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8652 add a positive search term prefixed by @samp{+}, indicating that this search
8653 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8654 negative search term which @i{must not} occur/match in the entry for it to be
8658 @orgcmd{<,org-agenda-filter-by-category}
8659 @vindex org-agenda-category-filter-preset
8661 Filter the current agenda view with respect to the category of the item at
8662 point. Pressing @code{<} another time will remove this filter. When called
8663 with a prefix argument exclude the category of the item at point from the
8664 agenda. You can add a filter preset through the option
8665 @code{org-agenda-category-filter-preset} (see below.)
8667 @orgcmd{^,org-agenda-filter-by-top-headline}
8668 Filter the current agenda view and only display the siblings and the parent
8669 headline of the one at point.
8671 @orgcmd{=,org-agenda-filter-by-regexp}
8672 @vindex org-agenda-regexp-filter-preset
8674 Filter the agenda view by a regular expression: only show agenda entries
8675 matching the regular expression the user entered. When called with a prefix
8676 argument, it will filter @emph{out} entries matching the regexp. With two
8677 universal prefix arguments, it will remove all the regexp filters, which can
8678 be accumulated. You can add a filter preset through the option
8679 @code{org-agenda-category-filter-preset} (see below.)
8681 @orgcmd{_,org-agenda-filter-by-effort}
8682 @vindex org-agenda-effort-filter-preset
8683 @vindex org-sort-agenda-noeffort-is-high
8684 Filter the agenda view with respect to effort estimates.
8685 You first need to set up allowed efforts globally, for example
8687 (setq org-global-properties
8688 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8690 You can then filter for an effort by first typing an operator, one of
8691 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8692 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8693 The filter will then restrict to entries with effort smaller-or-equal, equal,
8694 or larger-or-equal than the selected value. For application of the operator,
8695 entries without a defined effort will be treated according to the value of
8696 @code{org-sort-agenda-noeffort-is-high}.
8698 @orgcmd{|,org-agenda-filter-remove-all}
8699 Remove all filters in the current agenda view.
8702 @subsubheading Setting limits for the agenda
8703 @cindex limits, in agenda
8704 @vindex org-agenda-max-entries
8705 @vindex org-agenda-max-effort
8706 @vindex org-agenda-max-todos
8707 @vindex org-agenda-max-tags
8709 Here is a list of options that you can set, either globally, or locally in
8710 your custom agenda views (@pxref{Custom agenda views}).
8713 @item org-agenda-max-entries
8714 Limit the number of entries.
8715 @item org-agenda-max-effort
8716 Limit the duration of accumulated efforts (as minutes).
8717 @item org-agenda-max-todos
8718 Limit the number of entries with TODO keywords.
8719 @item org-agenda-max-tags
8720 Limit the number of tagged entries.
8723 When set to a positive integer, each option will exclude entries from other
8724 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8725 the agenda to 100 minutes of effort and exclude any entry that has no effort
8726 property. If you want to include entries with no effort property, use a
8727 negative value for @code{org-agenda-max-effort}.
8729 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8730 command. For example, this custom command will display the next five entries
8731 with a @code{NEXT} TODO keyword.
8734 (setq org-agenda-custom-commands
8736 ((org-agenda-max-entries 5)))))
8739 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8740 will again the next five entries again, including the first entry that was
8743 You can also dynamically set temporary limits, which will be lost when
8744 rebuilding the agenda:
8747 @orgcmd{~,org-agenda-limit-interactively}
8748 This prompts for the type of limit to apply and its value.
8751 @node Agenda commands
8752 @section Commands in the agenda buffer
8753 @cindex commands, in agenda buffer
8755 Entries in the agenda buffer are linked back to the Org file or diary
8756 file where they originate. You are not allowed to edit the agenda
8757 buffer itself, but commands are provided to show and jump to the
8758 original entry location, and to edit the Org files ``remotely'' from
8759 the agenda buffer. In this way, all information is stored only once,
8760 removing the risk that your agenda and note files may diverge.
8762 Some commands can be executed with mouse clicks on agenda lines. For
8763 the other commands, the cursor needs to be in the desired line.
8766 @tsubheading{Motion}
8767 @cindex motion commands in agenda
8768 @orgcmd{n,org-agenda-next-line}
8769 Next line (same as @key{down} and @kbd{C-n}).
8770 @orgcmd{p,org-agenda-previous-line}
8771 Previous line (same as @key{up} and @kbd{C-p}).
8772 @orgcmd{N,org-agenda-next-item}
8773 Next item: same as next line, but only consider items.
8774 @orgcmd{P,org-agenda-previous-item}
8775 Previous item: same as previous line, but only consider items.
8776 @tsubheading{View/Go to Org file}
8777 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8778 Display the original location of the item in another window.
8779 With prefix arg, make sure that the entire entry is made visible in the
8780 outline, not only the heading.
8782 @orgcmd{L,org-agenda-recenter}
8783 Display original location and recenter that window.
8785 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8786 Go to the original location of the item in another window.
8788 @orgcmd{@key{RET},org-agenda-switch-to}
8789 Go to the original location of the item and delete other windows.
8791 @orgcmd{F,org-agenda-follow-mode}
8792 @vindex org-agenda-start-with-follow-mode
8793 Toggle Follow mode. In Follow mode, as you move the cursor through
8794 the agenda buffer, the other window always shows the corresponding
8795 location in the Org file. The initial setting for this mode in new
8796 agenda buffers can be set with the variable
8797 @code{org-agenda-start-with-follow-mode}.
8799 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8800 Display the entire subtree of the current item in an indirect buffer. With a
8801 numeric prefix argument N, go up to level N and then take that tree. If N is
8802 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8803 previously used indirect buffer.
8805 @orgcmd{C-c C-o,org-agenda-open-link}
8806 Follow a link in the entry. This will offer a selection of any links in the
8807 text belonging to the referenced Org node. If there is only one link, it
8808 will be followed without a selection prompt.
8810 @tsubheading{Change display}
8811 @cindex display changing, in agenda
8814 Interactively select another agenda view and append it to the current view.
8818 Delete other windows.
8820 @orgcmdkskc{v d,d,org-agenda-day-view}
8821 @xorgcmdkskc{v w,w,org-agenda-week-view}
8822 @xorgcmd{v t,org-agenda-fortnight-view}
8823 @xorgcmd{v m,org-agenda-month-view}
8824 @xorgcmd{v y,org-agenda-year-view}
8825 @xorgcmd{v SPC,org-agenda-reset-view}
8826 @vindex org-agenda-span
8827 Switch to day/week/month/year view. When switching to day or week view, this
8828 setting becomes the default for subsequent agenda refreshes. Since month and
8829 year views are slow to create, they do not become the default. A numeric
8830 prefix argument may be used to jump directly to a specific day of the year,
8831 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8832 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8833 month view, a year may be encoded in the prefix argument as well. For
8834 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8835 specification has only one or two digits, it will be mapped to the interval
8836 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8837 @code{org-agenda-span}.
8839 @orgcmd{f,org-agenda-later}
8840 Go forward in time to display the following @code{org-agenda-current-span} days.
8841 For example, if the display covers a week, switch to the following week.
8842 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8844 @orgcmd{b,org-agenda-earlier}
8845 Go backward in time to display earlier dates.
8847 @orgcmd{.,org-agenda-goto-today}
8850 @orgcmd{j,org-agenda-goto-date}
8851 Prompt for a date and go there.
8853 @orgcmd{J,org-agenda-clock-goto}
8854 Go to the currently clocked-in task @i{in the agenda buffer}.
8856 @orgcmd{D,org-agenda-toggle-diary}
8857 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8859 @orgcmdkskc{v l,l,org-agenda-log-mode}
8861 @vindex org-log-done
8862 @vindex org-agenda-log-mode-items
8863 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8864 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8865 entries that have been clocked on that day. You can configure the entry
8866 types that should be included in log mode using the variable
8867 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8868 all possible logbook entries, including state changes. When called with two
8869 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8870 @kbd{v L} is equivalent to @kbd{C-u v l}.
8872 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8873 Include inactive timestamps into the current view. Only for weekly/daily
8874 agenda and timeline views.
8876 @orgcmd{v a,org-agenda-archives-mode}
8877 @xorgcmd{v A,org-agenda-archives-mode 'files}
8878 @cindex Archives mode
8879 Toggle Archives mode. In Archives mode, trees that are marked
8880 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8881 capital @kbd{A}, even all archive files are included. To exit archives mode,
8882 press @kbd{v a} again.
8884 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8885 @vindex org-agenda-start-with-clockreport-mode
8886 @vindex org-clock-report-include-clocking-task
8887 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8888 always show a table with the clocked times for the time span and file scope
8889 covered by the current agenda view. The initial setting for this mode in new
8890 agenda buffers can be set with the variable
8891 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8892 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8893 contributions from entries that are hidden by agenda filtering@footnote{Only
8894 tags filtering will be respected here, effort filtering is ignored.}. See
8895 also the variable @code{org-clock-report-include-clocking-task}.
8898 @vindex org-agenda-clock-consistency-checks
8899 Show overlapping clock entries, clocking gaps, and other clocking problems in
8900 the current agenda range. You can then visit clocking lines and fix them
8901 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8902 information on how to customize the definition of what constituted a clocking
8903 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8906 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8907 @vindex org-agenda-start-with-entry-text-mode
8908 @vindex org-agenda-entry-text-maxlines
8909 Toggle entry text mode. In entry text mode, a number of lines from the Org
8910 outline node referenced by an agenda line will be displayed below the line.
8911 The maximum number of lines is given by the variable
8912 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8913 prefix argument will temporarily modify that number to the prefix value.
8915 @orgcmd{G,org-agenda-toggle-time-grid}
8916 @vindex org-agenda-use-time-grid
8917 @vindex org-agenda-time-grid
8918 Toggle the time grid on and off. See also the variables
8919 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8921 @orgcmd{r,org-agenda-redo}
8922 Recreate the agenda buffer, for example to reflect the changes after
8923 modification of the timestamps of items with @kbd{S-@key{left}} and
8924 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8925 argument is interpreted to create a selective list for a specific TODO
8927 @orgcmd{g,org-agenda-redo}
8930 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8931 Save all Org buffers in the current Emacs session, and also the locations of
8934 @orgcmd{C-c C-x C-c,org-agenda-columns}
8935 @vindex org-columns-default-format
8936 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8937 view format is taken from the entry at point, or (if there is no entry at
8938 point), from the first entry in the agenda view. So whatever the format for
8939 that entry would be in the original buffer (taken from a property, from a
8940 @code{#+COLUMNS} line, or from the default variable
8941 @code{org-columns-default-format}), will be used in the agenda.
8943 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8944 Remove the restriction lock on the agenda, if it is currently restricted to a
8945 file or subtree (@pxref{Agenda files}).
8947 @tsubheading{Secondary filtering and query editing}
8949 For a detailed description of these commands, see @pxref{Filtering/limiting
8952 @orgcmd{/,org-agenda-filter-by-tag}
8953 @vindex org-agenda-tag-filter-preset
8954 Filter the agenda view with respect to a tag and/or effort estimates.
8956 @orgcmd{<,org-agenda-filter-by-category}
8957 @vindex org-agenda-category-filter-preset
8959 Filter the current agenda view with respect to the category of the item at
8960 point. Pressing @code{<} another time will remove this filter.
8962 @orgcmd{^,org-agenda-filter-by-top-headline}
8963 Filter the current agenda view and only display the siblings and the parent
8964 headline of the one at point.
8966 @orgcmd{=,org-agenda-filter-by-regexp}
8967 @vindex org-agenda-regexp-filter-preset
8969 Filter the agenda view by a regular expression: only show agenda entries
8970 matching the regular expression the user entered. When called with a prefix
8971 argument, it will filter @emph{out} entries matching the regexp. With two
8972 universal prefix arguments, it will remove all the regexp filters, which can
8973 be accumulated. You can add a filter preset through the option
8974 @code{org-agenda-category-filter-preset} (see below.)
8976 @orgcmd{|,org-agenda-filter-remove-all}
8977 Remove all filters in the current agenda view.
8979 @tsubheading{Remote editing}
8980 @cindex remote editing, from agenda
8985 @cindex undoing remote-editing events
8986 @cindex remote editing, undo
8987 @orgcmd{C-_,org-agenda-undo}
8988 Undo a change due to a remote editing command. The change is undone
8989 both in the agenda buffer and in the remote buffer.
8991 @orgcmd{t,org-agenda-todo}
8992 Change the TODO state of the item, both in the agenda and in the
8995 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8996 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8997 Switch to the next/previous set of TODO keywords.
8999 @orgcmd{C-k,org-agenda-kill}
9000 @vindex org-agenda-confirm-kill
9001 Delete the current agenda item along with the entire subtree belonging
9002 to it in the original Org file. If the text to be deleted remotely
9003 is longer than one line, the kill needs to be confirmed by the user. See
9004 variable @code{org-agenda-confirm-kill}.
9006 @orgcmd{C-c C-w,org-agenda-refile}
9007 Refile the entry at point.
9009 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
9010 @vindex org-archive-default-command
9011 Archive the subtree corresponding to the entry at point using the default
9012 archiving command set in @code{org-archive-default-command}. When using the
9013 @code{a} key, confirmation will be required.
9015 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
9016 Toggle the ARCHIVE tag for the current headline.
9018 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
9019 Move the subtree corresponding to the current entry to its @emph{archive
9022 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
9023 Archive the subtree corresponding to the current headline. This means the
9024 entry will be moved to the configured archive location, most likely a
9027 @orgcmd{T,org-agenda-show-tags}
9028 @vindex org-agenda-show-inherited-tags
9029 Show all tags associated with the current item. This is useful if you have
9030 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
9031 tags of a headline occasionally.
9033 @orgcmd{:,org-agenda-set-tags}
9034 Set tags for the current headline. If there is an active region in the
9035 agenda, change a tag for all headings in the region.
9039 Set the priority for the current item (@command{org-agenda-priority}).
9040 Org mode prompts for the priority character. If you reply with @key{SPC},
9041 the priority cookie is removed from the entry.
9043 @orgcmd{P,org-agenda-show-priority}
9044 Display weighted priority of current item.
9046 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
9047 Increase the priority of the current item. The priority is changed in
9048 the original buffer, but the agenda is not resorted. Use the @kbd{r}
9051 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
9052 Decrease the priority of the current item.
9054 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
9055 @vindex org-log-into-drawer
9056 Add a note to the entry. This note will be recorded, and then filed to the
9057 same location where state change notes are put. Depending on
9058 @code{org-log-into-drawer}, this may be inside a drawer.
9060 @orgcmd{C-c C-a,org-attach}
9061 Dispatcher for all command related to attachments.
9063 @orgcmd{C-c C-s,org-agenda-schedule}
9064 Schedule this item. With prefix arg remove the scheduling timestamp
9066 @orgcmd{C-c C-d,org-agenda-deadline}
9067 Set a deadline for this item. With prefix arg remove the deadline.
9069 @orgcmd{S-@key{right},org-agenda-do-date-later}
9070 Change the timestamp associated with the current line by one day into the
9071 future. If the date is in the past, the first call to this command will move
9073 With a numeric prefix argument, change it by that many days. For example,
9074 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
9075 change the time by one hour. If you immediately repeat the command, it will
9076 continue to change hours even without the prefix arg. With a double @kbd{C-u
9077 C-u} prefix, do the same for changing minutes.@*
9078 The stamp is changed in the original Org file, but the change is not directly
9079 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
9081 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
9082 Change the timestamp associated with the current line by one day
9085 @orgcmd{>,org-agenda-date-prompt}
9086 Change the timestamp associated with the current line. The key @kbd{>} has
9087 been chosen, because it is the same as @kbd{S-.} on my keyboard.
9089 @orgcmd{I,org-agenda-clock-in}
9090 Start the clock on the current item. If a clock is running already, it
9093 @orgcmd{O,org-agenda-clock-out}
9094 Stop the previously started clock.
9096 @orgcmd{X,org-agenda-clock-cancel}
9097 Cancel the currently running clock.
9099 @orgcmd{J,org-agenda-clock-goto}
9100 Jump to the running clock in another window.
9102 @orgcmd{k,org-agenda-capture}
9103 Like @code{org-capture}, but use the date at point as the default date for
9104 the capture template. See @code{org-capture-use-agenda-date} to make this
9105 the default behavior of @code{org-capture}.
9106 @cindex capturing, from agenda
9107 @vindex org-capture-use-agenda-date
9109 @tsubheading{Dragging agenda lines forward/backward}
9110 @cindex dragging, agenda lines
9112 @orgcmd{M-<up>,org-agenda-drag-line-backward}
9113 Drag the line at point backward one line@footnote{Moving agenda lines does
9114 not persist after an agenda refresh and does not modify the contributing
9115 @file{.org} files}. With a numeric prefix argument, drag backward by that
9118 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9119 Drag the line at point forward one line. With a numeric prefix argument,
9120 drag forward by that many lines.
9122 @tsubheading{Bulk remote editing selected entries}
9123 @cindex remote editing, bulk, from agenda
9124 @vindex org-agenda-bulk-custom-functions
9126 @orgcmd{m,org-agenda-bulk-mark}
9127 Mark the entry at point for bulk action. With numeric prefix argument, mark
9128 that many successive entries.
9130 @orgcmd{*,org-agenda-bulk-mark-all}
9131 Mark all visible agenda entries for bulk action.
9133 @orgcmd{u,org-agenda-bulk-unmark}
9134 Unmark entry at point for bulk action.
9136 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9137 Unmark all marked entries for bulk action.
9139 @orgcmd{M-m,org-agenda-bulk-toggle}
9140 Toggle mark of the entry at point for bulk action.
9142 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9143 Toggle marks of all visible entries for bulk action.
9145 @orgcmd{%,org-agenda-bulk-mark-regexp}
9146 Mark entries matching a regular expression for bulk action.
9148 @orgcmd{B,org-agenda-bulk-action}
9149 Bulk action: act on all marked entries in the agenda. This will prompt for
9150 another key to select the action to be applied. The prefix arg to @kbd{B}
9151 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9152 these special timestamps. By default, marks are removed after the bulk. If
9153 you want them to persist, set @code{org-agenda-persistent-marks} to @code{t}
9154 or hit @kbd{p} at the prompt.
9158 Toggle persistent marks.
9160 Archive all selected entries.
9162 Archive entries by moving them to their respective archive siblings.
9164 Change TODO state. This prompts for a single TODO keyword and changes the
9165 state of all selected entries, bypassing blocking and suppressing logging
9166 notes (but not timestamps).
9168 Add a tag to all selected entries.
9170 Remove a tag from all selected entries.
9172 Schedule all items to a new date. To shift existing schedule dates by a
9173 fixed number of days, use something starting with double plus at the prompt,
9174 for example @samp{++8d} or @samp{++2w}.
9176 Set deadline to a specific date.
9178 Prompt for a single refile target and move all entries. The entries will no
9179 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9181 Reschedule randomly into the coming N days. N will be prompted for. With
9182 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9184 Apply a function@footnote{You can also create persistent custom functions
9185 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
9186 example, the function below sets the CATEGORY property of the entries to web.
9190 (defun set-category ()
9192 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9193 (org-agenda-error)))
9194 (buffer (marker-buffer marker)))
9195 (with-current-buffer buffer
9200 (org-back-to-heading t)
9201 (org-set-property "CATEGORY" "web"))))))
9206 @tsubheading{Calendar commands}
9207 @cindex calendar commands, from agenda
9209 @orgcmd{c,org-agenda-goto-calendar}
9210 Open the Emacs calendar and move to the date at the agenda cursor.
9212 @orgcmd{c,org-calendar-goto-agenda}
9213 When in the calendar, compute and show the Org mode agenda for the
9216 @cindex diary entries, creating from agenda
9217 @orgcmd{i,org-agenda-diary-entry}
9218 @vindex org-agenda-diary-file
9219 Insert a new entry into the diary, using the date at the cursor and (for
9220 block entries) the date at the mark. This will add to the Emacs diary
9221 file@footnote{This file is parsed for the agenda when
9222 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9223 command in the calendar. The diary file will pop up in another window, where
9224 you can add the entry.
9226 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9227 Org will create entries (in Org mode syntax) in that file instead. Most
9228 entries will be stored in a date-based outline tree that will later make it
9229 easy to archive appointments from previous months/years. The tree will be
9230 built under an entry with a @code{DATE_TREE} property, or else with years as
9231 top-level entries. Emacs will prompt you for the entry text---if you specify
9232 it, the entry will be created in @code{org-agenda-diary-file} without further
9233 interaction. If you directly press @key{RET} at the prompt without typing
9234 text, the target file will be shown in another window for you to finish the
9235 entry there. See also the @kbd{k r} command.
9237 @orgcmd{M,org-agenda-phases-of-moon}
9238 Show the phases of the moon for the three months around current date.
9240 @orgcmd{S,org-agenda-sunrise-sunset}
9241 Show sunrise and sunset times. The geographical location must be set
9242 with calendar variables, see the documentation for the Emacs calendar.
9244 @orgcmd{C,org-agenda-convert-date}
9245 Convert the date at cursor into many other cultural and historic
9248 @orgcmd{H,org-agenda-holidays}
9249 Show holidays for three months around the cursor date.
9251 @item M-x org-icalendar-combine-agenda-files RET
9252 Export a single iCalendar file containing entries from all agenda files.
9253 This is a globally available command, and also available in the agenda menu.
9255 @tsubheading{Exporting to a file}
9256 @orgcmd{C-x C-w,org-agenda-write}
9257 @cindex exporting agenda views
9258 @cindex agenda views, exporting
9259 @vindex org-agenda-exporter-settings
9260 Write the agenda view to a file. Depending on the extension of the selected
9261 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9262 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9263 (any other extension). When exporting to Org, only the body of original
9264 headlines are exported, not subtrees or inherited tags. When called with a
9265 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9266 variable @code{org-agenda-exporter-settings} to set options for
9267 @file{ps-print} and for @file{htmlize} to be used during export.
9269 @tsubheading{Quit and Exit}
9270 @orgcmd{q,org-agenda-quit}
9271 Quit agenda, remove the agenda buffer.
9273 @cindex agenda files, removing buffers
9274 @orgcmd{x,org-agenda-exit}
9275 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9276 for the compilation of the agenda. Buffers created by the user to
9277 visit Org files will not be removed.
9281 @node Custom agenda views
9282 @section Custom agenda views
9283 @cindex custom agenda views
9284 @cindex agenda views, custom
9286 Custom agenda commands serve two purposes: to store and quickly access
9287 frequently used TODO and tags searches, and to create special composite
9288 agenda buffers. Custom agenda commands will be accessible through the
9289 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9292 * Storing searches:: Type once, use often
9293 * Block agenda:: All the stuff you need in a single buffer
9294 * Setting options:: Changing the rules
9297 @node Storing searches
9298 @subsection Storing searches
9300 The first application of custom searches is the definition of keyboard
9301 shortcuts for frequently used searches, either creating an agenda
9302 buffer, or a sparse tree (the latter covering of course only the current
9305 @vindex org-agenda-custom-commands
9306 @cindex agenda views, main example
9307 @cindex agenda, as an agenda views
9308 @cindex agenda*, as an agenda views
9309 @cindex tags, as an agenda view
9310 @cindex todo, as an agenda view
9316 Custom commands are configured in the variable
9317 @code{org-agenda-custom-commands}. You can customize this variable, for
9318 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9319 Lisp in @file{.emacs}. The following example contains all valid agenda
9324 (setq org-agenda-custom-commands
9327 ("w" todo "WAITING")
9328 ("W" todo-tree "WAITING")
9329 ("u" tags "+boss-urgent")
9330 ("v" tags-todo "+boss-urgent")
9331 ("U" tags-tree "+boss-urgent")
9332 ("f" occur-tree "\\<FIXME\\>")
9333 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9334 ("hl" tags "+home+Lisa")
9335 ("hp" tags "+home+Peter")
9336 ("hk" tags "+home+Kim")))
9341 The initial string in each entry defines the keys you have to press
9342 after the dispatcher command @kbd{C-c a} in order to access the command.
9343 Usually this will be just a single character, but if you have many
9344 similar commands, you can also define two-letter combinations where the
9345 first character is the same in several combinations and serves as a
9346 prefix key@footnote{You can provide a description for a prefix key by
9347 inserting a cons cell with the prefix and the description.}. The second
9348 parameter is the search type, followed by the string or regular
9349 expression to be used for the matching. The example above will
9354 as a global search for agenda entries planned@footnote{@emph{Planned} means
9355 here that these entries have some planning information attached to them, like
9356 a time-stamp, a scheduled or a deadline string. See
9357 @code{org-agenda-entry-types} on how to set what planning information will be
9358 taken into account.} this week/day.
9360 as a global search for agenda entries planned this week/day, but only those
9361 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9363 as a global search for TODO entries with @samp{WAITING} as the TODO
9366 as the same search, but only in the current buffer and displaying the
9367 results as a sparse tree
9369 as a global tags search for headlines marked @samp{:boss:} but not
9372 as the same search as @kbd{C-c a u}, but limiting the search to
9373 headlines that are also TODO items
9375 as the same search as @kbd{C-c a u}, but only in the current buffer and
9376 displaying the result as a sparse tree
9378 to create a sparse tree (again: current buffer only) with all entries
9379 containing the word @samp{FIXME}
9381 as a prefix command for a HOME tags search where you have to press an
9382 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9383 Peter, or Kim) as additional tag to match.
9386 Note that the @code{*-tree} agenda views need to be called from an
9387 Org buffer as they operate on the current buffer only.
9390 @subsection Block agenda
9391 @cindex block agenda
9392 @cindex agenda, with block views
9394 Another possibility is the construction of agenda views that comprise
9395 the results of @emph{several} commands, each of which creates a block in
9396 the agenda buffer. The available commands include @code{agenda} for the
9397 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9398 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9399 matching commands discussed above: @code{todo}, @code{tags}, and
9400 @code{tags-todo}. Here are two examples:
9404 (setq org-agenda-custom-commands
9405 '(("h" "Agenda and Home-related tasks"
9409 ("o" "Agenda and Office-related tasks"
9417 This will define @kbd{C-c a h} to create a multi-block view for stuff
9418 you need to attend to at home. The resulting agenda buffer will contain
9419 your agenda for the current week, all TODO items that carry the tag
9420 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9421 command @kbd{C-c a o} provides a similar view for office tasks.
9423 @node Setting options
9424 @subsection Setting options for custom commands
9425 @cindex options, for custom agenda views
9427 @vindex org-agenda-custom-commands
9428 Org mode contains a number of variables regulating agenda construction
9429 and display. The global variables define the behavior for all agenda
9430 commands, including the custom commands. However, if you want to change
9431 some settings just for a single custom view, you can do so. Setting
9432 options requires inserting a list of variable names and values at the
9433 right spot in @code{org-agenda-custom-commands}. For example:
9437 (setq org-agenda-custom-commands
9438 '(("w" todo "WAITING"
9439 ((org-agenda-sorting-strategy '(priority-down))
9440 (org-agenda-prefix-format " Mixed: ")))
9441 ("U" tags-tree "+boss-urgent"
9442 ((org-show-context-detail 'minimal)))
9444 ((org-agenda-files '("~org/notes.org"))
9445 (org-agenda-text-search-extra-files nil)))))
9450 Now the @kbd{C-c a w} command will sort the collected entries only by
9451 priority, and the prefix format is modified to just say @samp{ Mixed: }
9452 instead of giving the category of the entry. The sparse tags tree of
9453 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9454 headline hierarchy above the match, nor the headline following the match
9455 will be shown. The command @kbd{C-c a N} will do a text search limited
9456 to only a single file.
9458 @vindex org-agenda-custom-commands
9459 For command sets creating a block agenda,
9460 @code{org-agenda-custom-commands} has two separate spots for setting
9461 options. You can add options that should be valid for just a single
9462 command in the set, and options that should be valid for all commands in
9463 the set. The former are just added to the command entry; the latter
9464 must come after the list of command entries. Going back to the block
9465 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9466 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9467 the results for GARDEN tags query in the opposite order,
9468 @code{priority-up}. This would look like this:
9472 (setq org-agenda-custom-commands
9473 '(("h" "Agenda and Home-related tasks"
9477 ((org-agenda-sorting-strategy '(priority-up)))))
9478 ((org-agenda-sorting-strategy '(priority-down))))
9479 ("o" "Agenda and Office-related tasks"
9486 As you see, the values and parentheses setting is a little complex.
9487 When in doubt, use the customize interface to set this variable---it
9488 fully supports its structure. Just one caveat: when setting options in
9489 this interface, the @emph{values} are just Lisp expressions. So if the
9490 value is a string, you need to add the double-quotes around the value
9493 @vindex org-agenda-custom-commands-contexts
9494 To control whether an agenda command should be accessible from a specific
9495 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9496 say for example that you have an agenda command @code{"o"} displaying a view
9497 that you only need when reading emails. Then you would configure this option
9501 (setq org-agenda-custom-commands-contexts
9502 '(("o" (in-mode . "message-mode"))))
9505 You can also tell that the command key @code{"o"} should refer to another
9506 command key @code{"r"}. In that case, add this command key like this:
9509 (setq org-agenda-custom-commands-contexts
9510 '(("o" "r" (in-mode . "message-mode"))))
9513 See the docstring of the variable for more information.
9515 @node Exporting agenda views
9516 @section Exporting agenda views
9517 @cindex agenda views, exporting
9519 If you are away from your computer, it can be very useful to have a printed
9520 version of some agenda views to carry around. Org mode can export custom
9521 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9522 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9523 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9524 a PDF file will also create the postscript file.}, and iCalendar files. If
9525 you want to do this only occasionally, use the command
9528 @orgcmd{C-x C-w,org-agenda-write}
9529 @cindex exporting agenda views
9530 @cindex agenda views, exporting
9531 @vindex org-agenda-exporter-settings
9532 Write the agenda view to a file. Depending on the extension of the selected
9533 file name, the view will be exported as HTML (extension @file{.html} or
9534 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9535 @file{.ics}), or plain text (any other extension). Use the variable
9536 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9537 for @file{htmlize} to be used during export, for example
9539 @vindex org-agenda-add-entry-text-maxlines
9540 @vindex htmlize-output-type
9541 @vindex ps-number-of-columns
9542 @vindex ps-landscape-mode
9544 (setq org-agenda-exporter-settings
9545 '((ps-number-of-columns 2)
9546 (ps-landscape-mode t)
9547 (org-agenda-add-entry-text-maxlines 5)
9548 (htmlize-output-type 'css)))
9552 If you need to export certain agenda views frequently, you can associate
9553 any custom agenda command with a list of output file names
9554 @footnote{If you want to store standard views like the weekly agenda
9555 or the global TODO list as well, you need to define custom commands for
9556 them in order to be able to specify file names.}. Here is an example
9557 that first defines custom commands for the agenda and the global
9558 TODO list, together with a number of files to which to export them.
9559 Then we define two block agenda commands and specify file names for them
9560 as well. File names can be relative to the current working directory,
9565 (setq org-agenda-custom-commands
9566 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9567 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9568 ("h" "Agenda and Home-related tasks"
9573 ("~/views/home.html"))
9574 ("o" "Agenda and Office-related tasks"
9579 ("~/views/office.ps" "~/calendars/office.ics"))))
9583 The extension of the file name determines the type of export. If it is
9584 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9585 the buffer to HTML and save it to this file name. If the extension is
9586 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9587 Postscript output. If the extension is @file{.ics}, iCalendar export is
9588 run export over all files that were used to construct the agenda, and
9589 limit the export to entries listed in the agenda. Any other
9590 extension produces a plain ASCII file.
9592 The export files are @emph{not} created when you use one of those
9593 commands interactively because this might use too much overhead.
9594 Instead, there is a special command to produce @emph{all} specified
9598 @orgcmd{C-c a e,org-store-agenda-views}
9599 Export all agenda views that have export file names associated with
9603 You can use the options section of the custom agenda commands to also
9604 set options for the export commands. For example:
9607 (setq org-agenda-custom-commands
9609 ((ps-number-of-columns 2)
9610 (ps-landscape-mode t)
9611 (org-agenda-prefix-format " [ ] ")
9612 (org-agenda-with-colors nil)
9613 (org-agenda-remove-tags t))
9618 This command sets two options for the Postscript exporter, to make it
9619 print in two columns in landscape format---the resulting page can be cut
9620 in two and then used in a paper agenda. The remaining settings modify
9621 the agenda prefix to omit category and scheduling information, and
9622 instead include a checkbox to check off items. We also remove the tags
9623 to make the lines compact, and we don't want to use colors for the
9624 black-and-white printer. Settings specified in
9625 @code{org-agenda-exporter-settings} will also apply, but the settings
9626 in @code{org-agenda-custom-commands} take precedence.
9629 From the command line you may also use
9631 emacs -eval (org-batch-store-agenda-views) -kill
9634 or, if you need to modify some parameters@footnote{Quoting depends on the
9635 system you use, please check the FAQ for examples.}
9637 emacs -eval '(org-batch-store-agenda-views \
9638 org-agenda-span (quote month) \
9639 org-agenda-start-day "2007-11-01" \
9640 org-agenda-include-diary nil \
9641 org-agenda-files (quote ("~/org/project.org")))' \
9645 which will create the agenda views restricted to the file
9646 @file{~/org/project.org}, without diary entries and with a 30-day
9649 You can also extract agenda information in a way that allows further
9650 processing by other programs. See @ref{Extracting agenda information}, for
9654 @node Agenda column view
9655 @section Using column view in the agenda
9656 @cindex column view, in agenda
9657 @cindex agenda, column view
9659 Column view (@pxref{Column view}) is normally used to view and edit
9660 properties embedded in the hierarchical structure of an Org file. It can be
9661 quite useful to use column view also from the agenda, where entries are
9662 collected by certain criteria.
9665 @orgcmd{C-c C-x C-c,org-agenda-columns}
9666 Turn on column view in the agenda.
9669 To understand how to use this properly, it is important to realize that the
9670 entries in the agenda are no longer in their proper outline environment.
9671 This causes the following issues:
9675 @vindex org-columns-default-format
9676 @vindex org-overriding-columns-format
9677 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9678 entries in the agenda are collected from different files, and different files
9679 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9680 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9681 currently set, and if so, takes the format from there. Otherwise it takes
9682 the format associated with the first item in the agenda, or, if that item
9683 does not have a specific format (defined in a property, or in its file), it
9684 uses @code{org-columns-default-format}.
9686 @cindex property, special, CLOCKSUM
9687 If any of the columns has a summary type defined (@pxref{Column attributes}),
9688 turning on column view in the agenda will visit all relevant agenda files and
9689 make sure that the computations of this property are up to date. This is
9690 also true for the special @code{CLOCKSUM} property. Org will then sum the
9691 values displayed in the agenda. In the daily/weekly agenda, the sums will
9692 cover a single day; in all other views they cover the entire block. It is
9693 vital to realize that the agenda may show the same entry @emph{twice} (for
9694 example as scheduled and as a deadline), and it may show two entries from the
9695 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9696 cases, the summation in the agenda will lead to incorrect results because
9697 some values will count double.
9699 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9700 the entire clocked time for this item. So even in the daily/weekly agenda,
9701 the clocksum listed in column view may originate from times outside the
9702 current view. This has the advantage that you can compare these values with
9703 a column listing the planned total effort for a task---one of the major
9704 applications for column view in the agenda. If you want information about
9705 clocked time in the displayed period use clock table mode (press @kbd{R} in
9709 @cindex property, special, CLOCKSUM_T
9710 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9711 always today's clocked time for this item. So even in the weekly agenda,
9712 the clocksum listed in column view only originates from today. This lets
9713 you compare the time you spent on a task for today, with the time already
9714 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9719 @chapter Markup for rich export
9721 When exporting Org mode documents, the exporter tries to reflect the
9722 structure of the document as accurately as possible in the back-end. Since
9723 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9724 rules on how to prepare text for rich export. This section summarizes the
9725 markup rules used in an Org mode buffer.
9728 * Structural markup elements:: The basic structure as seen by the exporter
9729 * Images and tables:: Images, tables and caption mechanism
9730 * Literal examples:: Source code examples with special formatting
9731 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9732 * Special blocks:: Containers targeted at export back-ends
9735 @node Structural markup elements
9736 @section Structural markup elements
9739 * Document title:: Where the title is taken from
9740 * Headings and sections:: The document structure as seen by the exporter
9741 * Table of contents:: The if and where of the table of contents
9743 * Paragraphs:: Paragraphs
9744 * Footnote markup:: Footnotes
9745 * Emphasis and monospace:: Bold, italic, etc.
9746 * Horizontal rules:: Make a line
9747 * Comment lines:: What will *not* be exported
9750 @node Document title
9751 @subheading Document title
9752 @cindex document title, markup rules
9755 The title of the exported document is taken from the special line
9759 #+TITLE: This is the title of the document
9762 @cindex property, EXPORT_TITLE
9763 If you are exporting only a subtree, its heading will become the title of the
9764 document. If the subtree has a property @code{EXPORT_TITLE}, that will take
9767 @node Headings and sections
9768 @subheading Headings and sections
9769 @cindex headings and sections, markup rules
9771 @vindex org-export-headline-levels
9772 The outline structure of the document as described in @ref{Document
9773 structure}, forms the basis for defining sections of the exported document.
9774 However, since the outline structure is also used for (for example) lists of
9775 tasks, only the first three outline levels will be used as headings. Deeper
9776 levels will become itemized lists. You can change the location of this
9777 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9778 per-file basis with a line
9785 @node Table of contents
9786 @subheading Table of contents
9787 @cindex table of contents, markup rules
9790 @vindex org-export-with-toc
9791 The table of contents is normally inserted directly before the first headline
9792 of the file. The depth of the table is by default the same as the number of
9793 headline levels, but you can choose a smaller number, or turn off the table
9794 of contents entirely, by configuring the variable @code{org-export-with-toc},
9795 or on a per-file basis with a line like
9798 #+OPTIONS: toc:2 @r{only inlcude two levels in TOC}
9799 #+OPTIONS: toc:nil @r{no default TOC at all}
9802 If you would like to move the table of contents to a different location, you
9803 should turn off the default table using @code{org-export-with-toc} or
9804 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9808 #+OPTIONS: toc:nil @r{no default TOC}
9810 #+TOC: headlines 2 @r{insert TOC here, with two headline levels}
9813 Moreover, if you append @samp{local} parameter, the table contains only
9814 entries for the children of the current section@footnote{For @LaTeX{} export,
9815 this feature requires the @code{titletoc} package. Note that @code{titletoc}
9816 must be loaded @emph{before} @code{hyperref}. Thus, you may have to
9817 customize @code{org-latex-default-packages-alist}.}. In this case, any depth
9818 parameter becomes relative to the current level.
9822 #+TOC: headlines 1 local @r{insert local TOC, with direct children only}
9825 The same @code{TOC} keyword can also generate a list of all tables (resp.@:
9826 all listings) with a caption in the document.
9829 #+TOC: listings @r{build a list of listings}
9830 #+TOC: tables @r{build a list of tables}
9833 @cindex property, ALT_TITLE
9834 The headline's title usually determines its corresponding entry in a table of
9835 contents. However, it is possible to specify an alternative title by
9836 setting @code{ALT_TITLE} property accordingly. It will then be used when
9841 @cindex lists, markup rules
9843 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9844 syntax for such lists. Most back-ends support unordered, ordered, and
9848 @subheading Paragraphs, line breaks, and quoting
9849 @cindex paragraphs, markup rules
9851 Paragraphs are separated by at least one empty line. If you need to enforce
9852 a line break within a paragraph, use @samp{\\} at the end of a line.
9854 To keep the line breaks in a region, but otherwise use normal formatting, you
9855 can use this construct, which can also be used to format poetry.
9857 @cindex #+BEGIN_VERSE
9860 Great clouds overhead
9861 Tiny black birds rise and fall
9868 When quoting a passage from another document, it is customary to format this
9869 as a paragraph that is indented on both the left and the right margin. You
9870 can include quotations in Org mode documents like this:
9872 @cindex #+BEGIN_QUOTE
9875 Everything should be made as simple as possible,
9876 but not any simpler -- Albert Einstein
9880 If you would like to center some text, do it like this:
9881 @cindex #+BEGIN_CENTER
9884 Everything should be made as simple as possible, \\
9890 @node Footnote markup
9891 @subheading Footnote markup
9892 @cindex footnotes, markup rules
9893 @cindex @file{footnote.el}
9895 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9896 by all back-ends. Org allows multiple references to the same note, and
9897 multiple footnotes side by side.
9899 @node Emphasis and monospace
9900 @subheading Emphasis and monospace
9902 @cindex underlined text, markup rules
9903 @cindex bold text, markup rules
9904 @cindex italic text, markup rules
9905 @cindex verbatim text, markup rules
9906 @cindex code text, markup rules
9907 @cindex strike-through text, markup rules
9908 @vindex org-fontify-emphasized-text
9909 @vindex org-emphasis-regexp-components
9910 @vindex org-emphasis-alist
9911 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9912 and @code{~code~}, and, if you must, @samp{+strike-through+}. Text
9913 in the code and verbatim string is not processed for Org mode specific
9914 syntax, it is exported verbatim.
9916 To turn off fontification for marked up text, you can set
9917 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9918 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9919 tune what characters are allowed before and after the markup characters, you
9920 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9921 the above variables will no take effect until you reload Org, for which you
9922 may need to restart Emacs.
9924 @node Horizontal rules
9925 @subheading Horizontal rules
9926 @cindex horizontal rules, markup rules
9927 A line consisting of only dashes, and at least 5 of them, will be exported as
9931 @subheading Comment lines
9932 @cindex comment lines
9933 @cindex exporting, not
9934 @cindex #+BEGIN_COMMENT
9936 Lines starting with zero or more whitespace characters followed by one
9937 @samp{#} and a whitespace are treated as comments and, as such, are not
9940 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9941 ... @samp{#+END_COMMENT} are not exported.
9943 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9944 other keyword or priority cookie, comments out the entire subtree. In this
9945 case, the subtree is not exported and no code block within it is executed
9946 either@footnote{For a less drastic behavior, consider using a select tag
9947 (@pxref{Export settings}) instead.}. The command below helps changing the
9948 comment status of a headline.
9953 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9957 @node Images and tables
9958 @section Images and Tables
9960 @cindex tables, markup rules
9963 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9964 the @file{table.el} package will be exported properly. For Org mode tables,
9965 the lines before the first horizontal separator line will become table header
9966 lines. You can use the following lines somewhere before the table to assign
9967 a caption and a label for cross references, and in the text you can refer to
9968 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9971 #+CAPTION: This is the caption for the next table (or link)
9972 #+NAME: tab:basic-data
9977 Optionally, the caption can take the form:
9979 #+CAPTION[Caption for list of tables]: Caption for table.
9982 @cindex inlined images, markup rules
9983 Some back-ends allow you to directly include images into the exported
9984 document. Org does this, if a link to an image files does not have
9985 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9986 define a caption for the image and maybe a label for internal cross
9987 references, make sure that the link is on a line by itself and precede it
9988 with @code{#+CAPTION} and @code{#+NAME} as follows:
9991 #+CAPTION: This is the caption for the next figure link (or table)
9992 #+NAME: fig:SED-HR4049
9997 Such images can be displayed within the buffer. @xref{Handling links,the
9998 discussion of image links}.
10000 Even though images and tables are prominent examples of captioned structures,
10001 the same caption mechanism can apply to many others (e.g., @LaTeX{}
10002 equations, source code blocks). Depending on the export back-end, those may
10003 or may not be handled.
10005 @node Literal examples
10006 @section Literal examples
10007 @cindex literal examples, markup rules
10008 @cindex code line references, markup rules
10010 You can include literal examples that should not be subjected to
10011 markup. Such examples will be typeset in monospace, so this is well suited
10012 for source code and similar examples.
10013 @cindex #+BEGIN_EXAMPLE
10017 Some example from a text file.
10021 Note that such blocks may be @i{indented} in order to align nicely with
10022 indented text and in particular with plain list structure (@pxref{Plain
10023 lists}). For simplicity when using small examples, you can also start the
10024 example lines with a colon followed by a space. There may also be additional
10025 whitespace before the colon:
10029 : Some example from a text file.
10032 @cindex formatting source code, markup rules
10033 @vindex org-latex-listings
10034 If the example is source code from a programming language, or any other text
10035 that can be marked up by font-lock in Emacs, you can ask for the example to
10036 look like the fontified Emacs buffer@footnote{This works automatically for
10037 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
10038 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
10039 achieved using either the
10040 @url{https://www.ctan.org/tex-archive/macros/latex/contrib/listings/?lang=en, listings,}
10042 @url{https://github.com/gpoore/minted, minted,} package.
10043 If you use minted or listing, you must load the packages manually, for
10044 example by adding the desired package to
10045 @code{org-latex-packages-alist}. Refer to @code{org-latex-listings}
10046 for details.}. This is done with the @samp{src} block, where you also need
10047 to specify the name of the major mode that should be used to fontify the
10048 example@footnote{Code in @samp{src} blocks may also be evaluated either
10049 interactively or on export. See @pxref{Working with source code} for more
10050 information on evaluating code blocks.}, see @ref{Easy templates} for
10051 shortcuts to easily insert code blocks.
10052 @cindex #+BEGIN_SRC
10055 #+BEGIN_SRC emacs-lisp
10056 (defun org-xor (a b)
10062 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
10063 switch to the end of the @code{BEGIN} line, to get the lines of the example
10064 numbered. The @code{-n} takes an optional numeric argument specifying the
10065 starting line number of the block. If you use a @code{+n} switch, the
10066 numbering from the previous numbered snippet will be continued in the current
10067 one. The @code{+n} can also take a numeric argument. The value of the
10068 argument will be added to the last line of the previous block to determine
10069 the starting line number.
10072 #+BEGIN_SRC emacs-lisp -n 20
10073 ;; this will export with line number 20
10074 (message "This is line 21")
10076 #+BEGIN_SRC emacs-lisp +n 10
10077 ;; This will be listed as line 31
10078 (message "This is line 32")
10082 In literal examples, Org will interpret strings like @samp{(ref:name)} as
10083 labels, and use them as targets for special hyperlinks like @code{[[(name)]]}
10084 (i.e., the reference name enclosed in single parenthesis). In HTML, hovering
10085 the mouse over such a link will remote-highlight the corresponding code line,
10086 which is kind of cool.
10088 You can also add a @code{-r} switch which @i{removes} the labels from the
10089 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
10090 labels in the source code while using line numbers for the links, which might
10091 be useful to explain those in an Org mode example code.}. With the @code{-n}
10092 switch, links to these references will be labeled by the line numbers from
10093 the code listing, otherwise links will use the labels with no parentheses.
10094 Here is an example:
10097 #+BEGIN_SRC emacs-lisp -n -r
10098 (save-excursion (ref:sc)
10099 (goto-char (point-min))) (ref:jump)
10101 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
10102 jumps to point-min.
10105 @cindex indentation, in source blocks
10106 Finally, you can use @code{-i} to preserve the indentation of a specific code
10107 block (@pxref{Editing source code}).
10109 @vindex org-coderef-label-format
10110 If the syntax for the label format conflicts with the language syntax, use a
10111 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
10112 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
10114 HTML export also allows examples to be published as text areas (@pxref{Text
10115 areas in HTML export}).
10117 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
10118 so often, shortcuts are provided using the Easy templates facility
10119 (@pxref{Easy templates}).
10124 Edit the source code example at point in its native mode. This works by
10125 switching to a temporary buffer with the source code. You need to exit by
10126 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
10127 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
10128 from being interpreted by Org as outline nodes or special syntax. These
10129 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
10130 The edited version will then replace the old version in the Org buffer.
10131 Fixed-width regions (where each line starts with a colon followed by a space)
10132 will be edited using @code{artist-mode}@footnote{You may select
10133 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
10134 to allow creating ASCII drawings easily. Using this command in an empty line
10135 will create a new fixed-width region.
10138 Calling @code{org-store-link} while editing a source code example in a
10139 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
10140 that it is unique in the current buffer, and insert it with the proper
10141 formatting like @samp{(ref:label)} at the end of the current line. Then the
10142 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
10145 @node Embedded @LaTeX{}
10146 @section Embedded @LaTeX{}
10147 @cindex @TeX{} interpretation
10148 @cindex @LaTeX{} interpretation
10150 Plain ASCII is normally sufficient for almost all note taking. Exceptions
10151 include scientific notes, which often require mathematical symbols and the
10152 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10153 Donald E. Knuth's @TeX{} system. Many of the features described here as
10154 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10155 distinction.} is widely used to typeset scientific documents. Org mode
10156 supports embedding @LaTeX{} code into its files, because many academics are
10157 used to writing and reading @LaTeX{} source code, and because it can be
10158 readily processed to produce pretty output for a number of export back-ends.
10161 * Special symbols:: Greek letters and other symbols
10162 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10163 * @LaTeX{} fragments:: Complex formulas made easy
10164 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10165 * CDLaTeX mode:: Speed up entering of formulas
10168 @node Special symbols
10169 @subsection Special symbols
10170 @cindex math symbols
10171 @cindex special symbols
10172 @cindex @TeX{} macros
10173 @cindex @LaTeX{} fragments, markup rules
10174 @cindex HTML entities
10175 @cindex @LaTeX{} entities
10177 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10178 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10179 for these symbols is available, just type @samp{\} and maybe a few letters,
10180 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10181 code, Org mode allows these symbols to be present without surrounding math
10182 delimiters, for example:
10185 Angles are written as Greek letters \alpha, \beta and \gamma.
10188 @vindex org-entities
10189 During export, these symbols will be transformed into the native format of
10190 the exporter back-end. Strings like @code{\alpha} will be exported as
10191 @code{α} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10192 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10193 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10194 like this: @samp{\Aacute@{@}stor}.
10196 A large number of entities is provided, with names taken from both HTML and
10197 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10198 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10199 @samp{...} are all converted into special commands creating hyphens of
10200 different lengths or a compact set of dots.
10202 If you would like to see entities displayed as UTF-8 characters, use the
10203 following command@footnote{You can turn this on by default by setting the
10204 variable @code{org-pretty-entities}, or on a per-file base with the
10205 @code{#+STARTUP} option @code{entitiespretty}.}:
10208 @cindex @code{entitiespretty}, STARTUP keyword
10211 Toggle display of entities as UTF-8 characters. This does not change the
10212 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10213 for display purposes only.
10216 @node Subscripts and superscripts
10217 @subsection Subscripts and superscripts
10219 @cindex superscript
10221 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10222 subscripts. Again, these can be used without embedding them in math-mode
10223 delimiters. To increase the readability of ASCII text, it is not necessary
10224 (but OK) to surround multi-character sub- and superscripts with curly braces.
10228 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10229 the sun is R_@{sun@} = 6.96 x 10^8 m.
10232 @vindex org-use-sub-superscripts
10233 If you write a text where the underscore is often used in a different
10234 context, Org's convention to always interpret these as subscripts can get in
10235 your way. Configure the variable @code{org-use-sub-superscripts} to change
10236 this convention. For example, when setting this variable to @code{@{@}},
10237 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10242 In addition to showing entities as UTF-8 characters, this command will also
10243 format sub- and superscripts in a WYSIWYM way.
10246 @node @LaTeX{} fragments
10247 @subsection @LaTeX{} fragments
10248 @cindex @LaTeX{} fragments
10250 @vindex org-format-latex-header
10251 Going beyond symbols and sub- and superscripts, a full formula language is
10252 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10253 to process these for several export back-ends. When exporting to @LaTeX{},
10254 the code is left as it is. When exporting to HTML, Org can use either
10255 @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML
10256 export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
10259 @LaTeX{} fragments don't need any special marking at all. The following
10260 snippets will be identified as @LaTeX{} source code:
10263 Environments of any kind@footnote{When MathJax is used, only the
10264 environments recognized by MathJax will be processed. When
10265 @file{dvipng} program, @file{dvisvgm} program or @file{imagemagick} suite is
10266 used to create images, any @LaTeX{} environment will be handled.}. The only
10267 requirement is that the @code{\begin} statement appears on a new line, at the
10268 beginning of the line or after whitespaces only.
10270 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10271 currency specifications, single @samp{$} characters are only recognized as
10272 math delimiters if the enclosed text contains at most two line breaks, is
10273 directly attached to the @samp{$} characters with no whitespace in between,
10274 and if the closing @samp{$} is followed by whitespace or punctuation
10275 (parentheses and quotes are considered to be punctuation in this
10276 context). For the other delimiters, there is no such restriction, so when in
10277 doubt, use @samp{\(...\)} as inline math delimiters.
10280 @noindent For example:
10287 If $a^2=b$ and \( b=2 \), then the solution must be
10288 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10293 @c @vindex org-format-latex-options
10294 @c If you need any of the delimiter ASCII sequences for other purposes, you
10295 @c can configure the option @code{org-format-latex-options} to deselect the
10296 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10298 @vindex org-export-with-latex
10299 @LaTeX{} processing can be configured with the variable
10300 @code{org-export-with-latex}. The default setting is @code{t} which means
10301 MathJax for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10302 You can also set this variable on a per-file basis using one of these
10306 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10307 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10308 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10311 @node Previewing @LaTeX{} fragments
10312 @subsection Previewing @LaTeX{} fragments
10313 @cindex @LaTeX{} fragments, preview
10315 @vindex org-preview-latex-default-process
10316 If you have a working @LaTeX{} installation and @file{dvipng}, @file{dvisvgm}
10317 or @file{convert} installed@footnote{These are respectively available at
10318 @url{http://sourceforge.net/projects/dvipng/}, @url{http://dvisvgm.bplaced.net/}
10319 and from the @file{imagemagick} suite. Choose the converter by setting the
10320 variable @code{org-preview-latex-default-process} accordingly.}, @LaTeX{}
10321 fragments can be processed to produce images of the typeset expressions to be
10322 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10323 or for inline previewing within Org mode.
10325 @vindex org-format-latex-options
10326 @vindex org-format-latex-header
10327 You can customize the variables @code{org-format-latex-options} and
10328 @code{org-format-latex-header} to influence some aspects of the preview. In
10329 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10330 property of the former can be used to adjust the size of the preview images.
10333 @kindex C-c C-x C-l
10335 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10336 over the source code. If there is no fragment at point, process all
10337 fragments in the current entry (between two headlines). When called
10338 with a prefix argument, process the entire subtree. When called with
10339 two prefix arguments, or when the cursor is before the first headline,
10340 process the entire buffer.
10343 Remove the overlay preview images.
10346 @vindex org-startup-with-latex-preview
10347 You can turn on the previewing of all @LaTeX{} fragments in a file with
10350 #+STARTUP: latexpreview
10353 To disable it, simply use
10356 #+STARTUP: nolatexpreview
10360 @subsection Using CD@LaTeX{} to enter math
10363 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10364 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10365 environments and math templates. Inside Org mode, you can make use of
10366 some of the features of CD@LaTeX{} mode. You need to install
10367 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10368 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10369 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10370 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10371 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10375 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10378 When this mode is enabled, the following features are present (for more
10379 details see the documentation of CD@LaTeX{} mode):
10383 Environment templates can be inserted with @kbd{C-c @{}.
10386 The @key{TAB} key will do template expansion if the cursor is inside a
10387 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10388 inside such a fragment, see the documentation of the function
10389 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10390 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10391 correctly inside the first brace. Another @key{TAB} will get you into
10392 the second brace. Even outside fragments, @key{TAB} will expand
10393 environment abbreviations at the beginning of a line. For example, if
10394 you write @samp{equ} at the beginning of a line and press @key{TAB},
10395 this abbreviation will be expanded to an @code{equation} environment.
10396 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10400 @vindex cdlatex-simplify-sub-super-scripts
10401 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10402 characters together with a pair of braces. If you use @key{TAB} to move
10403 out of the braces, and if the braces surround only a single character or
10404 macro, they are removed again (depending on the variable
10405 @code{cdlatex-simplify-sub-super-scripts}).
10408 Pressing the grave accent @kbd{`} followed by a character inserts math
10409 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10410 after the grave accent, a help window will pop up.
10413 Pressing the apostrophe @kbd{'} followed by another character modifies
10414 the symbol before point with an accent or a font. If you wait more than
10415 1.5 seconds after the apostrophe, a help window will pop up. Character
10416 modification will work only inside @LaTeX{} fragments; outside the quote
10420 @node Special blocks
10421 @section Special blocks
10422 @cindex Special blocks
10424 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10425 examples}). It is also possible to create blocks containing raw code
10426 targeted at a specific back-end (e.g., @samp{#+BEGIN_EXPORT latex}).
10428 Any other block is a @emph{special block}. Its name is case-sensitive.
10430 For example, @samp{#+BEGIN_abstract} and @samp{#+BEGIN_video} are special
10431 blocks. The first one is useful when exporting to @LaTeX{}, the second one
10432 when exporting to HTML5.
10434 Each export back-end decides if they should be exported, and how. When the
10435 block is ignored, its contents are still exported, as if the opening and
10436 closing block lines were not there. For example, when exporting a
10437 @samp{#+BEGIN_test} block, HTML back-end wraps its contents within a
10438 @samp{<div name="test">} tag.
10440 Refer to back-end specific documentation for more information.
10446 The Org mode export facilities can be used to export Org documents or parts
10447 of Org documents to a variety of other formats. In addition, these
10448 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10449 in foreign buffers so you can author tables and lists in Org syntax and
10450 convert them in place to the target language.
10452 ASCII export produces a readable and simple version of an Org file for
10453 printing and sharing notes. HTML export allows you to easily publish notes
10454 on the web, or to build full-fledged websites. @LaTeX{} export lets you use
10455 Org mode and its structured editing functions to create arbitrarily complex
10456 @LaTeX{} files for any kind of document. OpenDocument Text (ODT) and
10457 Markdown export allow seamless collaboration across organizational
10458 boundaries. Texinfo export helps generating documentation or full-fledged
10459 manuals. Finally, iCal export can extract entries with deadlines or
10460 appointments to produce a file in the iCalendar format.
10463 * The export dispatcher:: The main exporter interface
10464 * Export back-ends:: Built-in export formats
10465 * Export settings:: Generic export settings
10466 * Include files:: Include additional files into a document
10467 * Macro replacement:: Use macros to create templates
10468 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10469 * Beamer export:: Exporting as a Beamer presentation
10470 * HTML export:: Exporting to HTML
10471 * @LaTeX{} export:: Exporting to @LaTeX{}, and processing to PDF
10472 * Markdown export:: Exporting to Markdown
10473 * OpenDocument Text export:: Exporting to OpenDocument Text
10474 * Org export:: Exporting to Org
10475 * Texinfo export:: Exporting to Texinfo
10476 * iCalendar export:: Exporting to iCalendar
10477 * Other built-in back-ends:: Exporting to a man page
10478 * Export in foreign buffers:: Author tables and lists in Org syntax
10479 * Advanced configuration:: Fine-tuning the export output
10482 @node The export dispatcher
10483 @section The export dispatcher
10484 @vindex org-export-dispatch-use-expert-ui
10485 @cindex Export, dispatcher
10487 The main entry point for export related tasks is the dispatcher, a
10488 hierarchical menu from which it is possible to select an export format and
10489 toggle export options@footnote{It is also possible to use a less intrusive
10490 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10491 non-@code{nil} value. In that case, only a prompt is visible from the
10492 minibuffer. From there one can still switch back to regular menu by pressing
10496 @orgcmd{C-c C-e,org-export-dispatch}
10498 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10499 prefix argument, repeat the last export command on the current buffer while
10500 preserving toggled options. If the current buffer hasn't changed and subtree
10501 export was activated, the command will affect that same subtree.
10504 Normally the entire buffer is exported, but if there is an active region
10505 only that part of the buffer will be exported.
10507 Several export options (@pxref{Export settings}) can be toggled from the
10508 export dispatcher with the following key combinations:
10512 @vindex org-export-async-init-file
10513 Toggle asynchronous export. Asynchronous export uses an external Emacs
10514 process that is configured with a specified initialization file.
10516 While exporting asynchronously, the output is not displayed, but stored in
10517 a place called ``the export stack''. This stack can be displayed by calling
10518 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10519 from the dispatcher menu.
10521 @vindex org-export-in-background
10522 To make this behavior the default, customize the variable
10523 @code{org-export-in-background}.
10526 Toggle body-only export. Its effect depends on the back-end used.
10527 Typically, if the back-end has a header section (like @code{<head>...</head>}
10528 in the HTML back-end), a body-only export will not include this header.
10531 @vindex org-export-initial-scope
10532 Toggle subtree export. The top heading becomes the document title.
10534 You can change the default state of this option by setting
10535 @code{org-export-initial-scope}.
10538 Toggle visible-only export. Only export the text that is currently
10539 visible, i.e., not hidden by outline visibility in the buffer.
10542 @node Export back-ends
10543 @section Export back-ends
10544 @cindex Export, back-ends
10546 An export back-end is a library that translates Org syntax into a foreign
10547 format. An export format is not available until the proper back-end has been
10550 Built-in back-ends include:
10553 @item ascii (ASCII format)
10554 @item beamer (@LaTeX{} Beamer format)
10555 @item html (HTML format)
10556 @item icalendar (iCalendar format)
10557 @item latex (@LaTeX{} format)
10558 @item man (Man page format)
10559 @item md (Markdown format)
10560 @item odt (OpenDocument Text format)
10561 @item org (Org format)
10562 @item texinfo (Texinfo format)
10565 Other back-ends might be found in the @code{contrib/} directory
10566 (@pxref{Installation}).
10568 @vindex org-export-backends
10569 By default, the following five back-ends are loaded: @code{ascii},
10570 @code{html}, @code{icalendar}, @code{latex} and @code{odt}. It is possible
10571 to add more, or remove some, by customizing @code{org-export-backends}.
10573 @node Export settings
10574 @section Export settings
10575 @cindex Export, settings
10578 Export options can be set: globally with variables; for an individual file by
10579 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10580 settings}), by setting individual keywords, or by specifying them in a
10581 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10582 properties (@pxref{Properties and columns}). Options set at a specific level
10583 override options set at a more general level.
10585 @cindex #+SETUPFILE
10586 In-buffer settings may appear anywhere in the file, either directly or
10587 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10588 Option keyword sets tailored to a particular back-end can be inserted from
10589 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10590 template} command by pressing @key{#}. To insert keywords individually,
10591 a good way to make sure the keyword is correct is to type @code{#+} and then
10592 to use @kbd{M-<TAB>} for completion.
10594 The export keywords available for every back-end, and their equivalent global
10595 variables, include:
10600 @vindex user-full-name
10601 The document author (@code{user-full-name}).
10605 @vindex org-export-creator-string
10606 Entity responsible for output generation (@code{org-export-creator-string}).
10610 @vindex org-export-date-timestamp-format
10611 A date or a time-stamp@footnote{The variable
10612 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10617 @vindex user-mail-address
10618 The email address (@code{user-mail-address}).
10622 @vindex org-export-default-language
10623 The language used for translating some strings
10624 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10625 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10629 @cindex #+SELECT_TAGS
10630 @vindex org-export-select-tags
10631 The tags that select a tree for export (@code{org-export-select-tags}). The
10632 default value is @code{:export:}. Within a subtree tagged with
10633 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10634 below). When headlines are selectively exported with @code{:export:}
10635 anywhere in a file, text before the first headline is ignored.
10638 @cindex #+EXCLUDE_TAGS
10639 @vindex org-export-exclude-tags
10640 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10641 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10642 tag will be unconditionally excluded from the export, even if they have an
10643 @code{:export:} tag. Code blocks contained in excluded subtrees will still
10644 be executed during export even though the subtree is not exported.
10648 The title to be shown. You can use several such keywords for long titles.
10651 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10652 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10653 recognizes the following arguments:
10657 @vindex org-export-with-smart-quotes
10658 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10661 Toggle emphasized text (@code{org-export-with-emphasize}).
10664 @vindex org-export-with-special-strings
10665 Toggle conversion of special strings
10666 (@code{org-export-with-special-strings}).
10669 @vindex org-export-with-fixed-width
10670 Toggle fixed-width sections
10671 (@code{org-export-with-fixed-width}).
10674 @vindex org-export-with-timestamps
10675 Toggle inclusion of any time/date active/inactive stamps
10676 (@code{org-export-with-timestamps}).
10679 @vindex org-export-preserve-breaks
10680 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10683 @vindex org-export-with-sub-superscripts
10684 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10685 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10686 it is (@code{org-export-with-sub-superscripts}).
10689 @vindex org-export-with-archived-trees
10690 Configure export of archived trees. Can be set to @code{headline} to only
10691 process the headline, skipping its contents
10692 (@code{org-export-with-archived-trees}).
10695 @vindex org-export-with-author
10696 Toggle inclusion of author name into exported file
10697 (@code{org-export-with-author}).
10699 @item broken-links:
10700 @vindex org-export-with-broken-links
10701 Decide whether to raise an error or not when encountering a broken internal
10702 link. When set to @code{mark}, signal the problem clearly in the output
10703 (@code{org-export-with-broken-links}).
10706 @vindex org-export-with-clocks
10707 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10710 @vindex org-export-with-creator
10711 Toggle inclusion of creator info into exported file
10712 (@code{org-export-with-creator}).
10715 @vindex org-export-with-drawers
10716 Toggle inclusion of drawers, or list drawers to include
10717 (@code{org-export-with-drawers}).
10720 @vindex org-export-with-date
10721 Toggle inclusion of a date into exported file (@code{org-export-with-date}).
10724 @vindex org-export-with-entities
10725 Toggle inclusion of entities (@code{org-export-with-entities}).
10728 @vindex org-export-with-email
10729 Toggle inclusion of the author's e-mail into exported file
10730 (@code{org-export-with-email}).
10733 @vindex org-export-with-footnotes
10734 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10737 @vindex org-export-headline-levels
10738 Set the number of headline levels for export
10739 (@code{org-export-headline-levels}). Below that level, headlines are treated
10740 differently. In most back-ends, they become list items.
10743 @vindex org-export-with-inlinetasks
10744 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10747 @vindex org-export-with-section-numbers
10748 @cindex property, UNNUMBERED
10749 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10750 be set to a number @samp{n}, so only headlines at that level or above will be
10751 numbered. Finally, irrespective of the level of a specific headline, the
10752 numbering of it can be disabled by setting the @code{UNNUMBERED} property to
10753 non-@code{nil}. This also affects subheadings.
10756 @vindex org-export-with-planning
10757 Toggle export of planning information (@code{org-export-with-planning}).
10758 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10759 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10762 @vindex org-export-with-priority
10763 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10766 @vindex org-export-with-properties
10767 Toggle inclusion of property drawers, or list properties to include
10768 (@code{org-export-with-properties}).
10771 @vindex org-export-with-statistics-cookies
10772 Toggle inclusion of statistics cookies
10773 (@code{org-export-with-statistics-cookies}).
10776 @vindex org-export-with-tags
10777 Toggle inclusion of tags, may also be @code{not-in-toc}
10778 (@code{org-export-with-tags}).
10781 @vindex org-export-with-tasks
10782 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10783 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10784 (@code{org-export-with-tasks}).
10787 @vindex org-export-with-latex
10788 Configure export of @LaTeX{} fragments and environments. It may be set to
10789 @code{verbatim} (@code{org-export-with-latex}).
10792 @vindex org-export-time-stamp-file
10793 Toggle inclusion of the creation time into exported file
10794 (@code{org-export-time-stamp-file}).
10797 @vindex org-export-with-title
10798 Toggle inclusion of title (@code{org-export-with-title}).
10801 @vindex org-export-with-toc
10802 Toggle inclusion of the table of contents, or set the level limit
10803 (@code{org-export-with-toc}).
10806 @vindex org-export-with-todo-keywords
10807 Toggle inclusion of TODO keywords into exported text
10808 (@code{org-export-with-todo-keywords}).
10811 @vindex org-export-with-tables
10812 Toggle inclusion of tables (@code{org-export-with-tables}).
10816 When exporting only a subtree, each of the previous keywords@footnote{With
10817 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10818 properties. These begin with @samp{EXPORT_}, followed by the name of the
10819 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10820 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10824 @vindex org-export-allow-bind-keywords
10825 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10826 can become buffer-local during export by using the BIND keyword. Its syntax
10827 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10828 settings that cannot be changed using specific keywords.
10830 @cindex property, EXPORT_FILE_NAME
10831 The name of the output file to be generated is taken from the file associated
10832 to the buffer, when possible, or asked to you otherwise. For subtree export,
10833 you can also set @code{EXPORT_FILE_NAME} property. In all cases, only the
10834 base name of the file is retained, and a back-end specific extension is
10837 @node Include files
10838 @section Include files
10839 @cindex include files, during export
10841 During export, you can include the content of another file. For example, to
10842 include your @file{.emacs} file, you could use:
10846 #+INCLUDE: "~/.emacs" src emacs-lisp
10850 The first parameter names the the file to include. The optional second and
10851 third parameter specify the markup (i.e., @samp{example}, @samp{export} or
10852 @samp{src}), and, if the markup is either @samp{export} or @samp{src}, the
10853 language for formatting the contents.
10855 If markup is requested, the included content will be placed within an
10856 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10857 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10858 of content that is permissible}. No changes to the included content are made
10859 and it is the responsibility of the user to ensure that the result is valid
10860 Org syntax. For markup @samp{example} and @samp{src}, which is requesting a
10861 literal example, the content will be code-escaped before inclusion.
10863 If no markup is requested, the text will be assumed to be in Org mode format
10864 and will be processed normally. However, footnote labels (@pxref{Footnotes})
10865 in the file will be made local to that file. Contents of the included file
10866 will belong to the same structure (headline, item) containing the
10867 @code{INCLUDE} keyword. In particular, headlines within the file will become
10868 children of the current section. That behavior can be changed by providing
10869 an additional keyword parameter, @code{:minlevel}. In that case, all
10870 headlines in the included file will be shifted so the one with the lowest
10871 level reaches that specified level. For example, to make a file become a
10872 sibling of the current top-level headline, use
10875 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10878 You can also include a portion of a file by specifying a lines range using
10879 the @code{:lines} keyword parameter. The line at the upper end of the range
10880 will not be included. The start and/or the end of the range may be omitted
10881 to use the obvious defaults.
10884 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
10885 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
10886 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
10889 Finally, you may use a file-link to extract an object as matched by
10890 @code{org-link-search}@footnote{Note that
10891 @code{org-link-search-must-match-exact-headline} is locally bound to non-@code{nil}.
10892 Therefore, @code{org-link-search} only matches headlines and named elements.}
10893 (@pxref{Search options}). If the @code{:only-contents} property is non-@code{nil},
10894 only the contents of the requested element will be included, omitting
10895 properties drawer and planning-line if present. The @code{:lines} keyword
10896 operates locally with respect to the requested element. Some examples:
10899 #+INCLUDE: "./paper.org::#theory" :only-contents t
10900 @r{Include the body of the heading with the custom id @samp{theory}}
10901 #+INCLUDE: "./paper.org::mytable" @r{Include named element.}
10902 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10903 @r{Include the first 20 lines of the headline named @samp{conclusion}.}
10909 Visit the include file at point.
10912 @node Macro replacement
10913 @section Macro replacement
10914 @cindex macro replacement, during export
10917 You can define text snippets with
10920 #+MACRO: name replacement text $1, $2 are arguments
10923 @noindent which can be referenced
10924 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10925 commas within arguments have to be escaped with a backslash character.
10926 Conversely, backslash characters before a comma, and only them, need to be
10927 escaped with another backslash character.}.
10929 These references, called macros, can be inserted anywhere Org markup is
10930 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10931 They can also be used in keywords accepting Org syntax, e.g.,
10932 @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR}, @code{#+DATE} and some
10933 others, export back-end specific, ones.
10935 In addition to user-defined macros, a set of predefined macros can be used:
10938 @item @{@{@{title@}@}@}
10939 @itemx @{@{@{author@}@}@}
10940 @itemx @{@{@{email@}@}@}
10941 @cindex title, macro
10942 @cindex author, macro
10943 @cindex email, macro
10944 These macros are replaced with the information available at the time of
10947 @item @{@{@{date@}@}@}
10948 @itemx @{@{@{date(@var{FORMAT})@}@}@}
10949 @cindex date, macro
10950 This macro refers to the @code{#+DATE} keyword. @var{FORMAT} is an optional
10951 argument to the @code{@{@{@{date@}@}@}} macro that will be used only if
10952 @code{#+DATE} is a single timestamp. @var{FORMAT} should be a format string
10953 understood by @code{format-time-string}.
10955 @item @{@{@{time(@var{FORMAT})@}@}@}
10956 @itemx @{@{@{modification-time(@var{FORMAT}, @var{VC})@}@}@}
10957 @cindex time, macro
10958 @cindex modification time, macro
10959 These macros refer to the date and time when the document is exported and to
10960 the modification date and time, respectively. @var{FORMAT} should be a
10961 format string understood by @code{format-time-string}. If the second
10962 argument to the @code{modification-time} macro is non-@code{nil}, Org
10963 retrieves the information from the version control system, using
10964 @file{vc.el}, instead of the file attributes.
10966 @item @{@{@{input-file@}@}@}
10967 @cindex input file, macro
10968 This macro refers to the filename of the exported file, if any.
10970 @item @{@{@{property(@var{PROPERTY-NAME})@}@}@}
10971 @itemx @{@{@{property(@var{PROPERTY-NAME},@var{SEARCH-OPTION})@}@}@}
10972 @cindex property, macro
10973 This macro returns the value of property @var{PROPERTY-NAME} in current
10974 entry. If @var{SEARCH-OPTION} (@pxref{Search options}) refers to a remote
10975 entry, it will be used instead.
10978 The surrounding brackets can be made invisible by setting
10979 @code{org-hide-macro-markers} non-@code{nil}.
10981 Macro expansion takes place during the very beginning of the export process.
10983 @node ASCII/Latin-1/UTF-8 export
10984 @section ASCII/Latin-1/UTF-8 export
10985 @cindex ASCII export
10986 @cindex Latin-1 export
10987 @cindex UTF-8 export
10989 ASCII export produces a simple and very readable version of an Org mode
10990 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10991 with special characters and symbols available in these encodings.
10993 @vindex org-ascii-text-width
10994 Upon exporting, text is filled and justified, when appropriate, according the
10995 text width set in @code{org-ascii-text-width}.
10997 @vindex org-ascii-links-to-notes
10998 Links are exported in a footnote-like style, with the descriptive part in the
10999 text and the link in a note before the next heading. See the variable
11000 @code{org-ascii-links-to-notes} for details and other options.
11002 @subheading ASCII export commands
11005 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
11006 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
11007 will be @file{myfile.txt}. The file will be overwritten without warning.
11008 When the original file is @file{myfile.txt}, the resulting file becomes
11009 @file{myfile.txt.txt} in order to prevent data loss.
11010 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
11011 Export to a temporary buffer. Do not create a file.
11014 @subheading ASCII specific export settings
11016 ASCII export introduces a single of keywords, similar to the general options
11017 settings described in @ref{Export settings}.
11021 @cindex #+SUBTITLE (ASCII)
11022 The document subtitle.
11025 @subheading Header and sectioning structure
11027 In the exported version, the first three outline levels become headlines,
11028 defining a general document structure. Additional levels are exported as
11029 lists. The transition can also occur at a different level (@pxref{Export
11032 @subheading Quoting ASCII text
11034 You can insert text that will only appear when using @code{ASCII} back-end
11035 with the following constructs:
11038 @cindex #+BEGIN_EXPORT ascii
11040 Text @@@@ascii:and additional text@@@@ within a paragraph.
11044 #+BEGIN_EXPORT ascii
11045 All lines in this block will appear only when using this back-end.
11049 @subheading ASCII specific attributes
11050 @cindex #+ATTR_ASCII
11051 @cindex horizontal rules, in ASCII export
11053 @code{ASCII} back-end only understands one attribute, @code{:width}, which
11054 specifies the length, in characters, of a given horizontal rule. It must be
11055 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
11058 #+ATTR_ASCII: :width 10
11062 @subheading ASCII special blocks
11063 @cindex special blocks, in ASCII export
11064 @cindex #+BEGIN_JUSTIFYLEFT
11065 @cindex #+BEGIN_JUSTIFYRIGHT
11067 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
11068 possible to justify contents to the left or the right of the page with the
11069 following dedicated blocks.
11072 #+BEGIN_JUSTIFYLEFT
11073 It's just a jump to the left...
11076 #+BEGIN_JUSTIFYRIGHT
11077 ...and then a step to the right.
11081 @node Beamer export
11082 @section Beamer export
11083 @cindex Beamer export
11085 The @LaTeX{} class @emph{Beamer} allows production of high quality
11086 presentations using @LaTeX{} and PDF processing. Org mode has special
11087 support for turning an Org mode file or tree into a Beamer presentation.
11090 * Beamer export commands:: How to export Beamer documents.
11091 * Beamer specific export settings:: Export settings for Beamer export.
11092 * Sectioning Frames and Blocks in Beamer:: Blocks and sections in Beamer.
11093 * Beamer specific syntax:: Syntax specific to Beamer.
11094 * Editing support:: Helper functions for Org Beamer export.
11095 * A Beamer Example:: An complete Beamer example.
11098 @node Beamer export commands
11099 @subsection Beamer export commands
11102 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
11103 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11104 file will be @file{myfile.tex}. The file will be overwritten without
11106 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
11107 Export to a temporary buffer. Do not create a file.
11108 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
11109 Export as @LaTeX{} and then process to PDF.
11111 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11114 @node Beamer specific export settings
11115 @subsection Beamer specific export settings
11117 Beamer export introduces a number of keywords, similar to the general options
11118 settings described in @ref{Export settings}.
11122 @cindex #+BEAMER_THEME
11123 @vindex org-beamer-theme
11124 The Beamer theme (@code{org-beamer-theme}). Options can be specified via
11125 brackets, for example:
11127 #+BEAMER_THEME: Rochester [height=20pt]
11130 @item BEAMER_FONT_THEME
11131 @cindex #+BEAMER_FONT_THEME
11132 The Beamer font theme.
11134 @item BEAMER_INNER_THEME
11135 @cindex #+BEAMER_INNER_THEME
11136 The Beamer inner theme.
11138 @item BEAMER_OUTER_THEME
11139 @cindex #+BEAMER_OUTER_THEME
11140 The Beamer outer theme.
11142 @item BEAMER_HEADER
11143 @cindex #+BEAMER_HEADER
11144 Arbitrary lines inserted into the preamble, just before the @samp{hyperref}
11148 @cindex #+DESCRIPTION (Beamer)
11149 The document description. By default these are inserted as metadata using
11150 @samp{hyperref}. Document metadata can be configured via
11151 @code{org-latex-hyperref-template}. Description can also be typeset as part
11152 of the front matter via @code{org-latex-title-command}. You can use several
11153 @code{#+DESCRIPTION} keywords if the description is is long.
11156 @cindex #+KEYWORDS (Beamer)
11157 The keywords defining the contents of the document. By default these are
11158 inserted as metadata using @samp{hyperref}. Document metadata can be
11159 configured via @code{org-latex-hyperref-template}. Description can also be
11160 typeset as part of the front matter via @code{org-latex-title-command}. You
11161 can use several @code{#+KEYWORDS} if the description is is long.
11164 @cindex #+SUBTITLE (Beamer)
11165 @vindex org-beamer-subtitle-format
11166 The document subtitle. This is typeset using the format string
11167 @code{org-beamer-subtitle-format}. It can also access via
11168 @code{org-latex-hyperref-template} or typeset as part of the front
11169 matter via @code{org-latex-title-command}.
11172 @node Sectioning Frames and Blocks in Beamer
11173 @subsection Sectioning, Frames and Blocks in Beamer
11175 Any tree with not-too-deep level nesting should in principle be exportable as
11176 a Beamer presentation. Headlines fall into three categories: sectioning
11177 elements, frames and blocks.
11181 @vindex org-beamer-frame-level
11182 Headlines become frames when their level is equal to
11183 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
11184 (@pxref{Export settings}).
11186 @cindex property, BEAMER_ENV
11187 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
11188 set to either to @code{frame} or @code{fullframe}, its level overrides the
11189 variable. A @code{fullframe} is a frame with an empty (ignored) title.
11192 @vindex org-beamer-environments-default
11193 @vindex org-beamer-environments-extra
11194 All frame's children become @code{block} environments. Special block types
11195 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
11196 this property is set, the entry will also get a @code{:B_environment:} tag to
11197 make this visible. This tag has no semantic meaning, it is only a visual
11198 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
11199 supported values and @code{org-beamer-environments-extra} for adding more).
11202 @cindex property, BEAMER_REF
11203 As a special case, if the @code{BEAMER_ENV} property is set to either
11204 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
11205 headline will become, respectively, an appendix, a note (within frame or
11206 between frame, depending on its level), a note with its title ignored or an
11207 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
11208 is mandatory in order to refer to the frame being resumed, and contents are
11211 Also, a headline with an @code{ignoreheading} environment will have its
11212 contents only inserted in the output. This special value is useful to have
11213 data between frames, or to properly close a @code{column} environment.
11216 @cindex property, BEAMER_ACT
11217 @cindex property, BEAMER_OPT
11218 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
11219 The former is translated as an overlay/action specification, or a default
11220 overlay specification when enclosed within square brackets. The latter
11221 specifies options@footnote{The @code{fragile} option is added automatically
11222 if it contains code that requires a verbatim environment, though.} for the
11223 current frame or block. The export back-end will automatically wrap
11224 properties within angular or square brackets when appropriate.
11226 @cindex property, BEAMER_COL
11227 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
11228 be a decimal number representing the width of the column as a fraction of the
11229 total text width. If the headline has no specific environment, its title
11230 will be ignored and its contents will fill the column created. Otherwise,
11231 the block will fill the whole column and the title will be preserved. Two
11232 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
11233 @code{columns} @LaTeX{} environment. It will end before the next headline
11234 without such a property. This environment is generated automatically.
11235 Although, it can also be explicitly created, with a special @code{columns}
11236 value for @code{BEAMER_ENV} property (if it needs to be set up with some
11237 specific options, for example).
11239 @node Beamer specific syntax
11240 @subsection Beamer specific syntax
11242 The Beamer back-end is an extension of the @LaTeX{} back-end. As such, all
11243 @LaTeX{} specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
11244 recognized. See @ref{@LaTeX{} export} for more information.
11246 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11247 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
11248 keyword (@pxref{Table of contents}) are not. In that case, it is also
11249 possible to specify options, enclosed within square brackets.
11252 #+TOC: headlines [currentsection]
11255 Beamer specific code can be inserted with the following constructs:
11258 @cindex #+BEGIN_EXPORT beamer
11262 #+BEGIN_EXPORT beamer
11263 All lines in this block will appear only when using this back-end.
11266 Text @@@@beamer:some code@@@@ within a paragraph.
11269 In particular, this last example can be used to add overlay specifications to
11270 objects whose type is among @code{bold}, @code{item}, @code{link},
11271 @code{radio-target} and @code{target}, when the value is enclosed within
11272 angular brackets and put at the beginning the object.
11275 A *@@@@beamer:<2->@@@@useful* feature
11278 @cindex #+ATTR_BEAMER
11279 Eventually, every plain list has support for @code{:environment},
11280 @code{:overlay} and @code{:options} attributes through
11281 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
11282 of a different environment, the second sets overlay specifications and
11283 the last one inserts optional arguments in current list environment.
11286 #+ATTR_BEAMER: :overlay +-
11291 @node Editing support
11292 @subsection Editing support
11294 You can turn on a special minor mode @code{org-beamer-mode} for faster
11302 @orgcmd{C-c C-b,org-beamer-select-environment}
11303 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11304 environment or the @code{BEAMER_COL} property.
11307 @node A Beamer Example
11308 @subsection A Beamer example
11310 Here is a simple example Org document that is intended for Beamer export.
11313 #+TITLE: Example Presentation
11314 #+AUTHOR: Carsten Dominik
11315 #+OPTIONS: H:2 toc:t num:t
11316 #+LATEX_CLASS: beamer
11317 #+LATEX_CLASS_OPTIONS: [presentation]
11318 #+BEAMER_THEME: Madrid
11319 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11321 * This is the first structural section
11324 *** Thanks to Eric Fraga :B_block:
11329 for the first viable Beamer setup in Org
11330 *** Thanks to everyone else :B_block:
11336 for contributing to the discussion
11337 **** This will be formatted as a beamer note :B_note:
11341 ** Frame 2 (where we will not use columns)
11343 Please test this stuff!
11347 @section HTML export
11348 @cindex HTML export
11350 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11351 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11352 language, but with additional support for tables.
11355 * HTML Export commands:: How to invoke HTML export
11356 * HTML Specific export settings:: Export settings for HTML export
11357 * HTML doctypes:: Org can export to various (X)HTML flavors
11358 * HTML preamble and postamble:: How to insert a preamble and a postamble
11359 * Quoting HTML tags:: Using direct HTML in Org mode
11360 * Links in HTML export:: How links will be interpreted and formatted
11361 * Tables in HTML export:: How to modify the formatting of tables
11362 * Images in HTML export:: How to insert figures into HTML output
11363 * Math formatting in HTML export:: Beautiful math also on the web
11364 * Text areas in HTML export:: An alternative way to show an example
11365 * CSS support:: Changing the appearance of the output
11366 * JavaScript support:: Info and Folding in a web browser
11370 @node HTML Export commands
11371 @subsection HTML export commands
11374 @orgcmd{C-c C-e h h,org-html-export-to-html}
11375 Export as an HTML file. For an Org file @file{myfile.org},
11376 the HTML file will be @file{myfile.html}. The file will be overwritten
11379 Export as an HTML file and immediately open it with a browser.
11380 @orgcmd{C-c C-e h H,org-html-export-as-html}
11381 Export to a temporary buffer. Do not create a file.
11384 @c FIXME Exporting sublevels
11385 @c @cindex headline levels, for exporting
11386 @c In the exported version, the first 3 outline levels will become headlines,
11387 @c defining a general document structure. Additional levels will be exported as
11388 @c itemized lists. If you want that transition to occur at a different level,
11389 @c specify it with a numeric prefix argument. For example,
11392 @c @kbd{C-2 C-c C-e b}
11396 @c creates two levels of headings and does the rest as items.
11398 @node HTML Specific export settings
11399 @subsection HTML Specific export settings
11400 HTML export introduces a number of keywords, similar to the general options
11401 settings described in @ref{Export settings}.
11405 @cindex #+DESCRIPTION (HTML)
11406 The document description. This description is inserted as a HTML meta tag.
11407 You can use several such keywords if the list is long.
11410 @cindex #+HTML_DOCTYPE
11411 @vindex org-html-doctype
11412 The document type, e.g. HTML5, (@code{org-html-doctype}).
11414 @item HTML_CONTAINER
11415 @cindex #+HTML_CONTAINER
11416 @vindex org-html-container-element
11417 The container, e.g. @samp{div}, used to wrap sections and elements
11418 (@code{org-html-container-element}).
11420 @item HTML_LINK_HOME
11421 @cindex #+HTML_LINK_HOME
11422 @vindex org-html-link-home
11423 The home link URL (@code{org-html-link-home}).
11426 @cindex #+HTML_LINK_UP
11427 @vindex org-html-link-up
11428 The up link URL (@code{org-html-link-up}).
11431 @cindex #+HTML_MATHJAX
11432 @vindex org-html-mathjax-options
11433 Options for the MathJax (@code{org-html-mathjax-options}). MathJax is used
11434 to typeset @LaTeX{} math in HTML documents. @ref{Math formatting in HTML
11435 export} contains an example.
11438 @cindex #+HTML_HEAD
11439 @vindex org-html-head
11440 Arbitrary lines appended to the end of the head of the document
11441 (@code{org-html-head}).
11443 @item HTML_HEAD_EXTRA
11444 @cindex #+HTML_HEAD_EXTRA
11445 @vindex org-html-head-extra
11446 Arbitrary lines appended to the end of the header of the document
11447 (@code{org-html-head-extra}).
11450 @cindex #+KEYWORDS (HTML)
11451 The keywords defining the contents of the document. This description is
11452 inserted as a HTML meta tag. You can use several such keywords if the list
11456 @cindex #+LATEX_HEADER (HTML)
11457 Arbitrary lines appended to the preamble used when transcoding @LaTeX{}
11458 fragments to images. See @ref{Math formatting in HTML export} for details.
11461 @cindex #+SUBTILE (HTML)
11462 The document subtitle. The formatting depends on whether HTML5 in used
11463 and on the @samp{subtitle} CSS class.
11466 These keywords are treated in details in the following sections.
11468 @node HTML doctypes
11469 @subsection HTML doctypes
11471 Org can export to various (X)HTML flavors.
11473 @vindex org-html-doctype
11474 @vindex org-html-doctype-alist
11475 Setting the variable @code{org-html-doctype} allows you to export to different
11476 (X)HTML variants. The exported HTML will be adjusted according to the syntax
11477 requirements of that variant. You can either set this variable to a doctype
11478 string directly, in which case the exporter will try to adjust the syntax
11479 automatically, or you can use a ready-made doctype. The ready-made options
11486 ``html4-transitional''
11492 ``xhtml-transitional''
11503 @noindent See the variable @code{org-html-doctype-alist} for details. The default is
11506 @vindex org-html-html5-fancy
11507 @cindex HTML5, export new elements
11508 HTML5 introduces several new element types. By default, Org will not make
11509 use of these element types, but you can set @code{org-html-html5-fancy} to
11510 non-@code{nil} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11511 enable a few new block-level elements. These are created using arbitrary
11512 #+BEGIN and #+END blocks. For instance:
11531 #+ATTR_HTML: :controls controls :width 350
11533 #+HTML: <source src="movie.mp4" type="video/mp4">
11534 #+HTML: <source src="movie.ogg" type="video/ogg">
11535 Your browser does not support the video tag.
11542 <video controls="controls" width="350">
11543 <source src="movie.mp4" type="video/mp4">
11544 <source src="movie.ogg" type="video/ogg">
11545 <p>Your browser does not support the video tag.</p>
11549 @vindex org-html-html5-elements
11550 Special blocks that do not correspond to HTML5 elements (see
11551 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11552 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11554 Headlines cannot appear within special blocks. To wrap a headline and its
11555 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11556 @code{HTML_CONTAINER} property on the headline itself.
11558 @node HTML preamble and postamble
11559 @subsection HTML preamble and postamble
11560 @vindex org-html-preamble
11561 @vindex org-html-postamble
11562 @vindex org-html-preamble-format
11563 @vindex org-html-postamble-format
11564 @vindex org-html-validation-link
11565 @vindex org-export-creator-string
11566 @vindex org-export-time-stamp-file
11568 The HTML exporter lets you define a preamble and a postamble.
11570 The default value for @code{org-html-preamble} is @code{t}, which means
11571 that the preamble is inserted depending on the relevant format string in
11572 @code{org-html-preamble-format}.
11574 Setting @code{org-html-preamble} to a string will override the default format
11575 string. If you set it to a function, it will insert the output of the
11576 function, which must be a string. Setting to @code{nil} will not insert any
11579 The default value for @code{org-html-postamble} is @code{'auto}, which means
11580 that the HTML exporter will look for information about the author, the email,
11581 the creator and the date, and build the postamble from these values. Setting
11582 @code{org-html-postamble} to @code{t} will insert the postamble from the
11583 relevant format string found in @code{org-html-postamble-format}. Setting it
11584 to @code{nil} will not insert any postamble.
11586 @node Quoting HTML tags
11587 @subsection Quoting HTML tags
11589 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11590 @samp{>} in HTML export. If you want to include raw HTML code, which
11591 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11592 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11593 that should be copied verbatim to the exported file use either
11596 @cindex #+BEGIN_EXPORT html
11598 #+HTML: Literal HTML code for export
11602 @cindex #+BEGIN_EXPORT html
11605 #+BEGIN_EXPORT html
11606 All lines between these markers are exported literally
11611 @node Links in HTML export
11612 @subsection Links in HTML export
11614 @cindex links, in HTML export
11615 @cindex internal links, in HTML export
11616 @cindex external links, in HTML export
11617 @vindex org-html-link-org-files-as-html
11618 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11619 includes automatic links created by radio targets (@pxref{Radio
11620 targets}). Links to external files will still work if the target file is on
11621 the same @i{relative} path as the published Org file. Links to other
11622 @file{.org} files will be translated into HTML links under the assumption
11623 that an HTML version also exists of the linked file, at the same relative
11624 path; setting @code{org-html-link-org-files-as-html} to @code{nil} disables
11625 this translation. @samp{id:} links can then be used to jump to specific
11626 entries across files. For information related to linking files while
11627 publishing them to a publishing directory see @ref{Publishing links}.
11629 If you want to specify attributes for links, you can do so using a special
11630 @code{#+ATTR_HTML} line to define attributes that will be added to the
11631 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11632 and @code{style} attributes for a link:
11634 @cindex #+ATTR_HTML
11636 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11637 [[http://orgmode.org]]
11640 @node Tables in HTML export
11641 @subsection Tables in HTML export
11642 @cindex tables, in HTML
11643 @vindex org-html-table-default-attributes
11645 Org mode tables are exported to HTML using the table attributes defined in
11646 @code{org-html-table-default-attributes}. The default setting makes tables
11647 without cell borders and frame. If you would like to change this for
11648 individual tables, place something like the following before the table:
11651 @cindex #+ATTR_HTML
11653 #+CAPTION: This is a table with lines around and between cells
11654 #+ATTR_HTML: :border 2 :rules all :frame border
11657 You can also group columns in the HTML output (@pxref{Column groups}).
11659 Below is a list of options for customizing tables HTML export.
11662 @vindex org-html-table-align-individual-fields
11663 @item org-html-table-align-individual-fields
11664 Non-@code{nil} means attach style attributes for alignment to each table field.
11666 @vindex org-html-table-caption-above
11667 @item org-html-table-caption-above
11668 When non-@code{nil}, place caption string at the beginning of the table.
11670 @vindex org-html-table-data-tags
11671 @item org-html-table-data-tags
11672 The opening and ending tags for table data fields.
11674 @vindex org-html-table-default-attributes
11675 @item org-html-table-default-attributes
11676 Default attributes and values which will be used in table tags.
11678 @vindex org-html-table-header-tags
11679 @item org-html-table-header-tags
11680 The opening and ending tags for table header fields.
11682 @vindex org-html-table-row-tags
11683 @item org-html-table-row-tags
11684 The opening and ending tags for table rows.
11686 @vindex org-html-table-use-header-tags-for-first-column
11687 @item org-html-table-use-header-tags-for-first-column
11688 Non-@code{nil} means format column one in tables with header tags.
11691 @node Images in HTML export
11692 @subsection Images in HTML export
11694 @cindex images, inline in HTML
11695 @cindex inlining images in HTML
11696 @vindex org-html-inline-images
11697 HTML export can inline images given as links in the Org file, and
11698 it can make an image the clickable part of a link. By
11699 default@footnote{But see the variable
11700 @code{org-html-inline-images}.}, images are inlined if a link does
11701 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11702 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11703 @samp{the image} that points to the image. If the description part
11704 itself is a @code{file:} link or a @code{http:} URL pointing to an
11705 image, this image will be inlined and activated so that clicking on the
11706 image will activate the link. For example, to include a thumbnail that
11707 will link to a high resolution version of the image, you could use:
11710 [[file:highres.jpg][file:thumb.jpg]]
11713 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11714 In the example below we specify the @code{alt} and @code{title} attributes to
11715 support text viewers and accessibility, and align it to the right.
11718 @cindex #+ATTR_HTML
11720 #+CAPTION: A black cat stalking a spider
11721 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11726 You could use @code{http} addresses just as well.
11728 @node Math formatting in HTML export
11729 @subsection Math formatting in HTML export
11733 @cindex imagemagick
11735 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11736 different ways on HTML pages. The default is to use
11737 @uref{http://www.mathjax.org, MathJax} which should work out of the box with
11738 Org@footnote{By default Org loads MathJax from
11739 @uref{http://docs.mathjax.org/en/latest/start.html#using-the-mathjax-content-delivery-network-cdn,
11740 MathJax.org}. A link to the terms of service of the MathJax CDN can be found
11741 in the docstring of @code{org-html-mathjax-options}.}. Some MathJax display
11742 options can be configured via @code{org-html-mathjax-options}, or in the
11743 buffer. For example, with the following settings,
11745 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
11747 equation labels will be displayed on the left marign and equations will be
11748 five ems from the left margin.
11750 @noindent See the docstring of
11751 @code{org-html-mathjax-options} for all supported variables. The MathJax
11752 template can be configure via @code{org-html-mathjax-template}.
11754 If you prefer, you can also request that @LaTeX{} fragments are processed
11755 into small images that will be inserted into the browser page. Before the
11756 availability of MathJax, this was the default method for Org files. This
11757 method requires that the @file{dvipng} program, @file{dvisvgm} or
11758 @file{imagemagick} suite is available on your system. You can still get
11759 this processing with
11762 #+OPTIONS: tex:dvipng
11766 #+OPTIONS: tex:dvisvgm
11772 #+OPTIONS: tex:imagemagick
11775 @node Text areas in HTML export
11776 @subsection Text areas in HTML export
11778 @cindex text areas, in HTML
11779 An alternative way to publish literal code examples in HTML is to use text
11780 areas, where the example can even be edited before pasting it into an
11781 application. It is triggered by @code{:textarea} attribute at an
11782 @code{example} or @code{src} block.
11784 You may also use @code{:height} and @code{:width} attributes to specify the
11785 height and width of the text area, which default to the number of lines in
11786 the example, and 80, respectively. For example
11789 #+ATTR_HTML: :textarea t :width 40
11791 (defun org-xor (a b)
11799 @subsection CSS support
11800 @cindex CSS, for HTML export
11801 @cindex HTML export, CSS
11803 @vindex org-html-todo-kwd-class-prefix
11804 @vindex org-html-tag-class-prefix
11805 You can modify the CSS style definitions for the exported file. The HTML
11806 exporter assigns the following special CSS classes@footnote{If the classes on
11807 TODO keywords and tags lead to conflicts, use the variables
11808 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11809 make them unique.} to appropriate parts of the document---your style
11810 specifications may change these, in addition to any of the standard classes
11811 like for headlines, tables, etc.
11813 p.author @r{author information, including email}
11814 p.date @r{publishing date}
11815 p.creator @r{creator info, about org mode version}
11816 .title @r{document title}
11817 .subtitle @r{document subtitle}
11818 .todo @r{TODO keywords, all not-done states}
11819 .done @r{the DONE keywords, all states that count as done}
11820 .WAITING @r{each TODO keyword also uses a class named after itself}
11821 .timestamp @r{timestamp}
11822 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11823 .timestamp-wrapper @r{span around keyword plus timestamp}
11824 .tag @r{tag in a headline}
11825 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11826 .target @r{target for links}
11827 .linenr @r{the line number in a code example}
11828 .code-highlighted @r{for highlighting referenced code lines}
11829 div.outline-N @r{div for outline level N (headline plus text))}
11830 div.outline-text-N @r{extra div for text at outline level N}
11831 .section-number-N @r{section number in headlines, different for each level}
11832 .figure-number @r{label like "Figure 1:"}
11833 .table-number @r{label like "Table 1:"}
11834 .listing-number @r{label like "Listing 1:"}
11835 div.figure @r{how to format an inlined image}
11836 pre.src @r{formatted source code}
11837 pre.example @r{normal example}
11838 p.verse @r{verse paragraph}
11839 div.footnotes @r{footnote section headline}
11840 p.footnote @r{footnote definition paragraph, containing a footnote}
11841 .footref @r{a footnote reference number (always a <sup>)}
11842 .footnum @r{footnote number in footnote definition (always <sup>)}
11845 @vindex org-html-style-default
11846 @vindex org-html-head-include-default-style
11847 @vindex org-html-head
11848 @vindex org-html-head-extra
11849 @cindex #+HTML_INCLUDE_STYLE
11850 Each exported file contains a compact default style that defines these
11851 classes in a basic way@footnote{This style is defined in the constant
11852 @code{org-html-style-default}, which you should not modify. To turn
11853 inclusion of these defaults off, customize
11854 @code{org-html-head-include-default-style} or set @code{html-style} to
11855 @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or
11856 add to them by using the variables @code{org-html-head} and
11857 @code{org-html-head-extra}. You can override the global values of these
11858 variables for each file by using these keywords:
11860 @cindex #+HTML_HEAD
11861 @cindex #+HTML_HEAD_EXTRA
11863 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11864 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11868 For longer style definitions, you can use several such lines. You could also
11869 directly write a @code{<style>} @code{</style>} section in this way, without
11870 referring to an external file.
11872 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11873 property to assign a class to the tree. In order to specify CSS styles for a
11874 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11877 @c FIXME: More about header and footer styles
11878 @c FIXME: Talk about links and targets.
11880 @node JavaScript support
11881 @subsection JavaScript supported display of web pages
11883 @cindex Rose, Sebastian
11884 Sebastian Rose has written a JavaScript program especially designed to
11885 enhance the web viewing experience of HTML files created with Org. This
11886 program allows you to view large files in two different ways. The first one
11887 is an @emph{Info}-like mode where each section is displayed separately and
11888 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11889 as well, press @kbd{?} for an overview of the available keys). The second
11890 view type is a @emph{folding} view much like Org provides inside Emacs. The
11891 script is available at @url{http://orgmode.org/org-info.js} and you can find
11892 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11893 We host the script at our site, but if you use it a lot, you might not want
11894 to be dependent on @url{http://orgmode.org} and prefer to install a local
11895 copy on your own web server.
11897 All it then takes to use this program is adding a single line to the Org
11900 @cindex #+INFOJS_OPT
11902 #+INFOJS_OPT: view:info toc:nil
11906 If this line is found, the HTML header will automatically contain the code
11907 needed to invoke the script. Using the line above, you can set the following
11911 path: @r{The path to the script. The default is to grab the script from}
11912 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11913 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11914 view: @r{Initial view when the website is first shown. Possible values are:}
11915 info @r{Info-like interface with one section per page.}
11916 overview @r{Folding interface, initially showing only top-level.}
11917 content @r{Folding interface, starting with all headlines visible.}
11918 showall @r{Folding interface, all headlines and text visible.}
11919 sdepth: @r{Maximum headline level that will still become an independent}
11920 @r{section for info and folding modes. The default is taken from}
11921 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11922 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11923 @r{info/folding section can still contain child headlines.}
11924 toc: @r{Should the table of contents @emph{initially} be visible?}
11925 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11926 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11927 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11928 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11929 @r{If yes, the toc will never be displayed as a section.}
11930 ltoc: @r{Should there be short contents (children) in each section?}
11931 @r{Make this @code{above} if the section should be above initial text.}
11932 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11933 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11934 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11935 @r{default), only one such button will be present.}
11938 @vindex org-html-infojs-options
11939 @vindex org-html-use-infojs
11940 You can choose default values for these options by customizing the variable
11941 @code{org-html-infojs-options}. If you always want to apply the script to your
11942 pages, configure the variable @code{org-html-use-infojs}.
11944 @node @LaTeX{} export
11945 @section @LaTeX{} export
11946 @cindex @LaTeX{} export
11949 The @LaTeX{} exporter can produce an arbitrarily complex @LaTeX{} document of
11950 any standard or custom document class@footnote{The @LaTeX{} exporter can be
11951 configured to support alternative @LaTeX{} engines (see
11952 @code{org-latex-compiler}), build sequences (see
11953 @code{org-latex-pdf-process}), and packages, (see
11954 @code{org-latex-default-packages-alist} and
11955 @code{org-latex-packages-alist}).}. The Org @LaTeX{} exporter is geared
11956 towards producing fully-linked PDF output.
11958 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11959 will not be started if two contiguous syntactical elements are not separated
11963 * @LaTeX{} export commands:: How to export to @LaTeX{} and PDF
11964 * @LaTeX{} specific export settings:: Export settings for @LaTeX{}
11965 * @LaTeX{} header and sectioning:: Setting up the export file structure
11966 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11967 * Tables in @LaTeX{} export:: Specific attributes for tables
11968 * Images in @LaTeX{} export:: Specific attributes for images
11969 * Plain lists in @LaTeX{} export:: Specific attributes for plain lists
11970 * Source blocks in @LaTeX{} export:: Specific attributes for source blocks
11971 * Example blocks in @LaTeX{} export:: Specific attributes for example blocks
11972 * Special blocks in @LaTeX{} export:: Specific attributes for special blocks
11973 * Horizontal rules in @LaTeX{} export:: Specific attributes for horizontal rules
11976 @node @LaTeX{} export commands
11977 @subsection @LaTeX{} export commands
11980 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11981 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11982 file will be @file{myfile.tex}. The file will be overwritten without
11984 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11985 Export to a temporary buffer. Do not create a file.
11986 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11987 Export as @LaTeX{} and then process to PDF.
11989 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11992 @vindex org-latex-compiler
11993 @vindex org-latex-bibtex-compiler
11994 @vindex org-latex-default-packages-alist
11995 The exporter supports several @LaTeX{} engines, namely @samp{pdflatex},
11996 @samp{xelatex} and @samp{lualatex}. The default @LaTeX{} compiler can be set
11997 via @code{org-latex-compiler} or the @code{#+LATEX_COMPILER} keyword. It is
11998 possible to only load some packages with certain compilers (see the docstring
11999 of @code{org-latex-default-packages-alist}). The bibliography compiler may
12000 also be set via @code{org-latex-bibtex-compiler}@footnote{You cannot set the
12001 bibliography compiler on a file basis via a keyword. However, ``smart''
12002 @LaTeX{} compilation systems, such as @samp{latexmk}, are usually able to
12003 select the correct bibliography compiler.}.
12005 @node @LaTeX{} specific export settings
12006 @subsection @LaTeX{} specific export settings
12007 The @LaTeX{} exporter introduces a number of keywords, similar to the general
12008 options settings described in @ref{Export settings}.
12012 @cindex #+DESCRIPTION (@LaTeX{})
12013 The document description. By default these are inserted as metadata using
12014 @samp{hyperref}. Document metadata can be configured via
12015 @code{org-latex-hyperref-template}. Description can also be typeset as part
12016 of the front matter via @code{org-latex-title-command}. You can use several
12017 @code{#+DESCRIPTION} keywords if the description is is long.
12020 @cindex #+LATEX_CLASS
12021 @vindex org-latex-default-class
12022 @vindex org-latex-classes
12023 The predefined preamble and headline level mapping to use
12024 (@code{org-latex-default-class}). Must be an element in
12025 @code{org-latex-classes}.
12027 @item LATEX_CLASS_OPTIONS
12028 @cindex #+LATEX_CLASS_OPTIONS
12029 Options given to the @LaTeX{} document class.
12031 @item LATEX_COMPILER
12032 @cindex #+LATEX_COMPILER
12033 @vindex org-latex-compiler
12034 The compiler used to produce the PDF (@code{org-latex-compiler}).
12037 @cindex #+LATEX_HEADER
12038 @vindex org-latex-classes
12039 Arbitrary lines added to the preamble of the document, before the
12040 @samp{hyperref} settings. The location can be controlled via
12041 @code{org-latex-classes}.
12043 @item LATEX_HEADER_EXTRA
12044 @cindex #+LATEX_HEADER_EXTRA
12045 @vindex org-latex-classes
12046 Arbitrary lines added to the preamble of the document, before the
12047 @samp{hyperref} settings. The location can be controlled via
12048 @code{org-latex-classes}.
12051 @cindex #+KEYWORDS (@LaTeX{})
12052 The keywords defining the contents of the document. By default these are
12053 inserted as metadata using @samp{hyperref}. Document metadata can be
12054 configured via @code{org-latex-hyperref-template}. Description can also be
12055 typeset as part of the front matter via @code{org-latex-title-command}. You
12056 can use several @code{#+KEYWORDS} if the description is is long.
12059 @cindex #+SUBTITLE (@LaTeX{})
12060 @vindex org-latex-subtitle-separate
12061 @vindex org-latex-subtitle-format
12062 The document subtitle. This is typeset according to
12063 @code{org-latex-subtitle-format}. If @code{org-latex-subtitle-separate}
12064 is non-@code{nil} it is typed as part of the @samp{\title}-macro. It
12065 can also access via @code{org-latex-hyperref-template} or typeset as
12066 part of the front matter via @code{org-latex-title-command}.
12069 These keywords are treated in details in the following sections.
12071 @node @LaTeX{} header and sectioning
12072 @subsection @LaTeX{} header and sectioning structure
12073 @cindex @LaTeX{} class
12074 @cindex @LaTeX{} sectioning structure
12075 @cindex @LaTeX{} header
12076 @cindex header, for @LaTeX{} files
12077 @cindex sectioning structure, for @LaTeX{} export
12079 By default, the first three outline levels become headlines, defining a
12080 general document structure. Additional levels are exported as @code{itemize}
12081 or @code{enumerate} lists. The transition can also occur at a different
12082 level (@pxref{Export settings}).
12084 By default, the @LaTeX{} output uses the class @code{article}.
12086 @vindex org-latex-default-class
12087 @vindex org-latex-classes
12088 @vindex org-latex-default-packages-alist
12089 @vindex org-latex-packages-alist
12090 You can change this globally by setting a different value for
12091 @code{org-latex-default-class} or locally by adding an option like
12092 @code{#+LATEX_CLASS: myclass} in your file, or with
12093 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
12094 containing only this (sub)tree. The class must be listed in
12095 @code{org-latex-classes}. This variable defines a header template for each
12096 class@footnote{Into which the values of
12097 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
12098 are spliced.}, and allows you to define the sectioning structure for each
12099 class. You can also define your own classes there.
12101 @cindex #+LATEX_CLASS
12102 @cindex #+LATEX_CLASS_OPTIONS
12103 @cindex property, EXPORT_LATEX_CLASS
12104 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
12105 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
12106 property can specify the options for the @code{\documentclass} macro. These
12107 options have to be provided, as expected by @LaTeX{}, within square brackets.
12109 @cindex #+LATEX_HEADER
12110 @cindex #+LATEX_HEADER_EXTRA
12111 You can also use the @code{LATEX_HEADER} and
12112 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
12113 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
12114 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
12115 to add lines to the header. See the docstring of @code{org-latex-classes} for
12118 An example is shown below.
12121 #+LATEX_CLASS: article
12122 #+LATEX_CLASS_OPTIONS: [a4paper]
12123 #+LATEX_HEADER: \usepackage@{xyz@}
12129 @node Quoting @LaTeX{} code
12130 @subsection Quoting @LaTeX{} code
12132 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
12133 inserted into the @LaTeX{} file. Furthermore, you can add special code that
12134 should only be present in @LaTeX{} export with the following constructs:
12137 @cindex #+BEGIN_EXPORT latex
12139 Code within @@@@latex:some code@@@@ a paragraph.
12141 #+LATEX: Literal @LaTeX{} code for export
12143 #+BEGIN_EXPORT latex
12144 All lines between these markers are exported literally
12148 @node Tables in @LaTeX{} export
12149 @subsection Tables in @LaTeX{} export
12150 @cindex tables, in @LaTeX{} export
12151 @cindex #+ATTR_LATEX, in tables
12153 For @LaTeX{} export of a table, you can specify a label and a caption
12154 (@pxref{Images and tables}). You can also use attributes to control table
12155 layout and contents. Valid @LaTeX{} attributes include:
12159 @vindex org-latex-default-table-mode
12160 Nature of table's contents. It can be set to @code{table}, @code{math},
12161 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
12162 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
12163 ignored and the table will be wrapped in a math environment. Also,
12164 contiguous tables sharing the same math mode will be wrapped within the same
12165 environment. Default mode is determined in
12166 @code{org-latex-default-table-mode}.
12168 @vindex org-latex-default-table-environment
12169 Environment used for the table. It can be set to any @LaTeX{} table
12170 environment, like @code{tabularx}@footnote{Requires adding the
12171 @code{tabularx} package to @code{org-latex-packages-alist}.},
12172 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
12173 @code{tabu} package to @code{org-latex-packages-alist}.},
12174 @code{bmatrix}@enddots{} It defaults to
12175 @code{org-latex-default-table-environment} value.
12177 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
12178 (@pxref{Images and tables}). If you need more advanced commands for that
12179 task, you can use @code{:caption} attribute instead. Its value should be raw
12180 @LaTeX{} code. It has precedence over @code{#+CAPTION}.
12183 The @code{:float} specifies the float environment for the table. Possible
12184 values are @code{sideways}@footnote{Formerly, the value was
12185 @code{sidewaystable}. This is deprecated since Org 8.3.},
12186 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
12187 a caption will have a @code{table} environment. Moreover, the
12188 @code{:placement} attribute can specify the positioning of the float. Note:
12189 @code{:placement} is ignored for @code{:float sideways} tables.
12193 Set, respectively, the alignment string of the table, its font size and its
12194 width. They only apply on regular tables.
12196 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
12197 only takes effect when used in conjunction with the @code{:width} attribute.
12198 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
12199 value of @code{:width}.
12203 @vindex org-latex-tables-booktabs
12204 @vindex org-latex-tables-centered
12205 They toggle, respectively, @code{booktabs} usage (assuming the package is
12206 properly loaded), table centering and removal of every horizontal rule but
12207 the first one (in a "table.el" table only). In particular,
12208 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
12209 activates the first (respectively second) attribute globally.
12211 @itemx :math-suffix
12212 @itemx :math-arguments
12213 A string that will be inserted, respectively, before the table within the
12214 math environment, after the table within the math environment, and between
12215 the macro name and the contents of the table. The @code{:math-arguments}
12216 attribute is used for matrix macros that require more than one argument
12217 (e.g., @code{qbordermatrix}).
12220 Thus, attributes can be used in a wide array of situations, like writing
12221 a table that will span over multiple pages, or a matrix product:
12224 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
12228 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
12231 #+ATTR_LATEX: :mode math :environment bmatrix
12236 In the example below, @LaTeX{} command
12237 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
12240 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12246 @node Images in @LaTeX{} export
12247 @subsection Images in @LaTeX{} export
12248 @cindex images, inline in @LaTeX{}
12249 @cindex inlining images in @LaTeX{}
12250 @cindex #+ATTR_LATEX, in images
12252 Images that are linked to without a description part in the link, like
12253 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
12254 output file resulting from @LaTeX{} processing. Org will use an
12255 @code{\includegraphics} macro to insert the image@footnote{In the case of
12256 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
12257 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
12259 You can specify image width or height with, respectively, @code{:width} and
12260 @code{:height} attributes. It is also possible to add any other option with
12261 the @code{:options} attribute, as shown in the following example:
12264 #+ATTR_LATEX: :width 5cm :options angle=90
12265 [[./img/sed-hr4049.pdf]]
12268 If you need a specific command for the caption, use @code{:caption}
12269 attribute. It will override standard @code{#+CAPTION} value, if any.
12272 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12273 [[./img/sed-hr4049.pdf]]
12276 If you have specified a caption as described in @ref{Images and tables}, the
12277 picture will be wrapped into a @code{figure} environment and thus become
12278 a floating element. You can also ask Org to export an image as a float
12279 without specifying caption by setting the @code{:float} attribute. You may
12283 @code{t}: if you want to use the standard @samp{figure} environment. It is
12284 used by default if you provide a caption to the image.
12286 @code{multicolumn}: if you wish to include an image which spans multiple
12287 columns in a page. This will export the image wrapped in a @code{figure*}
12290 @code{wrap}: if you would like to let text flow around the image. It will
12291 make the figure occupy the left half of the page.
12293 @code{sideways}: if you would like the image to appear alone on a separate
12294 page rotated ninety degrees using the @code{sidewaysfigure}
12295 environment. Setting this @code{:float} option will ignore the
12296 @code{:placement} setting.
12298 @code{nil}: if you need to avoid any floating environment, even when
12299 a caption is provided.
12302 To modify the placement option of any floating environment, set the
12303 @code{placement} attribute.
12306 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
12310 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
12311 the @LaTeX{} @code{\includegraphics} macro will be commented out.
12313 @node Plain lists in @LaTeX{} export
12314 @subsection Plain lists in @LaTeX{} export
12315 @cindex plain lists, in @LaTeX{} export
12316 @cindex #+ATTR_LATEX, in plain lists
12318 Plain lists accept two optional attributes: @code{:environment} and
12319 @code{:options}. The first can be used to specify the environment. The
12320 second can be used to specifies additional arguments to the environment.
12321 Both attributes are illustrated in the following example:
12324 #+LATEX_HEADER: \usepackage[inline]@{enumitem@}
12325 Some ways to say "Hello":
12326 #+ATTR_LATEX: :environment itemize*
12327 #+ATTR_LATEX: :options [label=@{@}, itemjoin=@{,@}, itemjoin*=@{, and@}]
12333 By default, @LaTeX{} only supports four levels of nesting for lists. If
12334 deeper nesting is needed, the @samp{enumitem} @LaTeX{} package can be
12335 employed, as shown in this example:
12338 #+LATEX_HEADER: \usepackage@{enumitem@}
12339 #+LATEX_HEADER: \renewlist@{itemize@}@{itemize@}@{9@}
12340 #+LATEX_HEADER: \setlist[itemize]@{label=$\circ$@}
12348 @node Source blocks in @LaTeX{} export
12349 @subsection Source blocks in @LaTeX{} export
12350 @cindex source blocks, in @LaTeX{} export
12351 @cindex #+ATTR_LATEX, in source blocks
12353 In addition to syntax defined in @ref{Literal examples}, names and captions
12354 (@pxref{Images and tables}), source blocks also accept two additional
12355 attributes: @code{:float} and @code{:options}.
12357 You may set the former to
12360 @code{t}: if you want to make the source block a float. It is the default
12361 value when a caption is provided.
12363 @code{multicolumn}: if you wish to include a source block which spans multiple
12366 @code{nil}: if you need to avoid any floating environment, even when a caption
12367 is provided. It is useful for source code that may not fit in a single page.
12371 #+ATTR_LATEX: :float nil
12372 #+BEGIN_SRC emacs-lisp
12373 Code that may not fit in a single page.
12377 @vindex org-latex-listings-options
12378 @vindex org-latex-minted-options
12379 The latter allows to specify options relative to the package used to
12380 highlight code in the output (e.g., @code{listings}). This is the local
12381 counterpart to @code{org-latex-listings-options} and
12382 @code{org-latex-minted-options} variables, which see.
12385 #+ATTR_LATEX: :options commentstyle=\bfseries
12386 #+BEGIN_SRC emacs-lisp
12387 (defun Fib (n) ; Count rabbits.
12388 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
12392 @node Example blocks in @LaTeX{} export
12393 @subsection Example blocks in @LaTeX{} export
12394 @cindex example blocks, in @LaTeX{} export
12395 @cindex verbatim blocks, in @LaTeX{} export
12396 @cindex #+ATTR_LATEX, in example blocks
12398 By default, when exporting to @LaTeX{}, example blocks contents are wrapped
12399 in a @samp{verbatim} environment. It is possible to use a different
12400 environment globally using an appropriate export filter (@pxref{Advanced
12401 configuration}). You can also change this per block using
12402 @code{:environment} parameter.
12405 #+ATTR_LATEX: :environment myverbatim
12407 This sentence is false.
12411 @node Special blocks in @LaTeX{} export
12412 @subsection Special blocks in @LaTeX{} export
12413 @cindex special blocks, in @LaTeX{} export
12414 @cindex abstract, in @LaTeX{} export
12415 @cindex proof, in @LaTeX{} export
12416 @cindex #+ATTR_LATEX, in special blocks
12418 In @LaTeX{} back-end, special blocks become environments of the same name.
12419 Value of @code{:options} attribute will be appended as-is to that
12420 environment's opening string. For example:
12424 We demonstrate how to solve the Syracuse problem.
12427 #+ATTR_LATEX: :options [Proof of important theorem]
12430 Therefore, any even number greater than 2 is the sum of two primes.
12439 We demonstrate how to solve the Syracuse problem.
12442 \begin@{proof@}[Proof of important theorem]
12444 Therefore, any even number greater than 2 is the sum of two primes.
12448 If you need to insert a specific caption command, use @code{:caption}
12449 attribute. It will override standard @code{#+CAPTION} value, if any. For
12453 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12459 @node Horizontal rules in @LaTeX{} export
12460 @subsection Horizontal rules in @LaTeX{} export
12461 @cindex horizontal rules, in @LaTeX{} export
12462 @cindex #+ATTR_LATEX, in horizontal rules
12464 Width and thickness of a given horizontal rule can be controlled with,
12465 respectively, @code{:width} and @code{:thickness} attributes:
12468 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12472 @node Markdown export
12473 @section Markdown export
12474 @cindex Markdown export
12476 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12477 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12480 It is built over HTML back-end: any construct not supported by Markdown
12481 syntax (e.g., tables) will be controlled and translated by @code{html}
12482 back-end (@pxref{HTML export}).
12484 @subheading Markdown export commands
12487 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12488 Export as a text file written in Markdown syntax. For an Org file,
12489 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
12490 will be overwritten without warning.
12491 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12492 Export to a temporary buffer. Do not create a file.
12494 Export as a text file with Markdown syntax, then open it.
12497 @subheading Header and sectioning structure
12499 @vindex org-md-headline-style
12500 Markdown export can generate both @code{atx} and @code{setext} types for
12501 headlines, according to @code{org-md-headline-style}. The former introduces
12502 a hard limit of two levels, whereas the latter pushes it to six. Headlines
12503 below that limit are exported as lists. You can also set a soft limit before
12504 that one (@pxref{Export settings}).
12506 @c begin opendocument
12508 @node OpenDocument Text export
12509 @section OpenDocument Text export
12511 @cindex OpenDocument
12512 @cindex export, OpenDocument
12513 @cindex LibreOffice
12515 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12516 (ODT) format. Documents created by this exporter use the
12517 @cite{OpenDocument-v1.2
12518 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12519 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12520 are compatible with LibreOffice 3.4.
12523 * Pre-requisites for ODT export:: What packages ODT exporter relies on
12524 * ODT export commands:: How to invoke ODT export
12525 * ODT specific export settings:: Export settings for ODT
12526 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
12527 * Applying custom styles:: How to apply custom styles to the output
12528 * Links in ODT export:: How links will be interpreted and formatted
12529 * Tables in ODT export:: How Tables are exported
12530 * Images in ODT export:: How to insert images
12531 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
12532 * Labels and captions in ODT export:: How captions are rendered
12533 * Literal examples in ODT export:: How source and example blocks are formatted
12534 * Advanced topics in ODT export:: Read this if you are a power user
12537 @node Pre-requisites for ODT export
12538 @subsection Pre-requisites for ODT export
12540 The ODT exporter relies on the @file{zip} program to create the final
12541 output. Check the availability of this program before proceeding further.
12543 @node ODT export commands
12544 @subsection ODT export commands
12545 @anchor{x-export-to-odt}
12546 @cindex region, active
12547 @cindex active region
12548 @cindex transient-mark-mode
12550 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12551 @cindex property EXPORT_FILE_NAME
12553 Export as OpenDocument Text file.
12555 @vindex org-odt-preferred-output-format
12556 If @code{org-odt-preferred-output-format} is specified, automatically convert
12557 the exported file to that format. @xref{x-export-to-other-formats, ,
12558 Automatically exporting to other formats}.
12560 For an Org file @file{myfile.org}, the ODT file will be
12561 @file{myfile.odt}. The file will be overwritten without warning. If there
12562 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12563 turned on} only the region will be exported. If the selected region is a
12564 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12565 tree head will become the document title. If the tree head entry has, or
12566 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12570 Export as an OpenDocument Text file and open the resulting file.
12572 @vindex org-odt-preferred-output-format
12573 If @code{org-odt-preferred-output-format} is specified, open the converted
12574 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
12578 @node ODT specific export settings
12579 @subsection ODT specific export settings
12580 The ODT exporter introduces a number of keywords, similar to the general
12581 options settings described in @ref{Export settings}.
12585 @cindex #+DESCRIPTION (ODT)
12586 The document description. These are inserted as document metadata. You can
12587 use several such keywords if the list is long.
12590 @cindex #+KEYWORDS (ODT)
12591 The keywords defining the contents of the document. These are inserted as
12592 document metadata. You can use several such keywords if the list is long.
12594 @item ODT_STYLES_FILE
12595 @cindex ODT_STYLES_FILE
12596 @vindex org-odt-styles-file
12597 The style file of the document (@code{org-odt-styles-file}). See
12598 @ref{Applying custom styles} for details.
12601 @cindex SUBTITLE (ODT)
12602 The document subtitle.
12605 @node Extending ODT export
12606 @subsection Extending ODT export
12608 The ODT exporter can interface with a variety of document
12609 converters and supports popular converters out of the box. As a result, you
12610 can use it to export to formats like @samp{doc} or convert a document from
12611 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12613 @cindex @file{unoconv}
12614 @cindex LibreOffice
12615 If you have a working installation of LibreOffice, a document converter is
12616 pre-configured for you and you can use it right away. If you would like to
12617 use @file{unoconv} as your preferred converter, customize the variable
12618 @code{org-odt-convert-process} to point to @code{unoconv}. You can
12619 also use your own favorite converter or tweak the default settings of the
12620 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
12621 document converter}.
12623 @subsubheading Automatically exporting to other formats
12624 @anchor{x-export-to-other-formats}
12626 @vindex org-odt-preferred-output-format
12627 Very often, you will find yourself exporting to ODT format, only to
12628 immediately save the exported document to other formats like @samp{doc},
12629 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
12630 preferred output format by customizing the variable
12631 @code{org-odt-preferred-output-format}. This way, the export commands
12632 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12633 format that is of immediate interest to you.
12635 @subsubheading Converting between document formats
12636 @anchor{x-convert-to-other-formats}
12638 There are many document converters in the wild which support conversion to
12639 and from various file formats, including, but not limited to the
12640 ODT format. LibreOffice converter, mentioned above, is one such
12641 converter. Once a converter is configured, you can interact with it using
12642 the following command.
12644 @vindex org-odt-convert
12647 @item M-x org-odt-convert RET
12648 Convert an existing document from one format to another. With a prefix
12649 argument, also open the newly produced file.
12652 @node Applying custom styles
12653 @subsection Applying custom styles
12654 @cindex styles, custom
12655 @cindex template, custom
12657 The ODT exporter ships with a set of OpenDocument styles
12658 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12659 output. These factory styles, however, may not cater to your specific
12660 tastes. To customize the output, you can either modify the above styles
12661 files directly, or generate the required styles using an application like
12662 LibreOffice. The latter method is suitable for expert and non-expert
12663 users alike, and is described here.
12665 @subsubheading Applying custom styles: the easy way
12669 Create a sample @file{example.org} file with the below settings and export it
12673 #+OPTIONS: H:10 num:t
12677 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
12678 to locate the target styles---these typically have the @samp{Org} prefix---and
12679 modify those to your taste. Save the modified file either as an
12680 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12683 @cindex #+ODT_STYLES_FILE
12684 @vindex org-odt-styles-file
12685 Customize the variable @code{org-odt-styles-file} and point it to the
12686 newly created file. For additional configuration options
12687 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12689 If you would like to choose a style on a per-file basis, you can use the
12690 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
12693 #+ODT_STYLES_FILE: "/path/to/example.ott"
12699 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12704 @subsubheading Using third-party styles and templates
12706 You can use third-party styles and templates for customizing your output.
12707 This will produce the desired output only if the template provides all
12708 style names that the @samp{ODT} exporter relies on. Unless this condition is
12709 met, the output is going to be less than satisfactory. So it is highly
12710 recommended that you only work with templates that are directly derived from
12711 the factory settings.
12713 @node Links in ODT export
12714 @subsection Links in ODT export
12715 @cindex links, in ODT export
12717 ODT exporter creates native cross-references for internal links. It creates
12718 Internet-style links for all other links.
12720 A link with no description and destined to a regular (un-itemized) outline
12721 heading is replaced with a cross-reference and section number of the heading.
12723 A @samp{\ref@{label@}}-style reference to an image, table etc.@: is replaced
12724 with a cross-reference and sequence number of the labeled entity.
12725 @xref{Labels and captions in ODT export}.
12727 @node Tables in ODT export
12728 @subsection Tables in ODT export
12729 @cindex tables, in ODT export
12731 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12732 tables is supported. However, export of complex @file{table.el} tables---tables
12733 that have column or row spans---is not supported. Such tables are
12734 stripped from the exported document.
12736 By default, a table is exported with top and bottom frames and with rules
12737 separating row and column groups (@pxref{Column groups}). Furthermore, all
12738 tables are typeset to occupy the same width. If the table specifies
12739 alignment and relative width for its columns (@pxref{Column width and
12740 alignment}) then these are honored on export.@footnote{The column widths are
12741 interpreted as weighted ratios with the default weight being 1}
12744 You can control the width of the table by specifying @code{:rel-width}
12745 property using an @code{#+ATTR_ODT} line.
12747 For example, consider the following table which makes use of all the rules
12751 #+ATTR_ODT: :rel-width 50
12752 | Area/Month | Jan | Feb | Mar | Sum |
12753 |---------------+-------+-------+-------+-------|
12755 | <l13> | <r5> | <r5> | <r5> | <r6> |
12756 | North America | 1 | 21 | 926 | 948 |
12757 | Middle East | 6 | 75 | 844 | 925 |
12758 | Asia Pacific | 9 | 27 | 790 | 826 |
12759 |---------------+-------+-------+-------+-------|
12760 | Sum | 16 | 123 | 2560 | 2699 |
12763 On export, the table will occupy 50% of text area. The columns will be sized
12764 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12765 and rest of the columns will be right-aligned. There will be vertical rules
12766 after separating the header and last columns from other columns. There will
12767 be horizontal rules separating the header and last rows from other rows.
12769 If you are not satisfied with the above formatting options, you can create
12770 custom table styles and associate them with a table using the
12771 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12773 @node Images in ODT export
12774 @subsection Images in ODT export
12775 @cindex images, embedding in ODT
12776 @cindex embedding images in ODT
12778 @subsubheading Embedding images
12779 You can embed images within the exported document by providing a link to the
12780 desired image file with no link description. For example, to embed
12781 @samp{img.png} do either of the following:
12791 @subsubheading Embedding clickable images
12792 You can create clickable images by providing a link whose description is a
12793 link to an image file. For example, to embed a image
12794 @file{org-mode-unicorn.png} which when clicked jumps to
12795 @uref{http://Orgmode.org} website, do the following
12798 [[http://orgmode.org][./org-mode-unicorn.png]]
12801 @subsubheading Sizing and scaling of embedded images
12804 You can control the size and scale of the embedded images using the
12805 @code{#+ATTR_ODT} attribute.
12807 @cindex identify, ImageMagick
12808 @vindex org-odt-pixels-per-inch
12809 The exporter specifies the desired size of the image in the final document in
12810 units of centimeters. In order to scale the embedded images, the exporter
12811 queries for pixel dimensions of the images using one of a) ImageMagick's
12812 @file{identify} program or b) Emacs @code{create-image} and @code{image-size}
12813 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12814 routinely produce documents that have large images or you export your Org
12815 files that has images using a Emacs batch script, then the use of
12816 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12817 converted in to units of centimeters using
12818 @code{org-odt-pixels-per-inch}. The default value of this variable is
12819 set to @code{display-pixels-per-inch}. You can tweak this variable to
12820 achieve the best results.
12822 The examples below illustrate the various possibilities.
12825 @item Explicitly size the image
12826 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12829 #+ATTR_ODT: :width 10 :height 10
12833 @item Scale the image
12834 To embed @file{img.png} at half its size, do the following:
12837 #+ATTR_ODT: :scale 0.5
12841 @item Scale the image to a specific width
12842 To embed @file{img.png} with a width of 10 cm while retaining the original
12843 height:width ratio, do the following:
12846 #+ATTR_ODT: :width 10
12850 @item Scale the image to a specific height
12851 To embed @file{img.png} with a height of 10 cm while retaining the original
12852 height:width ratio, do the following
12855 #+ATTR_ODT: :height 10
12860 @subsubheading Anchoring of images
12863 You can control the manner in which an image is anchored by setting the
12864 @code{:anchor} property of its @code{#+ATTR_ODT} line. You can specify one
12865 of the following three values for the @code{:anchor} property:
12866 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12868 To create an image that is anchored to a page, do the following:
12870 #+ATTR_ODT: :anchor "page"
12874 @node Math formatting in ODT export
12875 @subsection Math formatting in ODT export
12877 The ODT exporter has special support for handling math.
12880 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12881 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12884 @node Working with @LaTeX{} math snippets
12885 @subsubheading Working with @LaTeX{} math snippets
12887 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12888 document in one of the following ways:
12894 This option is activated on a per-file basis with
12900 With this option, @LaTeX{} fragments are first converted into MathML
12901 fragments using an external @LaTeX{}-to-MathML converter program. The
12902 resulting MathML fragments are then embedded as an OpenDocument Formula in
12903 the exported document.
12905 @vindex org-latex-to-mathml-convert-command
12906 @vindex org-latex-to-mathml-jar-file
12908 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12909 @code{org-latex-to-mathml-convert-command} and
12910 @code{org-latex-to-mathml-jar-file}.
12912 To use MathToWeb@footnote{See
12913 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}.} as your
12914 converter, you can configure the above variables as
12917 (setq org-latex-to-mathml-convert-command
12918 "java -jar %j -unicode -force -df %o %I"
12919 org-latex-to-mathml-jar-file
12920 "/path/to/mathtoweb.jar")
12922 To use @LaTeX{}ML@footnote{See @uref{http://dlmf.nist.gov/LaTeXML/}.} use
12924 (setq org-latex-to-mathml-convert-command
12925 "latexmlmath \"%i\" --presentationmathml=%o")
12928 You can use the following commands to quickly verify the reliability of
12929 the @LaTeX{}-to-MathML converter.
12932 @item M-x org-odt-export-as-odf RET
12933 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12935 @item M-x org-odt-export-as-odf-and-open RET
12936 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12937 and open the formula file with the system-registered application.
12942 @cindex imagemagick
12945 This option is activated on a per-file basis with
12948 #+OPTIONS: tex:dvipng
12952 #+OPTIONS: tex:dvisvgm
12958 #+OPTIONS: tex:imagemagick
12961 With this option, @LaTeX{} fragments are processed into PNG or SVG images and
12962 the resulting images are embedded in the exported document. This method requires
12963 that the @file{dvipng} program, @file{dvisvgm} or @file{imagemagick} suite be
12964 available on your system.
12967 @node Working with MathML or OpenDocument formula files
12968 @subsubheading Working with MathML or OpenDocument formula files
12970 For various reasons, you may find embedding @LaTeX{} math snippets in an
12971 ODT document less than reliable. In that case, you can embed a
12972 math equation by linking to its MathML (@file{.mml}) source or its
12973 OpenDocument formula (@file{.odf}) file as shown below:
12985 @node Labels and captions in ODT export
12986 @subsection Labels and captions in ODT export
12988 You can label and caption various category of objects---an inline image, a
12989 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12990 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12991 each labeled or captioned object of a given category separately. As a
12992 result, each such object is assigned a sequence number based on order of its
12993 appearance in the Org file.
12995 In the exported document, a user-provided caption is augmented with the
12996 category and sequence number. Consider the following inline image in an Org
13000 #+CAPTION: Bell curve
13001 #+LABEL: fig:SED-HR4049
13005 It could be rendered as shown below in the exported document.
13008 Figure 2: Bell curve
13011 @vindex org-odt-category-map-alist
13012 You can modify the category component of the caption by customizing the
13013 option @code{org-odt-category-map-alist}. For example, to tag all embedded
13014 images with the string @samp{Illustration} (instead of the default
13015 @samp{Figure}) use the following setting:
13018 (setq org-odt-category-map-alist
13019 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
13022 With this, previous image will be captioned as below in the exported
13026 Illustration 2: Bell curve
13029 @node Literal examples in ODT export
13030 @subsection Literal examples in ODT export
13032 Export of literal examples (@pxref{Literal examples}) with full fontification
13033 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
13034 generate all style definitions needed for a fancy listing. The
13035 auto-generated styles have @samp{OrgSrc} as prefix and inherit their color
13036 from the faces used by Emacs @code{font-lock} library for the source
13039 @vindex org-odt-fontify-srcblocks
13040 If you prefer to use your own custom styles for fontification, you can do
13041 so by customizing the option
13042 @code{org-odt-create-custom-styles-for-srcblocks}.
13044 @vindex org-odt-create-custom-styles-for-srcblocks
13045 You can turn off fontification of literal examples by customizing the
13046 option @code{org-odt-fontify-srcblocks}.
13048 @node Advanced topics in ODT export
13049 @subsection Advanced topics in ODT export
13051 If you rely heavily on ODT export, you may want to exploit the full
13052 set of features that the exporter offers. This section describes features
13053 that would be of interest to power users.
13056 * Configuring a document converter:: How to register a document converter
13057 * Working with OpenDocument style files:: Explore the internals
13058 * Creating one-off styles:: How to produce custom highlighting etc
13059 * Customizing tables in ODT export:: How to define and use Table templates
13060 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
13063 @node Configuring a document converter
13064 @subsubheading Configuring a document converter
13066 @cindex doc, docx, rtf
13069 The ODT exporter can work with popular converters with little or no
13070 extra configuration from your side. @xref{Extending ODT export}.
13071 If you are using a converter that is not supported by default or if you would
13072 like to tweak the default converter settings, proceed as below.
13075 @item Register the converter
13077 @vindex org-odt-convert-processes
13078 Name your converter and add it to the list of known converters by
13079 customizing the option @code{org-odt-convert-processes}. Also specify how
13080 the converter can be invoked via command-line to effect the conversion.
13082 @item Configure its capabilities
13084 @vindex org-odt-convert-capabilities
13085 @anchor{x-odt-converter-capabilities} Specify the set of formats the
13086 converter can handle by customizing the variable
13087 @code{org-odt-convert-capabilities}. Use the default value for this
13088 variable as a guide for configuring your converter. As suggested by the
13089 default setting, you can specify the full set of formats supported by the
13090 converter and not limit yourself to specifying formats that are related to
13091 just the OpenDocument Text format.
13093 @item Choose the converter
13095 @vindex org-odt-convert-process
13096 Select the newly added converter as the preferred one by customizing the
13097 option @code{org-odt-convert-process}.
13100 @node Working with OpenDocument style files
13101 @subsubheading Working with OpenDocument style files
13102 @cindex styles, custom
13103 @cindex template, custom
13105 This section explores the internals of the ODT exporter and the
13106 means by which it produces styled documents. Read this section if you are
13107 interested in exploring the automatic and custom OpenDocument styles used by
13110 @anchor{x-factory-styles}
13111 @subsubheading a) Factory styles
13113 The ODT exporter relies on two files for generating its output.
13114 These files are bundled with the distribution under the directory pointed to
13115 by the variable @code{org-odt-styles-dir}. The two files are:
13118 @anchor{x-orgodtstyles-xml}
13120 @file{OrgOdtStyles.xml}
13122 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
13123 document. This file gets modified for the following purposes:
13127 To control outline numbering based on user settings.
13130 To add styles generated by @file{htmlfontify.el} for fontification of code
13134 @anchor{x-orgodtcontenttemplate-xml}
13136 @file{OrgOdtContentTemplate.xml}
13138 This file contributes to the @file{content.xml} file of the final @samp{ODT}
13139 document. The contents of the Org outline are inserted between the
13140 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
13142 Apart from serving as a template file for the final @file{content.xml}, the
13143 file serves the following purposes:
13147 It contains automatic styles for formatting of tables which are referenced by
13151 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
13152 elements that control how various entities---tables, images, equations,
13153 etc.---are numbered.
13157 @anchor{x-overriding-factory-styles}
13158 @subsubheading b) Overriding factory styles
13159 The following two variables control the location from which the ODT
13160 exporter picks up the custom styles and content template files. You can
13161 customize these variables to override the factory styles used by the
13165 @anchor{x-org-odt-styles-file}
13167 @code{org-odt-styles-file}
13169 Use this variable to specify the @file{styles.xml} that will be used in the
13170 final output. You can specify one of the following values:
13173 @item A @file{styles.xml} file
13175 Use this file instead of the default @file{styles.xml}
13177 @item A @file{.odt} or @file{.ott} file
13179 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13182 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
13184 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13185 Template file. Additionally extract the specified member files and embed
13186 those within the final @samp{ODT} document.
13188 Use this option if the @file{styles.xml} file references additional files
13189 like header and footer images.
13193 Use the default @file{styles.xml}
13196 @anchor{x-org-odt-content-template-file}
13198 @code{org-odt-content-template-file}
13200 Use this variable to specify the blank @file{content.xml} that will be used
13201 in the final output.
13204 @node Creating one-off styles
13205 @subsubheading Creating one-off styles
13207 There are times when you would want one-off formatting in the exported
13208 document. You can achieve this by embedding raw OpenDocument XML in the Org
13209 file. The use of this feature is better illustrated with couple of examples.
13212 @item Embedding ODT tags as part of regular text
13214 You can inline OpenDocument syntax by enclosing it within
13215 @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do
13219 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
13220 text</text:span>@@@@. But this is a regular text.
13223 @strong{Hint:} To see the above example in action, edit your
13224 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13225 custom @samp{Highlight} style as shown below.
13228 <style:style style:name="Highlight" style:family="text">
13229 <style:text-properties fo:background-color="#ff0000"/>
13233 @item Embedding a one-line OpenDocument XML
13235 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
13236 directive. For example, to force a page break do the following:
13239 #+ODT: <text:p text:style-name="PageBreak"/>
13242 @strong{Hint:} To see the above example in action, edit your
13243 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13244 custom @samp{PageBreak} style as shown below.
13247 <style:style style:name="PageBreak" style:family="paragraph"
13248 style:parent-style-name="Text_20_body">
13249 <style:paragraph-properties fo:break-before="page"/>
13253 @item Embedding a block of OpenDocument XML
13255 You can add a large block of OpenDocument XML using the @code{#+BEGIN_EXPORT
13256 odt}@dots{}@code{#+END_EXPORT} construct.
13258 For example, to create a one-off paragraph that uses bold text, do the
13263 <text:p text:style-name="Text_20_body_20_bold">
13264 This paragraph is specially formatted and uses bold text.
13271 @node Customizing tables in ODT export
13272 @subsubheading Customizing tables in ODT export
13273 @cindex tables, in ODT export
13276 You can override the default formatting of the table by specifying a custom
13277 table style with the @code{#+ATTR_ODT} line. For a discussion on default
13278 formatting of tables @pxref{Tables in ODT export}.
13280 This feature closely mimics the way table templates are defined in the
13282 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
13283 OpenDocument-v1.2 Specification}}
13285 @vindex org-odt-table-styles
13286 To have a quick preview of this feature, install the below setting and
13287 export the table that follows:
13290 (setq org-odt-table-styles
13291 (append org-odt-table-styles
13292 '(("TableWithHeaderRowAndColumn" "Custom"
13293 ((use-first-row-styles . t)
13294 (use-first-column-styles . t)))
13295 ("TableWithFirstRowandLastRow" "Custom"
13296 ((use-first-row-styles . t)
13297 (use-last-row-styles . t))))))
13301 #+ATTR_ODT: :style TableWithHeaderRowAndColumn
13302 | Name | Phone | Age |
13303 | Peter | 1234 | 17 |
13304 | Anna | 4321 | 25 |
13307 In the above example, you used a template named @samp{Custom} and installed
13308 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
13309 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
13310 styles needed for producing the above template have been pre-defined for
13311 you. These styles are available under the section marked @samp{Custom
13312 Table Template} in @file{OrgOdtContentTemplate.xml}
13313 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
13314 additional templates you have to define these styles yourselves.
13316 To use this feature proceed as follows:
13320 Create a table template@footnote{See the @code{<table:table-template>}
13321 element of the OpenDocument-v1.2 specification}
13323 A table template is nothing but a set of @samp{table-cell} and
13324 @samp{paragraph} styles for each of the following table cell categories:
13338 The names for the above styles must be chosen based on the name of the table
13339 template using a well-defined convention.
13341 The naming convention is better illustrated with an example. For a table
13342 template with the name @samp{Custom}, the needed style names are listed in
13343 the following table.
13345 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
13346 @headitem Table cell type
13347 @tab @code{table-cell} style
13348 @tab @code{paragraph} style
13353 @tab @samp{CustomTableCell}
13354 @tab @samp{CustomTableParagraph}
13356 @tab @samp{CustomFirstColumnTableCell}
13357 @tab @samp{CustomFirstColumnTableParagraph}
13359 @tab @samp{CustomLastColumnTableCell}
13360 @tab @samp{CustomLastColumnTableParagraph}
13362 @tab @samp{CustomFirstRowTableCell}
13363 @tab @samp{CustomFirstRowTableParagraph}
13365 @tab @samp{CustomLastRowTableCell}
13366 @tab @samp{CustomLastRowTableParagraph}
13368 @tab @samp{CustomEvenRowTableCell}
13369 @tab @samp{CustomEvenRowTableParagraph}
13371 @tab @samp{CustomOddRowTableCell}
13372 @tab @samp{CustomOddRowTableParagraph}
13374 @tab @samp{CustomEvenColumnTableCell}
13375 @tab @samp{CustomEvenColumnTableParagraph}
13377 @tab @samp{CustomOddColumnTableCell}
13378 @tab @samp{CustomOddColumnTableParagraph}
13381 To create a table template with the name @samp{Custom}, define the above
13383 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
13384 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
13388 Define a table style@footnote{See the attributes @code{table:template-name},
13389 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
13390 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
13391 @code{table:use-banding-rows-styles}, and
13392 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
13393 the OpenDocument-v1.2 specification}
13395 @vindex org-odt-table-styles
13396 To define a table style, create an entry for the style in the variable
13397 @code{org-odt-table-styles} and specify the following:
13400 @item the name of the table template created in step (1)
13401 @item the set of cell styles in that template that are to be activated
13404 For example, the entry below defines two different table styles
13405 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
13406 based on the same template @samp{Custom}. The styles achieve their intended
13407 effect by selectively activating the individual cell styles in that template.
13410 (setq org-odt-table-styles
13411 (append org-odt-table-styles
13412 '(("TableWithHeaderRowAndColumn" "Custom"
13413 ((use-first-row-styles . t)
13414 (use-first-column-styles . t)))
13415 ("TableWithFirstRowandLastRow" "Custom"
13416 ((use-first-row-styles . t)
13417 (use-last-row-styles . t))))))
13421 Associate a table with the table style
13423 To do this, specify the table style created in step (2) as part of
13424 the @code{ATTR_ODT} line as shown below.
13427 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
13428 | Name | Phone | Age |
13429 | Peter | 1234 | 17 |
13430 | Anna | 4321 | 25 |
13434 @node Validating OpenDocument XML
13435 @subsubheading Validating OpenDocument XML
13437 Occasionally, you will discover that the document created by the
13438 ODT exporter cannot be opened by your favorite application. One of
13439 the common reasons for this is that the @file{.odt} file is corrupt. In such
13440 cases, you may want to validate the document against the OpenDocument RELAX
13441 NG Compact Syntax (RNC) schema.
13443 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
13444 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
13445 general help with validation (and schema-sensitive editing) of XML files:
13446 @inforef{Introduction,,nxml-mode}.
13448 @vindex org-odt-schema-dir
13449 If you have ready access to OpenDocument @file{.rnc} files and the needed
13450 schema-locating rules in a single folder, you can customize the variable
13451 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
13452 will take care of updating the @code{rng-schema-locating-files} for you.
13454 @c end opendocument
13457 @section Org export
13460 @code{org} export back-end creates a normalized version of the Org document
13461 in current buffer. In particular, it evaluates Babel code (@pxref{Evaluating
13462 code blocks}) and removes other back-ends specific contents.
13464 @subheading Org export commands
13467 @orgcmd{C-c C-e O o,org-org-export-to-org}
13468 Export as an Org document. For an Org file, @file{myfile.org}, the resulting
13469 file will be @file{myfile.org.org}. The file will be overwritten without
13471 @orgcmd{C-c C-e O O,org-org-export-as-org}
13472 Export to a temporary buffer. Do not create a file.
13474 Export to an Org file, then open it.
13477 @node Texinfo export
13478 @section Texinfo export
13479 @cindex Texinfo export
13481 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13485 * Texinfo export commands:: How to invoke Texinfo export
13486 * Texinfo specific export settings:: Export settings for Texinfo
13487 * Texinfo file header:: Generating the begining of a Texinfo file
13488 * Texinfo title and copyright page:: Creating title and copyright pages
13489 * Texinfo @samp{Top} node:: Installing a manual in Info Top node
13490 * Headings and sectioning structure:: Building document structure
13491 * Indices:: Creating indices
13492 * Quoting Texinfo code:: Incorporating literal Texinfo code
13493 * Plain lists in Texinfo export:: Specific attributes for plain lists
13494 * Tables in Texinfo export:: Specific attributes for tables
13495 * Images in Texinfo export:: Specific attributes for images
13496 * Special blocks in Texinfo export:: Specific attributes for special blocks
13497 * A Texinfo example:: Illustrating Org to Texinfo process
13500 @node Texinfo export commands
13501 @subsection Texinfo export commands
13503 @vindex org-texinfo-info-process
13505 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13506 Export as a Texinfo file. For an Org file, @file{myfile.org}, the resulting
13507 file will be @file{myfile.texi}. The file will be overwritten without
13509 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13510 Export to Texinfo and then process to an Info file@footnote{By setting
13511 @code{org-texinfo-info-process}, it is possible to generate other formats,
13512 including DocBook.}.
13515 @node Texinfo specific export settings
13516 @subsection Texinfo specific export settings
13517 The Texinfo exporter introduces a number of keywords, similar to the general
13518 options settings described in @ref{Export settings}.
13523 @cindex #+SUBTITLE (Texinfo)
13524 The document subtitle.
13527 @cindex #+SUBAUTHOR
13528 The document subauthor.
13530 @item TEXINFO_FILENAME
13531 @cindex #+TEXINFO_FILENAME
13532 The Texinfo filename.
13534 @item TEXINFO_CLASS
13535 @cindex #+TEXINFO_CLASS
13536 @vindex org-texinfo-default-class
13537 The class of the document (@code{org-texinfo-default-class}). This must be a
13538 member of @code{org-texinfo-classes}.
13540 @item TEXINFO_HEADER
13541 @cindex #+TEXINFO_HEADER
13542 Arbitrary lines inserted at the end of the header.
13544 @item TEXINFO_POST_HEADER
13545 @cindex #+TEXINFO_POST_HEADER
13546 Arbitrary lines inserted after the end of the header.
13548 @item TEXINFO_DIR_CATEGORY
13549 @cindex #+TEXINFO_DIR_CATEGORY
13550 The directory category of the document.
13552 @item TEXINFO_DIR_TITLE
13553 @cindex #+TEXINFO_DIR_TITLE
13554 The directory title of the document.
13556 @item TEXINFO_DIR_DESC
13557 @cindex #+TEXINFO_DIR_DESC
13558 The directory description of the document.
13560 @item TEXINFO_PRINTED_TITLE
13561 @cindex #+TEXINFO_PRINTED_TITLE
13562 The printed title of the document.
13565 @node Texinfo file header
13566 @subsection Texinfo file header
13568 @cindex #+TEXINFO_FILENAME
13569 Upon creating the header of a Texinfo file, the back-end guesses a name for
13570 the Info file to be compiled. This may not be a sensible choice, e.g., if
13571 you want to produce the final document in a different directory. Specify an
13572 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13575 @vindex org-texinfo-coding-system
13576 @vindex org-texinfo-classes
13577 @cindex #+TEXINFO_HEADER
13578 @cindex #+TEXINFO_CLASS
13579 Along with the output file name, the header contains information about the
13580 language (@pxref{Export settings}) and current encoding used@footnote{See
13581 @code{org-texinfo-coding-system} for more information.}. Insert
13582 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13583 @@code@{@@synindex@}.
13585 If you happen to regularly install the same set of commands, it may be easier
13586 to define your own class in @code{org-texinfo-classes}. Set
13587 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13589 @node Texinfo title and copyright page
13590 @subsection Texinfo title and copyright page
13592 @cindex #+TEXINFO_PRINTED_TITLE
13593 The default template includes a title page for hard copy output. The title
13594 and author displayed on this page are extracted from, respectively,
13595 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}). It is
13596 also possible to print a different, more specific, title with
13597 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13598 @code{#+SUBTITLE} keyword. Both expect raw Texinfo code in their value.
13600 @cindex #+SUBAUTHOR
13601 Likewise, information brought by @code{#+AUTHOR} may not be enough. You can
13602 include other authors with several @code{#+SUBAUTHOR} keywords. Values are
13603 also expected to be written in Texinfo code.
13606 #+AUTHOR: Jane Smith
13607 #+SUBAUTHOR: John Doe
13608 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13611 @cindex property, COPYING
13612 Copying material is defined in a dedicated headline with a non-@code{nil}
13613 @code{:COPYING:} property. The contents are inserted within
13614 a @code{@@copying} command at the beginning of the document whereas the
13615 heading itself does not appear in the structure of the document.
13617 Copyright information is printed on the back of the title page.
13625 This is a short example of a complete Texinfo file, version 1.0.
13627 Copyright \copy 2016 Free Software Foundation, Inc.
13630 @node Texinfo @samp{Top} node
13631 @subsection Texinfo @samp{Top} node
13633 @cindex #+TEXINFO_DIR_CATEGORY
13634 @cindex #+TEXINFO_DIR_TITLE
13635 @cindex #+TEXINFO_DIR_DESC
13636 You may ultimately want to install your new Info file in your system. You
13637 can write an appropriate entry in the top level directory specifying its
13638 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13639 @code{#+TEXINFO_DIR_TITLE}. Optionally, you can add a short description
13640 using @code{#+TEXINFO_DIR_DESC}. The following example would write an entry
13641 similar to Org's in the @samp{Top} node.
13644 #+TEXINFO_DIR_CATEGORY: Emacs
13645 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13646 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13649 @node Headings and sectioning structure
13650 @subsection Headings and sectioning structure
13652 @vindex org-texinfo-classes
13653 @vindex org-texinfo-default-class
13654 @cindex #+TEXINFO_CLASS
13655 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13656 Texinfo structuring commands. For example, a top level headline appears as
13657 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13658 otherwise. If you need to use a different set of commands, e.g., to start
13659 with @code{@@part} instead of @code{@@chapter}, install a new class in
13660 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13661 keyword. Export process defaults to @code{org-texinfo-default-class} when
13662 there is no such keyword in the document.
13664 If a headline's level has no associated structuring command, or is below
13665 a certain threshold (@pxref{Export settings}), that headline becomes a list
13668 @cindex property, APPENDIX
13669 As an exception, a headline with a non-@code{nil} @code{:APPENDIX:} property becomes
13670 an appendix, independently on its level and the class used.
13672 @cindex property, DESCRIPTION
13673 Each regular sectioning structure creates a menu entry, named after the
13674 heading. You can provide a different, e.g., shorter, title in
13675 @code{:ALT_TITLE:} property (@pxref{Table of contents}). Optionally, you can
13676 specify a description for the item in @code{:DESCRIPTION:} property. E.g.,
13679 * Controlling Screen Display
13681 :ALT_TITLE: Display
13682 :DESCRIPTION: Controlling Screen Display
13687 @subsection Indices
13695 Index entries are created using dedicated keywords. @samp{texinfo} back-end
13696 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13697 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}. For
13698 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13702 #+CINDEX: Defining indexing entries
13705 @cindex property, INDEX
13706 To generate an index, you need to set the @code{:INDEX:} property of
13707 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13708 The headline is then exported as an unnumbered chapter or section command and
13709 the index is inserted after its contents.
13718 @node Quoting Texinfo code
13719 @subsection Quoting Texinfo code
13721 It is possible to insert raw Texinfo code using any of the following
13725 @cindex #+BEGIN_EXPORT texinfo
13727 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13729 #+TEXINFO: @@need800
13730 This paragraph is preceded by...
13732 #+BEGIN_EXPORT texinfo
13733 @@auindex Johnson, Mark
13734 @@auindex Lakoff, George
13738 @node Plain lists in Texinfo export
13739 @subsection Plain lists in Texinfo export
13740 @cindex #+ATTR_TEXINFO, in plain lists
13742 In Texinfo output, description lists appear as two-column tables, using the
13743 default command @code{@@table}. You can use @code{@@ftable} or
13744 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13745 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13747 @vindex org-texinfo-def-table-markup
13748 In any case, these constructs require a highlighting command for entries in
13749 the list. You can provide one with @code{:indic} attribute. If you do not,
13750 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13754 #+ATTR_TEXINFO: :indic @@asis
13755 - foo :: This is the text for /foo/, with no highlighting.
13758 @node Tables in Texinfo export
13759 @subsection Tables in Texinfo export
13760 @cindex #+ATTR_TEXINFO, in tables
13762 When exporting a table, column widths are deduced from the longest cell in
13763 each column. You can also define them explicitly as fractions of the line
13764 length, using @code{:columns} attribute.
13767 #+ATTR_TEXINFO: :columns .5 .5
13768 | a cell | another cell |
13771 @node Images in Texinfo export
13772 @subsection Images in Texinfo export
13773 @cindex #+ATTR_TEXINFO, in images
13775 Images are links to files with a supported image extension and no
13776 description. Image scaling is set with @code{:width} and @code{:height}
13777 attributes. You can also use @code{:alt} to specify alternate text, as
13781 #+ATTR_TEXINFO: :width 1in :alt Alternate @@i@{text@}
13785 @node Special blocks in Texinfo export
13786 @subsection Special blocks
13787 @cindex #+ATTR_TEXINFO, in special blocks
13789 In Texinfo output, special blocks become commands of the same name. Value of
13790 @code{:options} attribute is added right after the beginning of the command.
13794 #+attr_texinfo: :options org-org-export-to-org ...
13796 A somewhat obsessive function.
13804 @@defun org-org-export-to-org ...
13805 A somewhat obsessive function.
13809 @node A Texinfo example
13810 @subsection A Texinfo example
13812 Here is a thorough example. @inforef{GNU Sample Texts,,texinfo} for an
13813 equivalent Texinfo code.
13816 #+MACRO: version 2.0
13817 #+MACRO: updated last updated 4 March 2014
13819 #+OPTIONS: ':t toc:t author:t email:t
13820 #+TITLE: GNU Sample @{@{@{version@}@}@}
13821 #+AUTHOR: A.U. Thor
13822 #+EMAIL: bug-sample@@gnu.org
13825 #+TEXINFO_FILENAME: sample.info
13826 #+TEXINFO_HEADER: @@syncodeindex pg cp
13828 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13829 #+TEXINFO_DIR_TITLE: sample: (sample)
13830 #+TEXINFO_DIR_DESC: Invoking sample
13832 #+TEXINFO_PRINTED_TITLE: GNU Sample
13833 #+SUBTITLE: for version @{@{@{version@}@}@}, @{@{@{updated@}@}@}
13840 This manual is for GNU Sample (version @{@{@{version@}@}@},
13841 @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13843 Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13847 Permission is granted to copy, distribute and/or modify this
13848 document under the terms of the GNU Free Documentation License,
13849 Version 1.3 or any later version published by the Free Software
13850 Foundation; with no Invariant Sections, with no Front-Cover Texts,
13851 and with no Back-Cover Texts. A copy of the license is included in
13852 the section entitled "GNU Free Documentation License".
13858 #+CINDEX: invoking @@command@{sample@}
13860 This is a sample manual. There is no sample program to invoke, but
13861 if there were, you could see its basic usage and command line
13864 * GNU Free Documentation License
13869 #+TEXINFO: @@include fdl.texi
13877 @node iCalendar export
13878 @section iCalendar export
13879 @cindex iCalendar export
13881 @vindex org-icalendar-include-todo
13882 @vindex org-icalendar-use-deadline
13883 @vindex org-icalendar-use-scheduled
13884 @vindex org-icalendar-categories
13885 @vindex org-icalendar-alarm-time
13886 Some people use Org mode for keeping track of projects, but still prefer a
13887 standard calendar application for anniversaries and appointments. In this
13888 case it can be useful to show deadlines and other time-stamped items in Org
13889 files in the calendar application. Org mode can export calendar information
13890 in the standard iCalendar format. If you also want to have TODO entries
13891 included in the export, configure the variable
13892 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
13893 and TODO items as VTODO@. It will also create events from deadlines that are
13894 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
13895 to set the start and due dates for the TODO entry@footnote{See the variables
13896 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13897 As categories, it will use the tags locally defined in the heading, and the
13898 file/tree category@footnote{To add inherited tags or the TODO state,
13899 configure the variable @code{org-icalendar-categories}.}. See the variable
13900 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13903 @vindex org-icalendar-store-UID
13904 @cindex property, ID
13905 The iCalendar standard requires each entry to have a globally unique
13906 identifier (UID). Org creates these identifiers during export. If you set
13907 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13908 @code{:ID:} property of the entry and re-used next time you report this
13909 entry. Since a single entry can give rise to multiple iCalendar entries (as
13910 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13911 prefixes to the UID, depending on what triggered the inclusion of the entry.
13912 In this way the UID remains unique, but a synchronization program can still
13913 figure out from which entry all the different instances originate.
13916 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13917 Create iCalendar entries for the current buffer and store them in the same
13918 directory, using a file extension @file{.ics}.
13919 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13920 @vindex org-agenda-files
13921 Like @kbd{C-c C-e c f}, but do this for all files in
13922 @code{org-agenda-files}. For each of these files, a separate iCalendar
13923 file will be written.
13924 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13925 @vindex org-icalendar-combined-agenda-file
13926 Create a single large iCalendar file from all files in
13927 @code{org-agenda-files} and write it to the file given by
13928 @code{org-icalendar-combined-agenda-file}.
13931 @vindex org-use-property-inheritance
13932 @vindex org-icalendar-include-body
13933 @cindex property, SUMMARY
13934 @cindex property, DESCRIPTION
13935 @cindex property, LOCATION
13936 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13937 property can be inherited from higher in the hierarchy if you configure
13938 @code{org-use-property-inheritance} accordingly.} properties if the selected
13939 entries have them. If not, the summary will be derived from the headline,
13940 and the description from the body (limited to
13941 @code{org-icalendar-include-body} characters).
13943 How this calendar is best read and updated, depends on the application
13944 you are using. The FAQ covers this issue.
13946 @node Other built-in back-ends
13947 @section Other built-in back-ends
13948 @cindex export back-ends, built-in
13949 @vindex org-export-backends
13951 On top of the aforementioned back-ends, Org comes with other built-in ones:
13954 @item @file{ox-man.el}: export to a man page.
13957 To activate these export back-end, customize @code{org-export-backends} or
13958 load them directly with e.g., @code{(require 'ox-man)}. This will add new
13959 keys in the export dispatcher (@pxref{The export dispatcher}).
13961 See the comment section of these files for more information on how to use
13964 @node Export in foreign buffers
13965 @section Export in foreign buffers
13967 Most built-in back-ends come with a command to convert the selected region
13968 into a selected format and replace this region by the exported output. Here
13969 is a list of such conversion commands:
13972 @item org-html-convert-region-to-html
13973 Convert the selected region into HTML.
13974 @item org-latex-convert-region-to-latex
13975 Convert the selected region into @LaTeX{}.
13976 @item org-texinfo-convert-region-to-texinfo
13977 Convert the selected region into @code{Texinfo}.
13978 @item org-md-convert-region-to-md
13979 Convert the selected region into @code{MarkDown}.
13982 This is particularly useful for converting tables and lists in foreign
13983 buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13984 use Org commands for editing a list, and finally select and convert the list
13985 with @code{M-x org-html-convert-region-to-html RET}.
13987 @node Advanced configuration
13988 @section Advanced configuration
13992 @vindex org-export-before-processing-hook
13993 @vindex org-export-before-parsing-hook
13994 Two hooks are run during the first steps of the export process. The first
13995 one, @code{org-export-before-processing-hook} is called before expanding
13996 macros, Babel code and include keywords in the buffer. The second one,
13997 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13998 before parsing the buffer. Their main use is for heavy duties, that is
13999 duties involving structural modifications of the document. For example, one
14000 may want to remove every headline in the buffer during export. The following
14001 code can achieve this:
14005 (defun my-headline-removal (backend)
14006 "Remove all headlines in the current buffer.
14007 BACKEND is the export back-end being used, as a symbol."
14009 (lambda () (delete-region (point) (progn (forward-line) (point))))))
14011 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
14015 Note that functions used in these hooks require a mandatory argument,
14016 a symbol representing the back-end used.
14018 @subheading Filters
14020 @cindex Filters, exporting
14021 Filters are lists of functions applied on a specific part of the output from
14022 a given back-end. More explicitly, each time a back-end transforms an Org
14023 object or element into another language, all functions within a given filter
14024 type are called in turn on the string produced. The string returned by the
14025 last function will be the one used in the final output.
14027 There are filter sets for each type of element or object, for plain text,
14028 for the parse tree, for the export options and for the final output. They
14029 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
14030 where @code{TYPE} is the type targeted by the filter. Valid types are:
14032 @multitable @columnfractions .33 .33 .33
14045 @item export-snippet
14048 @item footnote-definition
14049 @tab footnote-reference
14051 @item horizontal-rule
14052 @tab inline-babel-call
14053 @tab inline-src-block
14058 @tab latex-environment
14059 @tab latex-fragment
14069 @item property-drawer
14075 @item statistics-cookie
14076 @tab strike-through
14089 For example, the following snippet allows me to use non-breaking spaces in
14090 the Org buffer and get them translated into @LaTeX{} without using the
14091 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
14095 (defun my-latex-filter-nobreaks (text backend info)
14096 "Ensure \"_\" are properly handled in LaTeX export."
14097 (when (org-export-derived-backend-p backend 'latex)
14098 (replace-regexp-in-string "_" "~" text)))
14100 (add-to-list 'org-export-filter-plain-text-functions
14101 'my-latex-filter-nobreaks)
14105 Three arguments must be provided to a filter: the code being changed, the
14106 back-end used, and some information about the export process. You can safely
14107 ignore the third argument for most purposes. Note the use of
14108 @code{org-export-derived-backend-p}, which ensures that the filter will only
14109 be applied when using @code{latex} back-end or any other back-end derived
14110 from it (e.g., @code{beamer}).
14112 @subheading Defining filters for individual files
14114 You can customize the export for just a specific file by binding export
14115 filter variables using @code{#+BIND}. Here is an example where we introduce
14116 two filters, one to remove brackets from time stamps, and one to entirely
14117 remove any strike-through text. The functions doing the filtering are
14118 defined in an src block that allows the filter function definitions to exist
14119 in the file itself and ensures that the functions will be there when needed.
14122 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
14123 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
14124 #+begin_src emacs-lisp :exports results :results none
14125 (defun tmp-f-timestamp (s backend info)
14126 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
14127 (defun tmp-f-strike-through (s backend info) "")
14131 @subheading Extending an existing back-end
14133 This is obviously the most powerful customization, since the changes happen
14134 at the parser level. Indeed, some export back-ends are built as extensions
14135 of other ones (e.g., Markdown back-end an extension of HTML back-end).
14137 Extending a back-end means that if an element type is not transcoded by the
14138 new back-end, it will be handled by the original one. Hence you can extend
14139 specific parts of a back-end without too much work.
14141 As an example, imagine we want the @code{ascii} back-end to display the
14142 language used in a source block, when it is available, but only when some
14143 attribute is non-@code{nil}, like the following:
14146 #+ATTR_ASCII: :language t
14149 Because that back-end is lacking in that area, we are going to create a new
14150 back-end, @code{my-ascii} that will do the job.
14154 (defun my-ascii-src-block (src-block contents info)
14155 "Transcode a SRC-BLOCK element from Org to ASCII.
14156 CONTENTS is nil. INFO is a plist used as a communication
14158 (if (not (org-export-read-attribute :attr_ascii src-block :language))
14159 (org-export-with-backend 'ascii src-block contents info)
14161 (format ",--[ %s ]--\n%s`----"
14162 (org-element-property :language src-block)
14163 (replace-regexp-in-string
14165 (org-element-normalize-string
14166 (org-export-format-code-default src-block info)))))))
14168 (org-export-define-derived-backend 'my-ascii 'ascii
14169 :translate-alist '((src-block . my-ascii-src-block)))
14173 The @code{my-ascii-src-block} function looks at the attribute above the
14174 element. If it isn't true, it gives hand to the @code{ascii} back-end.
14175 Otherwise, it creates a box around the code, leaving room for the language.
14176 A new back-end is then created. It only changes its behavior when
14177 translating @code{src-block} type element. Now, all it takes to use the new
14178 back-end is calling the following from an Org buffer:
14181 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
14184 It is obviously possible to write an interactive function for this, install
14185 it in the export dispatcher menu, and so on.
14189 @chapter Publishing
14192 Org includes a publishing management system that allows you to configure
14193 automatic HTML conversion of @emph{projects} composed of interlinked org
14194 files. You can also configure Org to automatically upload your exported HTML
14195 pages and related attachments, such as images and source code files, to a web
14198 You can also use Org to convert files into PDF, or even combine HTML and PDF
14199 conversion so that files are available in both formats on the server.
14201 Publishing has been contributed to Org by David O'Toole.
14204 * Configuration:: Defining projects
14205 * Uploading files:: How to get files up on the server
14206 * Sample configuration:: Example projects
14207 * Triggering publication:: Publication commands
14210 @node Configuration
14211 @section Configuration
14213 Publishing needs significant configuration to specify files, destination
14214 and many other properties of a project.
14217 * Project alist:: The central configuration variable
14218 * Sources and destinations:: From here to there
14219 * Selecting files:: What files are part of the project?
14220 * Publishing action:: Setting the function doing the publishing
14221 * Publishing options:: Tweaking HTML/@LaTeX{} export
14222 * Publishing links:: Which links keep working after publishing?
14223 * Sitemap:: Generating a list of all pages
14224 * Generating an index:: An index that reaches across pages
14227 @node Project alist
14228 @subsection The variable @code{org-publish-project-alist}
14229 @cindex org-publish-project-alist
14230 @cindex projects, for publishing
14232 @vindex org-publish-project-alist
14233 Publishing is configured almost entirely through setting the value of one
14234 variable, called @code{org-publish-project-alist}. Each element of the list
14235 configures one project, and may be in one of the two following forms:
14238 ("project-name" :property value :property value ...)
14239 @r{i.e., a well-formed property list with alternating keys and values}
14241 ("project-name" :components ("project-name" "project-name" ...))
14245 In both cases, projects are configured by specifying property values. A
14246 project defines the set of files that will be published, as well as the
14247 publishing configuration to use when publishing those files. When a project
14248 takes the second form listed above, the individual members of the
14249 @code{:components} property are taken to be sub-projects, which group
14250 together files requiring different publishing options. When you publish such
14251 a ``meta-project'', all the components will also be published, in the
14254 @node Sources and destinations
14255 @subsection Sources and destinations for files
14256 @cindex directories, for publishing
14258 Most properties are optional, but some should always be set. In
14259 particular, Org needs to know where to look for source files,
14260 and where to put published files.
14262 @multitable @columnfractions 0.3 0.7
14263 @item @code{:base-directory}
14264 @tab Directory containing publishing source files
14265 @item @code{:publishing-directory}
14266 @tab Directory where output files will be published. You can directly
14267 publish to a web server using a file name syntax appropriate for
14268 the Emacs @file{tramp} package. Or you can publish to a local directory and
14269 use external tools to upload your website (@pxref{Uploading files}).
14270 @item @code{:preparation-function}
14271 @tab Function or list of functions to be called before starting the
14272 publishing process, for example, to run @code{make} for updating files to be
14273 published. Each preparation function is called with a single argument, the
14274 project property list.
14275 @item @code{:completion-function}
14276 @tab Function or list of functions called after finishing the publishing
14277 process, for example, to change permissions of the resulting files. Each
14278 completion function is called with a single argument, the project property
14283 @node Selecting files
14284 @subsection Selecting files
14285 @cindex files, selecting for publishing
14287 By default, all files with extension @file{.org} in the base directory
14288 are considered part of the project. This can be modified by setting the
14290 @multitable @columnfractions 0.25 0.75
14291 @item @code{:base-extension}
14292 @tab Extension (without the dot!) of source files. This actually is a
14293 regular expression. Set this to the symbol @code{any} if you want to get all
14294 files in @code{:base-directory}, even without extension.
14296 @item @code{:exclude}
14297 @tab Regular expression to match file names that should not be
14298 published, even though they have been selected on the basis of their
14301 @item @code{:include}
14302 @tab List of files to be included regardless of @code{:base-extension}
14303 and @code{:exclude}.
14305 @item @code{:recursive}
14306 @tab non-@code{nil} means, check base-directory recursively for files to publish.
14309 @node Publishing action
14310 @subsection Publishing action
14311 @cindex action, for publishing
14313 Publishing means that a file is copied to the destination directory and
14314 possibly transformed in the process. The default transformation is to export
14315 Org files as HTML files, and this is done by the function
14316 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
14317 export}). But you also can publish your content as PDF files using
14318 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
14319 using the corresponding functions.
14321 If you want to publish the Org file as an @code{.org} file but with the
14322 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
14323 function @code{org-org-publish-to-org}. This will produce @file{file.org}
14324 and put it in the publishing directory. If you want a htmlized version of
14325 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
14326 produce @file{file.org.html} in the publishing directory@footnote{If the
14327 publishing directory is the same than the source directory, @file{file.org}
14328 will be exported as @file{file.org.org}, so probably don't want to do this.}.
14330 Other files like images only need to be copied to the publishing destination.
14331 For this you can use @code{org-publish-attachment}. For non-org files, you
14332 always need to specify the publishing function:
14334 @multitable @columnfractions 0.3 0.7
14335 @item @code{:publishing-function}
14336 @tab Function executing the publication of a file. This may also be a
14337 list of functions, which will all be called in turn.
14338 @item @code{:htmlized-source}
14339 @tab non-@code{nil} means, publish htmlized source.
14342 The function must accept three arguments: a property list containing at least
14343 a @code{:publishing-directory} property, the name of the file to be published
14344 and the path to the publishing directory of the output file. It should take
14345 the specified file, make the necessary transformation (if any) and place the
14346 result into the destination folder.
14348 @node Publishing options
14349 @subsection Options for the exporters
14350 @cindex options, for publishing
14352 The property list can be used to set export options during the publishing
14353 process. In most cases, these properties correspond to user variables in
14354 Org. While some properties are available for all export back-ends, most of
14355 them are back-end specific. The following sections list properties along
14356 with the variable they belong to. See the documentation string of these
14357 options for details.
14359 @vindex org-publish-project-alist
14360 When a property is given a value in @code{org-publish-project-alist}, its
14361 setting overrides the value of the corresponding user variable (if any)
14362 during publishing. Options set within a file (@pxref{Export settings}),
14363 however, override everything.
14365 @subsubheading Generic properties
14367 @multitable {@code{:with-sub-superscript}} {@code{org-export-with-sub-superscripts}}
14368 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
14369 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
14370 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
14371 @item @code{:language} @tab @code{org-export-default-language}
14372 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
14373 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
14374 @item @code{:select-tags} @tab @code{org-export-select-tags}
14375 @item @code{:with-author} @tab @code{org-export-with-author}
14376 @item @code{:with-broken-links} @tab @code{org-export-with-broken-links}
14377 @item @code{:with-clocks} @tab @code{org-export-with-clocks}
14378 @item @code{:with-creator} @tab @code{org-export-with-creator}
14379 @item @code{:with-date} @tab @code{org-export-with-date}
14380 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
14381 @item @code{:with-email} @tab @code{org-export-with-email}
14382 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
14383 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
14384 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
14385 @item @code{:with-latex} @tab @code{org-export-with-latex}
14386 @item @code{:with-planning} @tab @code{org-export-with-planning}
14387 @item @code{:with-priority} @tab @code{org-export-with-priority}
14388 @item @code{:with-properties} @tab @code{org-export-with-properties}
14389 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
14390 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
14391 @item @code{:with-tables} @tab @code{org-export-with-tables}
14392 @item @code{:with-tags} @tab @code{org-export-with-tags}
14393 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
14394 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
14395 @item @code{:with-title} @tab @code{org-export-with-title}
14396 @item @code{:with-toc} @tab @code{org-export-with-toc}
14397 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
14400 @subsubheading ASCII specific properties
14402 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
14403 @item @code{:ascii-bullets} @tab @code{org-ascii-bullets}
14404 @item @code{:ascii-caption-above} @tab @code{org-ascii-caption-above}
14405 @item @code{:ascii-charset} @tab @code{org-ascii-charset}
14406 @item @code{:ascii-global-margin} @tab @code{org-ascii-global-margin}
14407 @item @code{:ascii-format-drawer-function} @tab @code{org-ascii-format-drawer-function}
14408 @item @code{:ascii-format-inlinetask-function} @tab @code{org-ascii-format-inlinetask-function}
14409 @item @code{:ascii-headline-spacing} @tab @code{org-ascii-headline-spacing}
14410 @item @code{:ascii-indented-line-width} @tab @code{org-ascii-indented-line-width}
14411 @item @code{:ascii-inlinetask-width} @tab @code{org-ascii-inlinetask-width}
14412 @item @code{:ascii-inner-margin} @tab @code{org-ascii-inner-margin}
14413 @item @code{:ascii-links-to-notes} @tab @code{org-ascii-links-to-notes}
14414 @item @code{:ascii-list-margin} @tab @code{org-ascii-list-margin}
14415 @item @code{:ascii-paragraph-spacing} @tab @code{org-ascii-paragraph-spacing}
14416 @item @code{:ascii-quote-margin} @tab @code{org-ascii-quote-margin}
14417 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
14418 @item @code{:ascii-table-use-ascii-art} @tab @code{org-ascii-table-use-ascii-art}
14419 @item @code{:ascii-table-widen-columns} @tab @code{org-ascii-table-widen-columns}
14420 @item @code{:ascii-text-width} @tab @code{org-ascii-text-width}
14421 @item @code{:ascii-underline} @tab @code{org-ascii-underline}
14422 @item @code{:ascii-verbatim-format} @tab @code{org-ascii-verbatim-format}
14425 @subsubheading Beamer specific properties
14427 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
14428 @item @code{:beamer-theme} @tab @code{org-beamer-theme}
14429 @item @code{:beamer-column-view-format} @tab @code{org-beamer-column-view-format}
14430 @item @code{:beamer-environments-extra} @tab @code{org-beamer-environments-extra}
14431 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
14432 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
14433 @item @code{:beamer-outline-frame-title} @tab @code{org-beamer-outline-frame-title}
14434 @item @code{:beamer-subtitle-format} @tab @code{org-beamer-subtitle-format}
14437 @subsubheading HTML specific properties
14439 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
14440 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
14441 @item @code{:html-checkbox-type} @tab @code{org-html-checkbox-type}
14442 @item @code{:html-container} @tab @code{org-html-container-element}
14443 @item @code{:html-divs} @tab @code{org-html-divs}
14444 @item @code{:html-doctype} @tab @code{org-html-doctype}
14445 @item @code{:html-extension} @tab @code{org-html-extension}
14446 @item @code{:html-footnote-format} @tab @code{org-html-footnote-format}
14447 @item @code{:html-footnote-separator} @tab @code{org-html-footnote-separator}
14448 @item @code{:html-footnotes-section} @tab @code{org-html-footnotes-section}
14449 @item @code{:html-format-drawer-function} @tab @code{org-html-format-drawer-function}
14450 @item @code{:html-format-headline-function} @tab @code{org-html-format-headline-function}
14451 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
14452 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
14453 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
14454 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
14455 @item @code{:html-head} @tab @code{org-html-head}
14456 @item @code{:html-home/up-format} @tab @code{org-html-home/up-format}
14457 @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy}
14458 @item @code{:html-indent} @tab @code{org-html-indent}
14459 @item @code{:html-infojs-options} @tab @code{org-html-infojs-options}
14460 @item @code{:html-infojs-template} @tab @code{org-html-infojs-template}
14461 @item @code{:html-inline-image-rules} @tab @code{org-html-inline-image-rules}
14462 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
14463 @item @code{:html-link-home} @tab @code{org-html-link-home}
14464 @item @code{:html-link-org-files-as-html} @tab @code{org-html-link-org-files-as-html}
14465 @item @code{:html-link-up} @tab @code{org-html-link-up}
14466 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
14467 @item @code{:html-mathjax-options} @tab @code{org-html-mathjax-options}
14468 @item @code{:html-mathjax-template} @tab @code{org-html-mathjax-template}
14469 @item @code{:html-metadata-timestamp-format} @tab @code{org-html-metadata-timestamp-format}
14470 @item @code{:html-postamble-format} @tab @code{org-html-postamble-format}
14471 @item @code{:html-postamble} @tab @code{org-html-postamble}
14472 @item @code{:html-preamble-format} @tab @code{org-html-preamble-format}
14473 @item @code{:html-preamble} @tab @code{org-html-preamble}
14474 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
14475 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
14476 @item @code{:html-table-caption-above} @tab @code{org-html-table-caption-above}
14477 @item @code{:html-table-data-tags} @tab @code{org-html-table-data-tags}
14478 @item @code{:html-table-header-tags} @tab @code{org-html-table-header-tags}
14479 @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags}
14480 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
14481 @item @code{:html-tag-class-prefix} @tab @code{org-html-tag-class-prefix}
14482 @item @code{:html-text-markup-alist} @tab @code{org-html-text-markup-alist}
14483 @item @code{:html-todo-kwd-class-prefix} @tab @code{org-html-todo-kwd-class-prefix}
14484 @item @code{:html-toplevel-hlevel} @tab @code{org-html-toplevel-hlevel}
14485 @item @code{:html-use-infojs} @tab @code{org-html-use-infojs}
14486 @item @code{:html-validation-link} @tab @code{org-html-validation-link}
14487 @item @code{:html-viewport} @tab @code{org-html-viewport}
14488 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
14491 @subsubheading @LaTeX{} specific properties
14493 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}}
14494 @item @code{:latex-active-timestamp-format} @tab @code{org-latex-active-timestamp-format}
14495 @item @code{:latex-caption-above} @tab @code{org-latex-caption-above}
14496 @item @code{:latex-classes} @tab @code{org-latex-classes}
14497 @item @code{:latex-class} @tab @code{org-latex-default-class}
14498 @item @code{:latex-compiler} @tab @code{org-latex-compiler}
14499 @item @code{:latex-default-figure-position} @tab @code{org-latex-default-figure-position}
14500 @item @code{:latex-default-table-environment} @tab @code{org-latex-default-table-environment}
14501 @item @code{:latex-default-table-mode} @tab @code{org-latex-default-table-mode}
14502 @item @code{:latex-diary-timestamp-format} @tab @code{org-latex-diary-timestamp-format}
14503 @item @code{:latex-footnote-defined-format} @tab @code{org-latex-footnote-defined-format}
14504 @item @code{:latex-footnote-separator} @tab @code{org-latex-footnote-separator}
14505 @item @code{:latex-format-drawer-function} @tab @code{org-latex-format-drawer-function}
14506 @item @code{:latex-format-headline-function} @tab @code{org-latex-format-headline-function}
14507 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
14508 @item @code{:latex-hyperref-template} @tab @code{org-latex-hyperref-template}
14509 @item @code{:latex-image-default-height} @tab @code{org-latex-image-default-height}
14510 @item @code{:latex-image-default-option} @tab @code{org-latex-image-default-option}
14511 @item @code{:latex-image-default-width} @tab @code{org-latex-image-default-width}
14512 @item @code{:latex-inactive-timestamp-format} @tab @code{org-latex-inactive-timestamp-format}
14513 @item @code{:latex-inline-image-rules} @tab @code{org-latex-inline-image-rules}
14514 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
14515 @item @code{:latex-listings-langs} @tab @code{org-latex-listings-langs}
14516 @item @code{:latex-listings-options} @tab @code{org-latex-listings-options}
14517 @item @code{:latex-listings} @tab @code{org-latex-listings}
14518 @item @code{:latex-minted-langs} @tab @code{org-latex-minted-langs}
14519 @item @code{:latex-minted-options} @tab @code{org-latex-minted-options}
14520 @item @code{:latex-prefer-user-labels} @tab @code{org-latex-prefer-user-labels}
14521 @item @code{:latex-subtitle-format} @tab @code{org-latex-subtitle-format}
14522 @item @code{:latex-subtitle-separate} @tab @code{org-latex-subtitle-separate}
14523 @item @code{:latex-table-scientific-notation} @tab @code{org-latex-table-scientific-notation}
14524 @item @code{:latex-tables-booktabs} @tab @code{org-latex-tables-booktabs}
14525 @item @code{:latex-tables-centered} @tab @code{org-latex-tables-centered}
14526 @item @code{:latex-text-markup-alist} @tab @code{org-latex-text-markup-alist}
14527 @item @code{:latex-title-command} @tab @code{org-latex-title-command}
14528 @item @code{:latex-toc-command} @tab @code{org-latex-toc-command}
14531 @subsubheading Markdown specific properties
14533 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
14534 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
14537 @subsubheading ODT specific properties
14539 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
14540 @item @code{:odt-content-template-file} @tab @code{org-odt-content-template-file}
14541 @item @code{:odt-display-outline-level} @tab @code{org-odt-display-outline-level}
14542 @item @code{:odt-fontify-srcblocks} @tab @code{org-odt-fontify-srcblocks}
14543 @item @code{:odt-format-drawer-function} @tab @code{org-odt-format-drawer-function}
14544 @item @code{:odt-format-headline-function} @tab @code{org-odt-format-headline-function}
14545 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
14546 @item @code{:odt-inline-formula-rules} @tab @code{org-odt-inline-formula-rules}
14547 @item @code{:odt-inline-image-rules} @tab @code{org-odt-inline-image-rules}
14548 @item @code{:odt-pixels-per-inch} @tab @code{org-odt-pixels-per-inch}
14549 @item @code{:odt-styles-file} @tab @code{org-odt-styles-file}
14550 @item @code{:odt-table-styles} @tab @code{org-odt-table-styles}
14551 @item @code{:odt-use-date-fields} @tab @code{org-odt-use-date-fields}
14554 @subsubheading Texinfo specific properties
14556 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14557 @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format}
14558 @item @code{:texinfo-classes} @tab @code{org-texinfo-classes}
14559 @item @code{:texinfo-class} @tab @code{org-texinfo-default-class}
14560 @item @code{:texinfo-def-table-markup} @tab @code{org-texinfo-def-table-markup}
14561 @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format}
14562 @item @code{:texinfo-filename} @tab @code{org-texinfo-filename}
14563 @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function}
14564 @item @code{:texinfo-format-headline-function} @tab @code{org-texinfo-format-headline-function}
14565 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14566 @item @code{:texinfo-inactive-timestamp-format} @tab @code{org-texinfo-inactive-timestamp-format}
14567 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14568 @item @code{:texinfo-node-description-column} @tab @code{org-texinfo-node-description-column}
14569 @item @code{:texinfo-table-scientific-notation} @tab @code{org-texinfo-table-scientific-notation}
14570 @item @code{:texinfo-tables-verbatim} @tab @code{org-texinfo-tables-verbatim}
14571 @item @code{:texinfo-text-markup-alist} @tab @code{org-texinfo-text-markup-alist}
14574 @node Publishing links
14575 @subsection Links between published files
14576 @cindex links, publishing
14578 To create a link from one Org file to another, you would use something like
14579 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org}
14580 (@pxref{External links}). When published, this link becomes a link to
14581 @file{foo.html}. You can thus interlink the pages of your ``org web''
14582 project and the links will work as expected when you publish them to HTML.
14583 If you also publish the Org source file and want to link to it, use an
14584 @code{http:} link instead of a @code{file:} link, because @code{file:} links
14585 are converted to link to the corresponding @file{html} file.
14587 You may also link to related files, such as images. Provided you are careful
14588 with relative file names, and provided you have also configured Org to upload
14589 the related files, these links will work too. See @ref{Complex example}, for
14590 an example of this usage.
14592 Eventually, links between published documents can contain some search options
14593 (@pxref{Search options}), which will be resolved to the appropriate location
14594 in the linked file. For example, once published to HTML, the following links
14595 all point to a dedicated anchor in @file{foo.html}.
14598 [[file:foo.org::*heading]]
14599 [[file:foo.org::#custom-id]]
14600 [[file:foo.org::target]]
14604 @subsection Generating a sitemap
14605 @cindex sitemap, of published pages
14607 The following properties may be used to control publishing of
14608 a map of files for a given project.
14610 @multitable @columnfractions 0.35 0.65
14611 @item @code{:auto-sitemap}
14612 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14613 or @code{org-publish-all}.
14615 @item @code{:sitemap-filename}
14616 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
14617 becomes @file{sitemap.html}).
14619 @item @code{:sitemap-title}
14620 @tab Title of sitemap page. Defaults to name of file.
14622 @item @code{:sitemap-function}
14623 @tab Plug-in function to use for generation of the sitemap.
14624 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14625 of links to all files in the project.
14627 @item @code{:sitemap-sort-folders}
14628 @tab Where folders should appear in the sitemap. Set this to @code{first}
14629 (default) or @code{last} to display folders first or last,
14630 respectively. Any other value will mix files and folders.
14632 @item @code{:sitemap-sort-files}
14633 @tab How the files are sorted in the site map. Set this to
14634 @code{alphabetically} (default), @code{chronologically} or
14635 @code{anti-chronologically}. @code{chronologically} sorts the files with
14636 older date first while @code{anti-chronologically} sorts the files with newer
14637 date first. @code{alphabetically} sorts the files alphabetically. The date of
14638 a file is retrieved with @code{org-publish-find-date}.
14640 @item @code{:sitemap-ignore-case}
14641 @tab Should sorting be case-sensitive? Default @code{nil}.
14643 @item @code{:sitemap-file-entry-format}
14644 @tab With this option one can tell how a sitemap's entry is formatted in the
14645 sitemap. This is a format string with some escape sequences: @code{%t} stands
14646 for the title of the file, @code{%a} stands for the author of the file and
14647 @code{%d} stands for the date of the file. The date is retrieved with the
14648 @code{org-publish-find-date} function and formatted with
14649 @code{org-publish-sitemap-date-format}. Default @code{%t}.
14651 @item @code{:sitemap-date-format}
14652 @tab Format string for the @code{format-time-string} function that tells how
14653 a sitemap entry's date is to be formatted. This property bypasses
14654 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14656 @item @code{:sitemap-sans-extension}
14657 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14658 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14659 Defaults to @code{nil}.
14663 @node Generating an index
14664 @subsection Generating an index
14665 @cindex index, in a publishing project
14667 Org mode can generate an index across the files of a publishing project.
14669 @multitable @columnfractions 0.25 0.75
14670 @item @code{:makeindex}
14671 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14672 publish it as @file{theindex.html}.
14675 The file will be created when first publishing a project with the
14676 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
14677 "theindex.inc"}. You can then build around this include statement by adding
14678 a title, style information, etc.
14681 Index entries are specified with @code{#+INDEX} keyword. An entry that
14682 contains an exclamation mark will create a sub item.
14687 #+INDEX: Application!CV
14690 @node Uploading files
14691 @section Uploading files
14695 For those people already utilizing third party sync tools such as
14696 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14697 @i{remote} publishing facilities of Org mode which rely heavily on
14698 Tramp. Tramp, while very useful and powerful, tends not to be
14699 so efficient for multiple file transfer and has been known to cause problems
14702 Specialized synchronization utilities offer several advantages. In addition
14703 to timestamp comparison, they also do content and permissions/attribute
14704 checks. For this reason you might prefer to publish your web to a local
14705 directory (possibly even @i{in place} with your Org files) and then use
14706 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14708 Since Unison (for example) can be configured as to which files to transfer to
14709 a certain remote destination, it can greatly simplify the project publishing
14710 definition. Simply keep all files in the correct location, process your Org
14711 files with @code{org-publish} and let the synchronization tool do the rest.
14712 You do not need, in this scenario, to include attachments such as @file{jpg},
14713 @file{css} or @file{gif} files in the project definition since the 3rd party
14716 Publishing to a local directory is also much faster than to a remote one, so
14717 that you can afford more easily to republish entire projects. If you set
14718 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14719 benefit of re-including any changed external files such as source example
14720 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
14721 Org is not smart enough to detect if included files have been modified.
14723 @node Sample configuration
14724 @section Sample configuration
14726 Below we provide two example configurations. The first one is a simple
14727 project publishing only a set of Org files. The second example is
14728 more complex, with a multi-component project.
14731 * Simple example:: One-component publishing
14732 * Complex example:: A multi-component publishing example
14735 @node Simple example
14736 @subsection Example: simple publishing configuration
14738 This example publishes a set of Org files to the @file{public_html}
14739 directory on the local machine.
14742 (setq org-publish-project-alist
14744 :base-directory "~/org/"
14745 :publishing-directory "~/public_html"
14746 :section-numbers nil
14748 :html-head "<link rel=\"stylesheet\"
14749 href=\"../other/mystyle.css\"
14750 type=\"text/css\"/>")))
14753 @node Complex example
14754 @subsection Example: complex publishing configuration
14756 This more complicated example publishes an entire website, including
14757 Org files converted to HTML, image files, Emacs Lisp source code, and
14758 style sheets. The publishing directory is remote and private files are
14761 To ensure that links are preserved, care should be taken to replicate
14762 your directory structure on the web server, and to use relative file
14763 paths. For example, if your Org files are kept in @file{~/org} and your
14764 publishable images in @file{~/images}, you would link to an image with
14767 file:../images/myimage.png
14770 On the web server, the relative path to the image should be the
14771 same. You can accomplish this by setting up an "images" folder in the
14772 right place on the web server, and publishing images to it.
14775 (setq org-publish-project-alist
14777 :base-directory "~/org/"
14778 :base-extension "org"
14779 :publishing-directory "/ssh:user@@host:~/html/notebook/"
14780 :publishing-function org-html-publish-to-html
14781 :exclude "PrivatePage.org" ;; regexp
14783 :section-numbers nil
14785 :html-head "<link rel=\"stylesheet\"
14786 href=\"../other/mystyle.css\" type=\"text/css\"/>"
14790 :base-directory "~/images/"
14791 :base-extension "jpg\\|gif\\|png"
14792 :publishing-directory "/ssh:user@@host:~/html/images/"
14793 :publishing-function org-publish-attachment)
14796 :base-directory "~/other/"
14797 :base-extension "css\\|el"
14798 :publishing-directory "/ssh:user@@host:~/html/other/"
14799 :publishing-function org-publish-attachment)
14800 ("website" :components ("orgfiles" "images" "other"))))
14803 @node Triggering publication
14804 @section Triggering publication
14806 Once properly configured, Org can publish with the following commands:
14809 @orgcmd{C-c C-e P x,org-publish}
14810 Prompt for a specific project and publish all files that belong to it.
14811 @orgcmd{C-c C-e P p,org-publish-current-project}
14812 Publish the project containing the current file.
14813 @orgcmd{C-c C-e P f,org-publish-current-file}
14814 Publish only the current file.
14815 @orgcmd{C-c C-e P a,org-publish-all}
14816 Publish every project.
14819 @vindex org-publish-use-timestamps-flag
14820 Org uses timestamps to track when a file has changed. The above functions
14821 normally only publish changed files. You can override this and force
14822 publishing of all files by giving a prefix argument to any of the commands
14823 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14824 This may be necessary in particular if files include other files via
14825 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14828 @node Working with source code
14829 @chapter Working with source code
14830 @cindex Schulte, Eric
14831 @cindex Davison, Dan
14832 @cindex source code, working with
14834 Source code can be included in Org mode documents using a @samp{src} block,
14838 #+BEGIN_SRC emacs-lisp
14839 (defun org-xor (a b)
14845 Org mode provides a number of features for working with live source code,
14846 including editing of code blocks in their native major-mode, evaluation of
14847 code blocks, converting code blocks into source files (known as @dfn{tangling}
14848 in literate programming), and exporting code blocks and their
14849 results in several formats. This functionality was contributed by Eric
14850 Schulte and Dan Davison, and was originally named Org-babel.
14852 The following sections describe Org mode's code block handling facilities.
14855 * Structure of code blocks:: Code block syntax described
14856 * Editing source code:: Language major-mode editing
14857 * Exporting code blocks:: Export contents and/or results
14858 * Extracting source code:: Create pure source code files
14859 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
14860 * Library of Babel:: Use and contribute to a library of useful code blocks
14861 * Languages:: List of supported code block languages
14862 * Header arguments:: Configure code block functionality
14863 * Results of evaluation:: How evaluation results are handled
14864 * Noweb reference syntax:: Literate programming in Org mode
14865 * Key bindings and useful functions:: Work quickly with code blocks
14866 * Batch execution:: Call functions from the command line
14870 @node Structure of code blocks
14871 @section Structure of code blocks
14872 @cindex code block, structure
14873 @cindex source code, block structure
14875 @cindex #+BEGIN_SRC
14877 Live code blocks can be specified with a @samp{src} block or
14878 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14879 @ref{Easy templates} system} The structure of a @samp{src} block is
14883 #+BEGIN_SRC <language> <switches> <header arguments>
14888 The @code{#+NAME:} line is optional, and can be used to name the code
14889 block. Live code blocks require that a language be specified on the
14890 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
14891 @cindex source code, inline
14893 Live code blocks can also be specified inline using
14896 src_<language>@{<body>@}
14902 src_<language>[<header arguments>]@{<body>@}
14906 @item <#+NAME: name>
14907 This line associates a name with the code block. This is similar to the
14908 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14909 files. Referencing the name of a code block makes it possible to evaluate
14910 the block from other places in the file, from other files, or from Org mode
14911 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
14912 and the behavior of Org mode when two or more blocks share the same name is
14916 The language of the code in the block (see @ref{Languages}).
14917 @cindex source code, language
14919 Optional switches control code block export (see the discussion of switches in
14920 @ref{Literal examples})
14921 @cindex source code, switches
14922 @item <header arguments>
14923 Optional header arguments control many aspects of evaluation, export and
14924 tangling of code blocks (see @ref{Header arguments}).
14925 Header arguments can also be set on a per-buffer or per-subtree
14926 basis using properties.
14927 @item source code, header arguments
14929 Source code in the specified language.
14933 @node Editing source code
14934 @section Editing source code
14935 @cindex code block, editing
14936 @cindex source code, editing
14938 @vindex org-edit-src-auto-save-idle-delay
14939 @vindex org-edit-src-turn-on-auto-save
14941 Use @kbd{C-c '} to edit the current code block. This brings up a language
14942 major-mode edit buffer containing the body of the code block. Manually
14943 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14944 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14945 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14946 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14947 Use @kbd{C-c '} again to exit.
14949 The @code{org-src-mode} minor mode will be active in the edit buffer. The
14950 following variables can be used to configure the behavior of the edit
14951 buffer. See also the customization group @code{org-edit-structure} for
14952 further configuration options.
14955 @item org-src-lang-modes
14956 If an Emacs major-mode named @code{<lang>-mode} exists, where
14957 @code{<lang>} is the language named in the header line of the code block,
14958 then the edit buffer will be placed in that major-mode. This variable
14959 can be used to map arbitrary language names to existing major modes.
14960 @item org-src-window-setup
14961 Controls the way Emacs windows are rearranged when the edit buffer is created.
14962 @item org-src-preserve-indentation
14963 @cindex indentation, in source blocks
14964 By default, the value is @code{nil}, which means that code blocks evaluated
14965 during export or tangled are indented according to context, possibly altering
14966 leading sequences of spaces and tab characters in the process. When
14967 non-@code{nil}, indentation is relative to left column, and therefore, not
14968 modified during export or tangling. This variable is especially useful for
14969 tangling languages such as Python, in which whitespace indentation in the
14970 output is critical.
14971 @item org-src-ask-before-returning-to-edit-buffer
14972 By default, Org will ask before returning to an open edit buffer. Set this
14973 variable to @code{nil} to switch without asking.
14976 To turn on native code fontification in the @emph{Org} buffer, configure the
14977 variable @code{org-src-fontify-natively}. You can also change the appearance
14978 of source blocks by customizing the @code{org-block} face or for specific
14979 languages, by defining @code{org-block-LANGUAGE} faces. The following
14980 example shades the background of ``ordinary'' blocks while allowing Emacs
14981 Lisp source blocks to have a special color.
14984 (set-face-attribute 'org-block nil :background
14986 (face-attribute 'default :background) 3))
14988 (defface org-block-emacs-lisp
14989 '((t (:background "#EEE2FF")))
14990 "Face for Emacs Lisp src blocks")
14993 @node Exporting code blocks
14994 @section Exporting code blocks
14995 @cindex code block, exporting
14996 @cindex source code, exporting
14998 It is possible to export the @emph{code} of code blocks, the @emph{results}
14999 of code block evaluation, @emph{both} the code and the results of code block
15000 evaluation, or @emph{none}. For most languages, the default exports code.
15001 However, for some languages (e.g., @code{ditaa}) the default exports the
15002 results of code block evaluation. For information on exporting code block
15003 bodies, see @ref{Literal examples}. For information on exporting
15004 parts of Org documents, see @ref{Exporting}.
15006 The @code{:exports} header argument can be used to specify export
15007 behavior (note that these arguments are only relevant for code blocks, not
15010 @subsubheading Header arguments:
15013 @cindex @code{:exports}, src header argument
15014 @item :exports code
15015 The default in most languages. The body of the code block is exported, as
15016 described in @ref{Literal examples}.
15017 @item :exports results
15018 The code block will be evaluated each time to buffer is exported, and the
15019 results will be placed in the Org mode buffer for export, either updating
15020 previous results of the code block located anywhere in the buffer or, if no
15021 previous results exist, placing the results immediately after the code block.
15022 The body of the code block will not be exported.
15023 @item :exports both
15024 Both the code block and its results will be exported.
15025 @item :exports none
15026 Neither the code block nor its results will be exported.
15029 It is possible to inhibit the evaluation of code blocks during export.
15030 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
15031 ensure that no code blocks are evaluated as part of the export process. This
15032 can be useful in situations where potentially untrusted Org mode files are
15033 exported in an automated fashion, for example when Org mode is used as the
15034 markup language for a wiki. It is also possible to set this variable to
15035 @code{inline-only}. In that case, only inline code blocks will be
15036 evaluated, in order to insert their results. Non-inline code blocks are
15037 assumed to have their results already inserted in the buffer by manual
15038 evaluation. This setting is useful to avoid expensive recalculations during
15039 export, not to provide security.
15041 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
15042 on export. However, code blocks in subtrees excluded from export
15043 (@pxref{Export settings}) may be evaluated on export.
15045 @node Extracting source code
15046 @section Extracting source code
15048 @cindex source code, extracting
15049 @cindex code block, extracting source code
15051 Creating pure source code files by extracting code from source blocks is
15052 referred to as ``tangling''---a term adopted from the literate programming
15053 community. During ``tangling'' of code blocks their bodies are expanded
15054 using @code{org-babel-expand-src-block} which can expand both variable and
15055 ``noweb'' style references (see @ref{Noweb reference syntax}).
15057 @subsubheading Header arguments
15060 @cindex @code{:tangle}, src header argument
15062 The default. The code block is not included in the tangled output.
15064 Include the code block in the tangled output. The output file name is the
15065 name of the org file with the extension @samp{.org} replaced by the extension
15066 for the block language.
15067 @item :tangle filename
15068 Include the code block in the tangled output to file @samp{filename}.
15072 @subsubheading Functions
15075 @item org-babel-tangle
15076 Tangle the current file. Bound to @kbd{C-c C-v t}.
15078 With prefix argument only tangle the current code block.
15079 @item org-babel-tangle-file
15080 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
15083 @subsubheading Hooks
15086 @item org-babel-post-tangle-hook
15087 This hook is run from within code files tangled by @code{org-babel-tangle}.
15088 Example applications could include post-processing, compilation or evaluation
15089 of tangled code files.
15092 @subsubheading Jumping between code and Org
15094 When tangling code from an Org-mode buffer to a source code file, you'll
15095 frequently find yourself viewing the file of tangled source code (e.g., many
15096 debuggers point to lines of the source code file). It is useful to be able
15097 to navigate from the tangled source to the Org-mode buffer from which the
15100 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
15101 code to Org-mode functionality. Two header arguments are required for
15102 jumping to work, first the @code{padline} (@ref{padline}) option must be set
15103 to true (the default setting), second the @code{comments} (@ref{comments})
15104 header argument must be set to @code{link}, which will insert comments into
15105 the source code buffer which point back to the original Org-mode file.
15107 @node Evaluating code blocks
15108 @section Evaluating code blocks
15109 @cindex code block, evaluating
15110 @cindex source code, evaluating
15113 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
15114 potential for that code to do harm. Org mode provides safeguards to ensure
15115 that code is only evaluated after explicit confirmation from the user. For
15116 information on these safeguards (and on how to disable them) see @ref{Code
15117 evaluation security}.} and the results of evaluation optionally placed in the
15118 Org mode buffer. The results of evaluation are placed following a line that
15119 begins by default with @code{#+RESULTS} and optionally a cache identifier
15120 and/or the name of the evaluated code block. The default value of
15121 @code{#+RESULTS} can be changed with the customizable variable
15122 @code{org-babel-results-keyword}.
15124 By default, the evaluation facility is only enabled for Lisp code blocks
15125 specified as @code{emacs-lisp}. See @ref{Languages} to enable other
15126 supported languages. See @ref{Structure of code blocks} for information on
15127 the syntax used to define a code block.
15130 There are a number of ways to evaluate code blocks. The simplest is to press
15131 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
15132 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
15133 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
15134 @code{org-babel-execute-src-block} function to evaluate the block and insert
15135 its results into the Org mode buffer.
15138 It is also possible to evaluate named code blocks from
15139 anywhere@footnote{Actually, the constructs call_<name>() and src_<lang>@{@}
15140 are not evaluated when they appear in a keyword line (i.e. lines starting
15141 with @code{#+KEYWORD:}, @pxref{In-buffer settings}).} in an Org mode buffer
15142 or an Org mode table. These named code blocks can be located in the current
15143 Org mode buffer or in the ``Library of Babel'' (@pxref{Library of Babel}).
15144 Named code blocks can be evaluated with a separate @code{#+CALL:} line or
15145 inline within a block of text. In both cases the result is wrapped according
15146 to the value of @code{org-babel-inline-result-wrap}, which by default is
15147 @code{"=%s="} for markup that produces verbatim text.
15149 The syntax of the @code{#+CALL:} line is
15152 #+CALL: <name>(<arguments>)
15153 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
15156 The syntax for inline evaluation of named code blocks is
15159 ... call_<name>(<arguments>) ...
15160 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
15165 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
15167 Arguments specified in this section will be passed to the code block. These
15168 arguments use standard function call syntax, rather than
15169 header argument syntax. For example, a @code{#+CALL:} line that passes the
15170 number four to a code block named @code{double}, which declares the header
15171 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
15172 @item <inside header arguments>
15173 Inside header arguments are passed through and applied to the named code
15174 block. These arguments use header argument syntax rather than standard
15175 function call syntax. Inside header arguments affect how the code block is
15176 evaluated. For example, @code{[:results output]} will collect the results of
15177 everything printed to @code{STDOUT} during execution of the code block.
15178 @item <end header arguments>
15179 End header arguments are applied to the calling instance and do not affect
15180 evaluation of the named code block. They affect how the results are
15181 incorporated into the Org mode buffer and how the call line is exported. For
15182 example, @code{:results html} will insert the results of the call line
15183 evaluation in the Org buffer, wrapped in a @code{BEGIN_EXPORT html} block.
15185 For more examples of passing header arguments to @code{#+CALL:} lines see
15186 @ref{Header arguments in function calls}.
15189 @node Library of Babel
15190 @section Library of Babel
15191 @cindex babel, library of
15192 @cindex source code, library
15193 @cindex code block, library
15195 The ``Library of Babel'' consists of code blocks that can be called from any
15196 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
15197 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
15198 code blocks} for information on the syntax of remote code block evaluation).
15200 The central repository of code blocks in the ``Library of Babel'' is housed
15201 in an Org mode file located in the @samp{doc} directory of Org mode.
15203 Users can add code blocks they believe to be generally useful to their
15204 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
15205 then loaded into the library with @code{org-babel-lob-ingest}.
15208 Code blocks located in any Org mode file can be loaded into the ``Library of
15209 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
15214 @cindex babel, languages
15215 @cindex source code, languages
15216 @cindex code block, languages
15218 Code blocks in the following languages are supported.
15220 @multitable @columnfractions 0.25 0.25 0.25 0.25
15221 @headitem @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
15222 @item Asymptote @tab asymptote @tab Awk @tab awk
15223 @item C @tab C @tab C++ @tab C++
15224 @item Clojure @tab clojure @tab CSS @tab css
15225 @item D @tab d @tab ditaa @tab ditaa
15226 @item Graphviz @tab dot @tab Emacs Calc @tab calc
15227 @item Emacs Lisp @tab emacs-lisp @tab Fortran @tab fortran
15228 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
15229 @item Java @tab java @tab Javascript @tab js
15230 @item LaTeX @tab latex @tab Ledger @tab ledger
15231 @item Lisp @tab lisp @tab Lilypond @tab lilypond
15232 @item MATLAB @tab matlab @tab Mscgen @tab mscgen
15233 @item Objective Caml @tab ocaml @tab Octave @tab octave
15234 @item Org mode @tab org @tab Oz @tab oz
15235 @item Perl @tab perl @tab Plantuml @tab plantuml
15236 @item Processing.js @tab processing @tab Python @tab python
15237 @item R @tab R @tab Ruby @tab ruby
15238 @item Sass @tab sass @tab Scheme @tab scheme
15239 @item GNU Screen @tab screen @tab Sed @tab sed
15240 @item shell @tab sh @tab SQL @tab sql
15241 @item SQLite @tab sqlite @tab @tab
15244 Language-specific documentation is available for some languages. If
15245 available, it can be found at
15246 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
15248 The option @code{org-babel-load-languages} controls which languages are
15249 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
15250 variable can be set using the customization interface or by adding code like
15251 the following to your emacs configuration.
15253 The following disables @code{emacs-lisp} evaluation and enables evaluation of
15254 @code{R} code blocks.
15257 (org-babel-do-load-languages
15258 'org-babel-load-languages
15259 '((emacs-lisp . nil)
15263 It is also possible to enable support for a language by loading the related
15264 elisp file with @code{require}.
15266 The following adds support for evaluating @code{clojure} code blocks.
15269 (require 'ob-clojure)
15272 @node Header arguments
15273 @section Header arguments
15274 @cindex code block, header arguments
15275 @cindex source code, block header arguments
15277 Code block functionality can be configured with header arguments. This
15278 section provides an overview of the use of header arguments, and then
15279 describes each header argument in detail.
15282 * Using header arguments:: Different ways to set header arguments
15283 * Specific header arguments:: List of header arguments
15286 @node Using header arguments
15287 @subsection Using header arguments
15289 The values of header arguments can be set in several way. When the header
15290 arguments in each layer have been determined, they are combined in order from
15291 the first, least specific (having the lowest priority) up to the last, most
15292 specific (having the highest priority). A header argument with a higher
15293 priority replaces the same header argument specified at lower priority.
15295 * System-wide header arguments:: Set global default values
15296 * Language-specific header arguments:: Set default values by language
15297 * Header arguments in Org mode properties:: Set default values for a buffer or heading
15298 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
15299 * Code block specific header arguments:: The most common way to set values
15300 * Header arguments in function calls:: The most specific level
15304 @node System-wide header arguments
15305 @subsubheading System-wide header arguments
15306 @vindex org-babel-default-header-args
15307 System-wide values of header arguments can be specified by adapting the
15308 @code{org-babel-default-header-args} variable:
15310 @cindex @code{:session}, src header argument
15311 @cindex @code{:results}, src header argument
15312 @cindex @code{:exports}, src header argument
15313 @cindex @code{:cache}, src header argument
15314 @cindex @code{:noweb}, src header argument
15317 :results => "replace"
15323 For example, the following example could be used to set the default value of
15324 @code{:noweb} header arguments to @code{yes}. This would have the effect of
15325 expanding @code{:noweb} references by default when evaluating source code
15329 (setq org-babel-default-header-args
15330 (cons '(:noweb . "yes")
15331 (assq-delete-all :noweb org-babel-default-header-args)))
15334 @node Language-specific header arguments
15335 @subsubheading Language-specific header arguments
15336 Each language can define its own set of default header arguments in variable
15337 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
15338 of the language. See the language-specific documentation available online at
15339 @uref{http://orgmode.org/worg/org-contrib/babel}.
15341 @node Header arguments in Org mode properties
15342 @subsubheading Header arguments in Org mode properties
15344 Buffer-wide header arguments may be specified as properties through the use
15345 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
15346 @ref{Property syntax}).
15348 For example the following would set @code{session} to @code{*R*} (only for R
15349 code blocks), and @code{results} to @code{silent} for every code block in the
15350 buffer, ensuring that all execution took place in the same session, and no
15351 results would be inserted into the buffer.
15354 #+PROPERTY: header-args:R :session *R*
15355 #+PROPERTY: header-args :results silent
15358 Header arguments read from Org mode properties can also be set on a
15359 per-subtree basis using property drawers (see @ref{Property syntax}).
15360 @vindex org-use-property-inheritance
15361 When properties are used to set default header arguments, they are always
15362 looked up with inheritance, regardless of the value of
15363 @code{org-use-property-inheritance}. Properties are evaluated as seen by the
15364 outermost call or source block.
15366 In the following example the value of
15367 the @code{:cache} header argument will default to @code{yes} in all code
15368 blocks in the subtree rooted at the following heading:
15373 :header-args: :cache yes
15378 @vindex org-babel-default-header-args
15379 Properties defined in this way override the properties set in
15380 @code{org-babel-default-header-args} and are applied for all activated
15381 languages. It is convenient to use the @code{org-set-property} function
15382 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
15384 @node Language-specific header arguments in Org mode properties
15385 @subsubheading Language-specific header arguments in Org mode properties
15387 Language-specific header arguments are also read from properties
15388 @code{header-args:<lang>} where @code{<lang>} is the name of the language
15389 targeted. As an example
15394 :header-args:clojure: :session *clojure-1*
15395 :header-args:R: :session *R*
15399 :header-args:clojure: :session *clojure-2*
15403 would independently set a default session header argument for R and clojure
15404 for calls and source blocks under subtree ``Heading'' and change to a
15405 different clojure setting for evaluations under subtree ``Subheading'', while
15406 the R session is inherited from ``Heading'' and therefore unchanged.
15408 @node Code block specific header arguments
15409 @subsubheading Code block specific header arguments
15411 The most common way to assign values to header arguments is at the
15412 code block level. This can be done by listing a sequence of header
15413 arguments and their values as part of the @code{#+BEGIN_SRC} line.
15414 Properties set in this way override both the values of
15415 @code{org-babel-default-header-args} and header arguments specified as
15416 properties. In the following example, the @code{:results} header argument
15417 is set to @code{silent}, meaning the results of execution will not be
15418 inserted in the buffer, and the @code{:exports} header argument is set to
15419 @code{code}, meaning only the body of the code block will be
15420 preserved on export to HTML or @LaTeX{}.
15424 #+BEGIN_SRC haskell :results silent :exports code :var n=0
15426 fac n = n * fac (n-1)
15429 Similarly, it is possible to set header arguments for inline code blocks
15432 src_haskell[:exports both]@{fac 5@}
15435 Code block header arguments can span multiple lines using @code{#+HEADER:} or
15436 @code{#+HEADERS:} lines preceding a code block or nested between the
15437 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
15441 Multi-line header arguments on an un-named code block:
15444 #+HEADERS: :var data1=1
15445 #+BEGIN_SRC emacs-lisp :var data2=2
15446 (message "data1:%S, data2:%S" data1 data2)
15453 Multi-line header arguments on a named code block:
15456 #+NAME: named-block
15457 #+HEADER: :var data=2
15458 #+BEGIN_SRC emacs-lisp
15459 (message "data:%S" data)
15462 #+RESULTS: named-block
15466 @node Header arguments in function calls
15467 @subsubheading Header arguments in function calls
15469 At the most specific level, header arguments for ``Library of Babel'' or
15470 @code{#+CALL:} lines can be set as shown in the two examples below. For more
15471 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
15474 The following will apply the @code{:exports results} header argument to the
15475 evaluation of the @code{#+CALL:} line.
15478 #+CALL: factorial(n=5) :exports results
15481 The following will apply the @code{:session special} header argument to the
15482 evaluation of the @code{factorial} code block.
15485 #+CALL: factorial[:session special](n=5)
15488 @node Specific header arguments
15489 @subsection Specific header arguments
15490 Header arguments consist of an initial colon followed by the name of the
15491 argument in lowercase letters. The following header arguments are defined:
15494 * var:: Pass arguments to code blocks
15495 * results:: Specify the type of results and how they will
15496 be collected and handled
15497 * file:: Specify a path for file output
15498 * file-desc:: Specify a description for file results
15499 * file-ext:: Specify an extension for file output
15500 * output-dir:: Specify a directory to write file output to
15501 * dir:: Specify the default (possibly remote)
15502 directory for code block execution
15503 * exports:: Export code and/or results
15504 * tangle:: Toggle tangling and specify file name
15505 * mkdirp:: Toggle creation of parent directories of target
15506 files during tangling
15507 * comments:: Toggle insertion of comments in tangled
15509 * padline:: Control insertion of padding lines in tangled
15511 * no-expand:: Turn off variable assignment and noweb
15512 expansion during tangling
15513 * session:: Preserve the state of code evaluation
15514 * noweb:: Toggle expansion of noweb references
15515 * noweb-ref:: Specify block's noweb reference resolution target
15516 * noweb-sep:: String used to separate noweb references
15517 * cache:: Avoid re-evaluating unchanged code blocks
15518 * sep:: Delimiter for writing tabular results outside Org
15519 * hlines:: Handle horizontal lines in tables
15520 * colnames:: Handle column names in tables
15521 * rownames:: Handle row names in tables
15522 * shebang:: Make tangled files executable
15523 * tangle-mode:: Set permission of tangled files
15524 * eval:: Limit evaluation of specific code blocks
15525 * wrap:: Mark source block evaluation results
15526 * post:: Post processing of code block results
15527 * prologue:: Text to prepend to code block body
15528 * epilogue:: Text to append to code block body
15531 Additional header arguments are defined on a language-specific basis, see
15535 @subsubsection @code{:var}
15536 @cindex @code{:var}, src header argument
15537 The @code{:var} header argument is used to pass arguments to code blocks.
15538 The specifics of how arguments are included in a code block vary by language;
15539 these are addressed in the language-specific documentation. However, the
15540 syntax used to specify arguments is the same across all languages. In every
15541 case, variables require a default value when they are declared.
15543 The values passed to arguments can either be literal values, references, or
15544 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
15545 References include anything in the Org mode file that takes a @code{#+NAME:}
15546 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
15547 other code blocks and the results of other code blocks.
15549 Note: When a reference is made to another code block, the referenced block
15550 will be evaluated unless it has current cached results (see @ref{cache}).
15552 Argument values can be indexed in a manner similar to arrays (see @ref{var,
15553 Indexable variable values}).
15555 The following syntax is used to pass arguments to code blocks using the
15556 @code{:var} header argument.
15562 The argument, @code{assign}, can either be a literal value, such as a string
15563 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
15564 literal example, another code block (with or without arguments), or the
15565 results of evaluating another code block.
15567 Here are examples of passing values by reference:
15572 an Org mode table named with either a @code{#+NAME:} line
15575 #+NAME: example-table
15581 #+NAME: table-length
15582 #+BEGIN_SRC emacs-lisp :var table=example-table
15586 #+RESULTS: table-length
15591 a simple list named with a @code{#+NAME:} line (note that nesting is not
15592 carried through to the source code block)
15595 #+NAME: example-list
15601 #+BEGIN_SRC emacs-lisp :var x=example-list
15609 @item code block without arguments
15610 a code block name (from the example above), as assigned by @code{#+NAME:},
15611 optionally followed by parentheses
15614 #+BEGIN_SRC emacs-lisp :var length=table-length()
15622 @item code block with arguments
15623 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15624 optional arguments passed within the parentheses following the
15625 code block name using standard function call syntax
15629 #+BEGIN_SRC emacs-lisp :var input=8
15637 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15645 @item literal example
15646 a literal example block named with a @code{#+NAME:} line
15649 #+NAME: literal-example
15655 #+NAME: read-literal-example
15656 #+BEGIN_SRC emacs-lisp :var x=literal-example
15657 (concatenate 'string x " for you.")
15660 #+RESULTS: read-literal-example
15661 : A literal example
15662 : on two lines for you.
15668 @subsubheading Indexable variable values
15669 It is possible to reference portions of variable values by ``indexing'' into
15670 the variables. Indexes are 0 based with negative values counting back from
15671 the end. If an index is separated by @code{,}s then each subsequent section
15672 will index into the next deepest nesting or dimension of the value. Note
15673 that this indexing occurs @emph{before} other table related header arguments
15674 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
15675 following example assigns the last cell of the first row the table
15676 @code{example-table} to the variable @code{data}:
15679 #+NAME: example-table
15685 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15693 Ranges of variable values can be referenced using two integers separated by a
15694 @code{:}, in which case the entire inclusive range is referenced. For
15695 example the following assigns the middle three rows of @code{example-table}
15699 #+NAME: example-table
15706 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15716 Additionally, an empty index, or the single character @code{*}, are both
15717 interpreted to mean the entire range and as such are equivalent to
15718 @code{0:-1}, as shown in the following example in which the entire first
15719 column is referenced.
15722 #+NAME: example-table
15728 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15736 It is possible to index into the results of code blocks as well as tables.
15737 Any number of dimensions can be indexed. Dimensions are separated from one
15738 another by commas, as shown in the following example.
15742 #+BEGIN_SRC emacs-lisp
15743 '(((1 2 3) (4 5 6) (7 8 9))
15744 ((10 11 12) (13 14 15) (16 17 18))
15745 ((19 20 21) (22 23 24) (25 26 27)))
15748 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15756 @subsubheading Emacs Lisp evaluation of variables
15758 Emacs lisp code can be used to initialize variable values. When a variable
15759 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15760 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15761 the variable value. The following example demonstrates use of this
15762 evaluation to reliably pass the file-name of the Org mode buffer to a code
15763 block---note that evaluation of header arguments is guaranteed to take place
15764 in the original Org mode file, while there is no such guarantee for
15765 evaluation of the code block body.
15768 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15773 Note that values read from tables and lists will not be evaluated as
15774 Emacs Lisp, as shown in the following example.
15780 #+HEADERS: :var data=table[0,0]
15790 @subsubsection @code{:results}
15791 @cindex @code{:results}, src header argument
15793 There are four classes of @code{:results} header argument. Only one option
15794 per class may be supplied per code block.
15798 @b{collection} header arguments specify how the results should be collected
15799 from the code block
15801 @b{type} header arguments specify what type of result the code block will
15802 return---which has implications for how they will be processed before
15803 insertion into the Org mode buffer
15805 @b{format} header arguments specify what type of result the code block will
15806 return---which has implications for how they will be inserted into the
15809 @b{handling} header arguments specify how the results of evaluating the code
15810 block should be handled.
15813 @subsubheading Collection
15814 The following options are mutually exclusive, and specify how the results
15815 should be collected from the code block.
15819 This is the default. The result is the value of the last statement in the
15820 code block. This header argument places the evaluation in functional
15821 mode. Note that in some languages, e.g., Python, use of this result type
15822 requires that a @code{return} statement be included in the body of the source
15823 code block. E.g., @code{:results value}.
15824 @item @code{output}
15825 The result is the collection of everything printed to STDOUT during the
15826 execution of the code block. This header argument places the
15827 evaluation in scripting mode. E.g., @code{:results output}.
15830 @subsubheading Type
15832 The following options are mutually exclusive and specify what type of results
15833 the code block will return. By default, results are inserted as either a
15834 table or scalar depending on their value.
15837 @item @code{table}, @code{vector}
15838 The results should be interpreted as an Org mode table. If a single value is
15839 returned, it will be converted into a table with one row and one column.
15840 E.g., @code{:results value table}.
15842 The results should be interpreted as an Org mode list. If a single scalar
15843 value is returned it will be converted into a list with only one element.
15844 @item @code{scalar}, @code{verbatim}
15845 The results should be interpreted literally---they will not be
15846 converted into a table. The results will be inserted into the Org mode
15847 buffer as quoted text. E.g., @code{:results value verbatim}.
15849 The results will be interpreted as the path to a file, and will be inserted
15850 into the Org mode buffer as a file link. E.g., @code{:results value file}.
15853 @subsubheading Format
15855 The following options are mutually exclusive and specify what type of results
15856 the code block will return. By default, results are inserted according to the
15857 type as specified above.
15861 The results are interpreted as raw Org mode code and are inserted directly
15862 into the buffer. If the results look like a table they will be aligned as
15863 such by Org mode. E.g., @code{:results value raw}.
15865 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15866 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15867 in the block and/or if you export the file. E.g., @code{:results value org}.
15869 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_EXPORT
15870 html} block. E.g., @code{:results value html}.
15872 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_EXPORT
15873 latex} block. E.g., @code{:results value latex}.
15875 Result are assumed to be parsable code and are enclosed in a code block.
15876 E.g., @code{:results value code}.
15878 The result is converted to pretty-printed code and is enclosed in a code
15879 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
15880 @code{:results value pp}.
15881 @item @code{drawer}
15882 The result is wrapped in a RESULTS drawer. This can be useful for
15883 inserting @code{raw} or @code{org} syntax results in such a way that their
15884 extent is known and they can be automatically removed or replaced.
15887 @subsubheading Handling
15888 The following results options indicate what happens with the
15889 results once they are collected.
15892 @item @code{silent}
15893 The results will be echoed in the minibuffer but will not be inserted into
15894 the Org mode buffer. E.g., @code{:results output silent}.
15895 @item @code{replace}
15896 The default value. Any existing results will be removed, and the new results
15897 will be inserted into the Org mode buffer in their place. E.g.,
15898 @code{:results output replace}.
15899 @item @code{append}
15900 If there are pre-existing results of the code block then the new results will
15901 be appended to the existing results. Otherwise the new results will be
15902 inserted as with @code{replace}.
15903 @item @code{prepend}
15904 If there are pre-existing results of the code block then the new results will
15905 be prepended to the existing results. Otherwise the new results will be
15906 inserted as with @code{replace}.
15910 @subsubsection @code{:file}
15911 @cindex @code{:file}, src header argument
15913 The header argument @code{:file} is used to specify an external file in which
15914 to save code block results. After code block evaluation an Org mode style
15915 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15916 into the Org mode buffer. Some languages including R, gnuplot, dot, and
15917 ditaa provide special handling of the @code{:file} header argument
15918 automatically wrapping the code block body in the boilerplate code required
15919 to save output to the specified file. This is often useful for saving
15920 graphical output of a code block to the specified file.
15922 The argument to @code{:file} should be either a string specifying the path to
15923 a file, or a list of two strings in which case the first element of the list
15924 should be the path to a file and the second a description for the link.
15927 @subsubsection @code{:file-desc}
15929 The value of the @code{:file-desc} header argument is used to provide a
15930 description for file code block results which are inserted as Org mode links
15931 (see @ref{Link format}). If the @code{:file-desc} header argument is given
15932 with no value the link path will be placed in both the ``link'' and the
15933 ``description'' portion of the Org mode link.
15936 @subsubsection @code{:file-ext}
15937 @cindex @code{:file-ext}, src header argument
15939 The value of the @code{:file-ext} header argument is used to provide an
15940 extension to write the file output to. It is combined with the
15941 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15942 header argument to generate a complete file name.
15944 This header arg will be overridden by @code{:file}, and thus has no effect
15945 when the latter is specified.
15948 @subsubsection @code{:output-dir}
15949 @cindex @code{:output-dir}, src header argument
15951 The value of the @code{:output-dir} header argument is used to provide a
15952 directory to write the file output to. It may specify an absolute directory
15953 (beginning with @code{/}) or a relative directory (without @code{/}). It can
15954 be combined with the @code{#+NAME:} of the source block and the value of the
15955 @ref{file-ext} header argument to generate a complete file name, or used
15956 along with a @ref{file} header arg.
15959 @subsubsection @code{:dir} and remote execution
15960 @cindex @code{:dir}, src header argument
15962 While the @code{:file} header argument can be used to specify the path to the
15963 output file, @code{:dir} specifies the default directory during code block
15964 execution. If it is absent, then the directory associated with the current
15965 buffer is used. In other words, supplying @code{:dir path} temporarily has
15966 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15967 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
15968 the value of the Emacs variable @code{default-directory}.
15970 When using @code{:dir}, you should supply a relative path for file output
15971 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15972 case that path will be interpreted relative to the default directory.
15974 In other words, if you want your plot to go into a folder called @file{Work}
15975 in your home directory, you could use
15978 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15979 matplot(matrix(rnorm(100), 10), type="l")
15983 @subsubheading Remote execution
15984 A directory on a remote machine can be specified using tramp file syntax, in
15985 which case the code will be evaluated on the remote machine. An example is
15988 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15989 plot(1:10, main=system("hostname", intern=TRUE))
15993 Text results will be returned to the local Org mode buffer as usual, and file
15994 output will be created on the remote machine with relative paths interpreted
15995 relative to the remote directory. An Org mode link to the remote file will be
15998 So, in the above example a plot will be created on the remote machine,
15999 and a link of the following form will be inserted in the org buffer:
16002 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
16005 Most of this functionality follows immediately from the fact that @code{:dir}
16006 sets the value of the Emacs variable @code{default-directory}, thanks to
16009 @subsubheading Further points
16013 If @code{:dir} is used in conjunction with @code{:session}, although it will
16014 determine the starting directory for a new session as expected, no attempt is
16015 currently made to alter the directory associated with an existing session.
16017 @code{:dir} should typically not be used to create files during export with
16018 @code{:exports results} or @code{:exports both}. The reason is that, in order
16019 to retain portability of exported material between machines, during export
16020 links inserted into the buffer will @emph{not} be expanded against @code{default
16021 directory}. Therefore, if @code{default-directory} is altered using
16022 @code{:dir}, it is probable that the file will be created in a location to
16023 which the link does not point.
16027 @subsubsection @code{:exports}
16028 @cindex @code{:exports}, src header argument
16030 The @code{:exports} header argument specifies what should be included in HTML
16031 or @LaTeX{} exports of the Org mode file. Note that the @code{:exports}
16032 option is only relevant for code blocks, not inline code.
16036 The default. The body of code is included into the exported file. E.g.,
16037 @code{:exports code}.
16038 @item @code{results}
16039 The result of evaluating the code is included in the exported file. E.g.,
16040 @code{:exports results}.
16042 Both the code and results are included in the exported file. E.g.,
16043 @code{:exports both}.
16045 Nothing is included in the exported file. E.g., @code{:exports none}.
16049 @subsubsection @code{:tangle}
16050 @cindex @code{:tangle}, src header argument
16052 The @code{:tangle} header argument specifies whether or not the code
16053 block should be included in tangled extraction of source code files.
16056 @item @code{tangle}
16057 The code block is exported to a source code file named after the full path
16058 (including the directory) and file name (w/o extension) of the Org mode file.
16059 E.g., @code{:tangle yes}.
16061 The default. The code block is not exported to a source code file.
16062 E.g., @code{:tangle no}.
16064 Any other string passed to the @code{:tangle} header argument is interpreted
16065 as a path (directory and file name relative to the directory of the Org mode
16066 file) to which the block will be exported. E.g., @code{:tangle path}.
16070 @subsubsection @code{:mkdirp}
16071 @cindex @code{:mkdirp}, src header argument
16073 The @code{:mkdirp} header argument can be used to create parent directories
16074 of tangled files when missing. This can be set to @code{yes} to enable
16075 directory creation or to @code{no} to inhibit directory creation.
16078 @subsubsection @code{:comments}
16079 @cindex @code{:comments}, src header argument
16080 By default code blocks are tangled to source-code files without any insertion
16081 of comments beyond those which may already exist in the body of the code
16082 block. The @code{:comments} header argument can be set as follows to control
16083 the insertion of extra comments into the tangled code file.
16087 The default. No extra comments are inserted during tangling.
16089 The code block is wrapped in comments which contain pointers back to the
16090 original Org file from which the code was tangled.
16092 A synonym for ``link'' to maintain backwards compatibility.
16094 Include text from the Org mode file as a comment.
16095 The text is picked from the leading context of the tangled code and is
16096 limited by the nearest headline or source block as the case may be.
16098 Turns on both the ``link'' and ``org'' comment options.
16100 Turns on the ``link'' comment option, and additionally wraps expanded noweb
16101 references in the code block body in link comments.
16105 @subsubsection @code{:padline}
16106 @cindex @code{:padline}, src header argument
16107 Control in insertion of padding lines around code block bodies in tangled
16108 code files. The default value is @code{yes} which results in insertion of
16109 newlines before and after each tangled code block. The following arguments
16114 Insert newlines before and after each code block body in tangled code files.
16116 Do not insert any newline padding in tangled output.
16120 @subsubsection @code{:no-expand}
16121 @cindex @code{:no-expand}, src header argument
16123 By default, code blocks are expanded with @code{org-babel-expand-src-block}
16124 during tangling. This has the effect of assigning values to variables
16125 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
16126 references (see @ref{Noweb reference syntax}) with their targets. The
16127 @code{:no-expand} header argument can be used to turn off this behavior.
16128 Note: The @code{:no-expand} header argument has no impact on export,
16129 i.e. code blocks will irrespective of this header argument expanded for
16133 @subsubsection @code{:session}
16134 @cindex @code{:session}, src header argument
16136 The @code{:session} header argument starts a (possibly named) session for an
16137 interpreted language where the interpreter’s state is preserved. All code
16138 blocks sharing the same name are exectuted by the same interpreter process.
16139 By default, a session is not started.
16143 The default. Each block is evaluated in its own interpreter process, which
16144 is terminated after the evaluation.
16146 Any other string passed to the @code{:session} header argument will give the
16147 session a name. For example, @code{:session mysession}. If @code{:session}
16148 is given but no name string is specified, the session is named according to
16149 the language used in the block. All blocks with the same session name share
16150 the same session. Using different session names enables concurrent sessions
16151 (even for the same interpreted language, if the language supports multiple
16157 @subsubsection @code{:noweb}
16158 @cindex @code{:noweb}, src header argument
16160 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
16161 references (see @ref{Noweb reference syntax}) when the code block is
16162 evaluated, tangled, or exported. The @code{:noweb} header argument can have
16163 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
16164 @code{no-export} @code{strip-export}.
16168 The default. ``Noweb'' syntax references in the body of the code block will
16169 not be expanded before the code block is evaluated, tangled or exported.
16171 ``Noweb'' syntax references in the body of the code block will be
16172 expanded before the code block is evaluated, tangled or exported.
16173 @item @code{tangle}
16174 ``Noweb'' syntax references in the body of the code block will be expanded
16175 before the code block is tangled. However, ``noweb'' syntax references will
16176 not be expanded when the code block is evaluated or exported.
16177 @item @code{no-export}
16178 ``Noweb'' syntax references in the body of the code block will be expanded
16179 before the block is evaluated or tangled. However, ``noweb'' syntax
16180 references will not be expanded when the code block is exported.
16181 @item @code{strip-export}
16182 ``Noweb'' syntax references in the body of the code block will be expanded
16183 before the block is evaluated or tangled. However, ``noweb'' syntax
16184 references will be removed when the code block is exported.
16186 ``Noweb'' syntax references in the body of the code block will only be
16187 expanded before the block is evaluated.
16190 @subsubheading Noweb prefix lines
16191 Noweb insertions are now placed behind the line prefix of the
16192 @code{<<reference>>}.
16193 This behavior is illustrated in the following example. Because the
16194 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
16195 each line of the expanded noweb reference will be commented.
16207 -- multi-line body of example
16210 Note that noweb replacement text that does not contain any newlines will not
16211 be affected by this change, so it is still possible to use inline noweb
16215 @subsubsection @code{:noweb-ref}
16216 @cindex @code{:noweb-ref}, src header argument
16217 When expanding ``noweb'' style references, the bodies of all code block with
16218 @emph{either} a block name matching the reference name @emph{or} a
16219 @code{:noweb-ref} header argument matching the reference name will be
16220 concatenated together to form the replacement text.
16222 By setting this header argument at the subtree or file level, simple code
16223 block concatenation may be achieved. For example, when tangling the
16224 following Org mode file, the bodies of code blocks will be concatenated into
16225 the resulting pure code file@footnote{(The example needs property inheritance
16226 to be turned on for the @code{noweb-ref} property, see @ref{Property
16230 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
16233 * the mount point of the fullest disk
16235 :noweb-ref: fullest-disk
16238 ** query all mounted disks
16243 ** strip the header row
16248 ** sort by the percent full
16250 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
16253 ** extract the mount point
16255 |awk '@{print $2@}'
16259 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
16260 used to separate accumulate noweb references like those above. By default a
16264 @subsubsection @code{:noweb-sep}
16265 @cindex @code{:noweb-sep}, src header argument
16267 The @code{:noweb-sep} header argument holds the string used to separate
16268 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
16272 @subsubsection @code{:cache}
16273 @cindex @code{:cache}, src header argument
16275 The @code{:cache} header argument controls the use of in-buffer caching of
16276 the results of evaluating code blocks. It can be used to avoid re-evaluating
16277 unchanged code blocks. When the cache is active, a source block is not
16278 re-evaluated if a result for it is present in the buffer and neither the
16279 header arguments (including the value of @code{:var} references) nor the text
16280 of the block itself has changed since the result was computed. The feature
16281 helps avoid re-running long calculations. However, there are edge cases and
16282 you should not rely on the cache to behave reliably in all circumstances.
16284 The caching feature works best when a babel block is a pure function of its
16285 arguments (@pxref{var}). That is, the function always returns the same
16286 results when given the same arguments, and does not touch external resources
16287 (like the filesystem or the language’s RNG) in any way.@footnote{The
16288 documentation of the knitr reproducible research package for the R language
16289 has some good discussion of issues that may arise when using the cache in
16290 such a context. See @uref{http://yihui.name/knitr/demo/cache/}, especially
16291 the sections ``Even more stuff for cache?'' and ``Reproducibility with RNG''.
16292 (Obviously, you will have to abstract away from the knitr implementation
16293 details which the documentation also discusses.)}
16295 Note that the @code{:cache} header argument will attempt to cache results
16296 when the @code{:session} header argument is used, even though the results of
16297 the code block execution stored in the session may lead to unexpected
16300 Noweb references (@pxref{Noweb reference syntax}) are currently not expanded
16301 when calculating whether the text of the code block has changed. Perhaps in
16302 principle they ought to be, but this could introduce unexpected complexity.
16303 See @uref{http://thread.gmane.org/gmane.emacs.orgmode/79046}.
16305 The @code{:cache} header argument can have one of two values: @code{yes} or
16310 The default. No caching takes place, and the code block will be evaluated
16311 every time it is called.
16313 Every time the code block is run a SHA1 hash of the code and arguments
16314 passed to the block will be generated. This hash is packed into the
16315 @code{#+RESULTS:} line and will be checked on subsequent
16316 executions of the code block. If the code block has not
16317 changed since the last time it was evaluated, it will not be re-evaluated.
16320 Code block caches notice if the value of a variable argument
16321 to the code block has changed. If this is the case, the cache is
16322 invalidated and the code block is re-run. In the following example,
16323 @code{caller} will not be re-run unless the results of @code{random} have
16324 changed since it was last run.
16328 #+BEGIN_SRC R :cache yes
16332 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
16336 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
16340 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
16345 @subsubsection @code{:sep}
16346 @cindex @code{:sep}, src header argument
16348 The @code{:sep} header argument can be used to control the delimiter used
16349 when writing tabular results out to files external to Org mode. This is used
16350 either when opening tabular results of a code block by calling the
16351 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
16352 or when writing code block results to an external file (see @ref{file})
16355 By default, when @code{:sep} is not specified output tables are tab
16359 @subsubsection @code{:hlines}
16360 @cindex @code{:hlines}, src header argument
16362 Tables are frequently represented with one or more horizontal lines, or
16363 hlines. The @code{:hlines} argument to a code block accepts the
16364 values @code{yes} or @code{no}, with a default value of @code{no}.
16368 Strips horizontal lines from the input table. In most languages this is the
16369 desired effect because an @code{hline} symbol is interpreted as an unbound
16370 variable and raises an error. Setting @code{:hlines no} or relying on the
16371 default value yields the following results.
16382 #+BEGIN_SRC python :var tab=many-cols
16386 #+RESULTS: echo-table
16393 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
16404 #+BEGIN_SRC python :var tab=many-cols :hlines yes
16408 #+RESULTS: echo-table
16418 @subsubsection @code{:colnames}
16419 @cindex @code{:colnames}, src header argument
16421 The @code{:colnames} header argument accepts the values @code{yes},
16422 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
16423 Note that the behavior of the @code{:colnames} header argument may differ
16428 If an input table looks like it has column names
16429 (because its second row is an hline), then the column
16430 names will be removed from the table before
16431 processing, then reapplied to the results.
16440 #+NAME: echo-table-again
16441 #+BEGIN_SRC python :var tab=less-cols
16442 return [[val + '*' for val in row] for row in tab]
16445 #+RESULTS: echo-table-again
16452 Please note that column names are not removed before the table is indexed
16453 using variable indexing @xref{var, Indexable variable values}.
16456 No column name pre-processing takes place
16459 Column names are removed and reapplied as with @code{nil} even if the table
16460 does not ``look like'' it has column names (i.e., the second row is not an
16465 @subsubsection @code{:rownames}
16466 @cindex @code{:rownames}, src header argument
16468 The @code{:rownames} header argument can take on the values @code{yes} or
16469 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
16470 blocks ignore the @code{:rownames} header argument entirely given the ease
16471 with which tables with row names may be handled directly in Emacs Lisp.
16475 No row name pre-processing will take place.
16478 The first column of the table is removed from the table before processing,
16479 and is then reapplied to the results.
16482 #+NAME: with-rownames
16483 | one | 1 | 2 | 3 | 4 | 5 |
16484 | two | 6 | 7 | 8 | 9 | 10 |
16486 #+NAME: echo-table-once-again
16487 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
16488 return [[val + 10 for val in row] for row in tab]
16491 #+RESULTS: echo-table-once-again
16492 | one | 11 | 12 | 13 | 14 | 15 |
16493 | two | 16 | 17 | 18 | 19 | 20 |
16496 Please note that row names are not removed before the table is indexed using
16497 variable indexing @xref{var, Indexable variable values}.
16502 @subsubsection @code{:shebang}
16503 @cindex @code{:shebang}, src header argument
16505 Setting the @code{:shebang} header argument to a string value
16506 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
16507 first line of any tangled file holding the code block, and the file
16508 permissions of the tangled file are set to make it executable.
16512 @subsubsection @code{:tangle-mode}
16513 @cindex @code{:tangle-mode}, src header argument
16515 The @code{tangle-mode} header argument controls the permission set on tangled
16516 files. The value of this header argument will be passed to
16517 @code{set-file-modes}. For example, to set a tangled file as read only use
16518 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
16519 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
16520 (@ref{shebang}) header arguments will automatically be made executable unless
16521 the @code{tangle-mode} header argument is also used. The behavior is
16522 undefined if multiple code blocks with different values for the
16523 @code{tangle-mode} header argument are tangled to the same file.
16526 @subsubsection @code{:eval}
16527 @cindex @code{:eval}, src header argument
16528 The @code{:eval} header argument can be used to limit the evaluation of
16529 specific code blocks. The @code{:eval} header argument can be useful for
16530 protecting against the evaluation of dangerous code blocks or to ensure that
16531 evaluation will require a query regardless of the value of the
16532 @code{org-confirm-babel-evaluate} variable. The possible values of
16533 @code{:eval} and their effects are shown below.
16537 The code block will not be evaluated under any circumstances.
16539 Evaluation of the code block will require a query.
16540 @item never-export or no-export
16541 The code block will not be evaluated during export but may still be called
16544 Evaluation of the code block during export will require a query.
16547 If this header argument is not set then evaluation is determined by the value
16548 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
16552 @subsubsection @code{:wrap}
16553 @cindex @code{:wrap}, src header argument
16554 The @code{:wrap} header argument is used to mark the results of source block
16555 evaluation. The header argument can be passed a string that will be appended
16556 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
16557 results. If not string is specified then the results will be wrapped in a
16558 @code{#+BEGIN/END_RESULTS} block.
16561 @subsubsection @code{:post}
16562 @cindex @code{:post}, src header argument
16563 The @code{:post} header argument is used to post-process the results of a
16564 code block execution. When a post argument is given, the results of the code
16565 block will temporarily be bound to the @code{*this*} variable. This variable
16566 may then be included in header argument forms such as those used in @ref{var}
16567 header argument specifications allowing passing of results to other code
16568 blocks, or direct execution via Emacs Lisp. Additional header arguments may
16569 be passed to the @code{:post}-function.
16571 The following two examples illustrate the usage of the @code{:post} header
16572 argument. The first example shows how to attach a attribute-line via @code{:post}.
16576 #+begin_src sh :var data="" :var width="\\textwidth" :results output
16577 echo "#+ATTR_LATEX: :width $width"
16581 #+header: :file /tmp/it.png
16582 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
16592 #+ATTR_LATEX :width 5cm
16593 [[file:/tmp/it.png]]
16597 The second examples shows how to use @code{:post} together with the
16598 @code{:colnames} header argument.
16601 #+begin_src emacs-lisp :var tbl="" fmt="%.3f"
16602 (mapcar (lambda (row)
16603 (mapcar (lambda (cell)
16611 #+begin_src R :colnames yes :post round-tbl[:colnames yes](*this*)
16613 data.frame(foo=rnorm(1))
16623 @subsubsection @code{:prologue}
16624 @cindex @code{:prologue}, src header argument
16625 The value of the @code{prologue} header argument will be prepended to the
16626 code block body before execution. For example, @code{:prologue "reset"} may
16627 be used to reset a gnuplot session before execution of a particular code
16628 block, or the following configuration may be used to do this for all gnuplot
16629 code blocks. Also see @ref{epilogue}.
16632 (add-to-list 'org-babel-default-header-args:gnuplot
16633 '((:prologue . "reset")))
16637 @subsubsection @code{:epilogue}
16638 @cindex @code{:epilogue}, src header argument
16639 The value of the @code{epilogue} header argument will be appended to the code
16640 block body before execution. Also see @ref{prologue}.
16642 @node Results of evaluation
16643 @section Results of evaluation
16644 @cindex code block, results of evaluation
16645 @cindex source code, results of evaluation
16647 The way in which results are handled depends on whether a session is invoked,
16648 as well as on whether @code{:results value} or @code{:results output} is
16649 used. The following table shows the table possibilities. For a full listing
16650 of the possible results header arguments see @ref{results}.
16652 @multitable @columnfractions 0.26 0.33 0.41
16653 @item @tab @b{Non-session} @tab @b{Session}
16654 @item @code{:results value} @tab value of last expression @tab value of last expression
16655 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16658 Note: With @code{:results value}, the result in both @code{:session} and
16659 non-session is returned to Org mode as a table (a one- or two-dimensional
16660 vector of strings or numbers) when appropriate.
16662 @subsection Non-session
16663 @subsubsection @code{:results value}
16664 @cindex @code{:results}, src header argument
16665 This is the default. Internally, the value is obtained by wrapping the code
16666 in a function definition in the external language, and evaluating that
16667 function. Therefore, code should be written as if it were the body of such a
16668 function. In particular, note that Python does not automatically return a
16669 value from a function unless a @code{return} statement is present, and so a
16670 @samp{return} statement will usually be required in Python.
16672 This is the only one of the four evaluation contexts in which the code is
16673 automatically wrapped in a function definition.
16675 @subsubsection @code{:results output}
16676 @cindex @code{:results}, src header argument
16677 The code is passed to the interpreter as an external process, and the
16678 contents of the standard output stream are returned as text. (In certain
16679 languages this also contains the error output stream; this is an area for
16682 @subsection Session
16683 @subsubsection @code{:results value}
16684 @cindex @code{:results}, src header argument
16685 The code is passed to an interpreter running as an interactive Emacs inferior
16686 process. Only languages which provide tools for interactive evaluation of
16687 code have session support, so some language (e.g., C and ditaa) do not
16688 support the @code{:session} header argument, and in other languages (e.g.,
16689 Python and Haskell) which have limitations on the code which may be entered
16690 into interactive sessions, those limitations apply to the code in code blocks
16691 using the @code{:session} header argument as well.
16693 Unless the @code{:results output} option is supplied (see below) the result
16694 returned is the result of the last evaluation performed by the
16695 interpreter. (This is obtained in a language-specific manner: the value of
16696 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16699 @subsubsection @code{:results output}
16700 @cindex @code{:results}, src header argument
16701 The code is passed to the interpreter running as an interactive Emacs
16702 inferior process. The result returned is the concatenation of the sequence of
16703 (text) output from the interactive interpreter. Notice that this is not
16704 necessarily the same as what would be sent to @code{STDOUT} if the same code
16705 were passed to a non-interactive interpreter running as an external
16706 process. For example, compare the following two blocks:
16709 #+BEGIN_SRC python :results output
16720 In non-session mode, the ``2'' is not printed and does not appear.
16723 #+BEGIN_SRC python :results output :session
16735 But in @code{:session} mode, the interactive interpreter receives input ``2''
16736 and prints out its value, ``2''. (Indeed, the other print statements are
16739 @node Noweb reference syntax
16740 @section Noweb reference syntax
16741 @cindex code block, noweb reference
16742 @cindex syntax, noweb
16743 @cindex source code, noweb reference
16745 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16746 Programming system allows named blocks of code to be referenced by using the
16747 familiar Noweb syntax:
16750 <<code-block-name>>
16753 When a code block is tangled or evaluated, whether or not ``noweb''
16754 references are expanded depends upon the value of the @code{:noweb} header
16755 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
16756 evaluation. If @code{:noweb no}, the default, then the reference is not
16757 expanded before evaluation. See the @ref{noweb-ref} header argument for
16758 a more flexible way to resolve noweb references.
16760 It is possible to include the @emph{results} of a code block rather than the
16761 body. This is done by appending parenthesis to the code block name which may
16762 optionally contain arguments to the code block as shown below.
16765 <<code-block-name(optional arguments)>>
16768 Note: the default value, @code{:noweb no}, was chosen to ensure that
16769 correct code is not broken in a language, such as Ruby, where
16770 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
16771 syntactically valid in languages that you use, then please consider setting
16774 Note: if noweb tangling is slow in large Org mode files consider setting the
16775 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16776 This will result in faster noweb reference resolution at the expense of not
16777 correctly resolving inherited values of the @code{:noweb-ref} header
16780 @node Key bindings and useful functions
16781 @section Key bindings and useful functions
16782 @cindex code block, key bindings
16784 Many common Org mode key sequences are re-bound depending on
16787 Within a code block, the following key bindings
16790 @multitable @columnfractions 0.25 0.75
16792 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16794 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16796 @item @kbd{M-@key{up}} @tab @code{org-babel-load-in-session}
16798 @item @kbd{M-@key{down}} @tab @code{org-babel-switch-to-session}
16801 In an Org mode buffer, the following key bindings are active:
16803 @multitable @columnfractions 0.45 0.55
16805 @kindex C-c C-v C-p
16806 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16808 @kindex C-c C-v C-n
16809 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16811 @kindex C-c C-v C-e
16812 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16814 @kindex C-c C-v C-o
16815 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16817 @kindex C-c C-v C-v
16818 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16820 @kindex C-c C-v C-u
16821 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16823 @kindex C-c C-v C-g
16824 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16826 @kindex C-c C-v C-r
16827 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16829 @kindex C-c C-v C-b
16830 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16832 @kindex C-c C-v C-s
16833 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16835 @kindex C-c C-v C-d
16836 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16838 @kindex C-c C-v C-t
16839 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16841 @kindex C-c C-v C-f
16842 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16844 @kindex C-c C-v C-c
16845 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16847 @kindex C-c C-v C-j
16848 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16850 @kindex C-c C-v C-l
16851 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16853 @kindex C-c C-v C-i
16854 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16856 @kindex C-c C-v C-I
16857 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16859 @kindex C-c C-v C-z
16860 @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}
16862 @kindex C-c C-v C-a
16863 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16865 @kindex C-c C-v C-h
16866 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16868 @kindex C-c C-v C-x
16869 @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}
16872 @c When possible these key bindings were extended to work when the control key is
16873 @c kept pressed, resulting in the following additional key bindings.
16875 @c @multitable @columnfractions 0.25 0.75
16876 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16877 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16878 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16879 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16880 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16881 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16882 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16883 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16886 @node Batch execution
16887 @section Batch execution
16888 @cindex code block, batch execution
16889 @cindex source code, batch execution
16891 It is possible to call functions from the command line. This shell
16892 script calls @code{org-babel-tangle} on every one of its arguments.
16894 Be sure to adjust the paths to fit your system.
16898 # -*- mode: shell-script -*-
16900 # tangle files with org-mode
16905 # wrap each argument in the code required to call tangle on it
16907 FILES="$FILES \"$i\""
16912 (require 'org)(require 'ob)(require 'ob-tangle)
16913 (mapc (lambda (file)
16914 (find-file (expand-file-name file \"$DIR\"))
16916 (kill-buffer)) '($FILES)))" 2>&1 |grep -i tangled
16919 @node Miscellaneous
16920 @chapter Miscellaneous
16923 * Completion:: M-TAB knows what you need
16924 * Easy templates:: Quick insertion of structural elements
16925 * Speed keys:: Electric commands at the beginning of a headline
16926 * Code evaluation security:: Org mode files evaluate inline code
16927 * Customization:: Adapting Org to your taste
16928 * In-buffer settings:: Overview of the #+KEYWORDS
16929 * The very busy C-c C-c key:: When in doubt, press C-c C-c
16930 * Clean view:: Getting rid of leading stars in the outline
16931 * TTY keys:: Using Org on a tty
16932 * Interaction:: Other Emacs packages
16933 * org-crypt:: Encrypting Org files
16938 @section Completion
16939 @cindex completion, of @TeX{} symbols
16940 @cindex completion, of TODO keywords
16941 @cindex completion, of dictionary words
16942 @cindex completion, of option keywords
16943 @cindex completion, of tags
16944 @cindex completion, of property keys
16945 @cindex completion, of link abbreviations
16946 @cindex @TeX{} symbol completion
16947 @cindex TODO keywords completion
16948 @cindex dictionary word completion
16949 @cindex option keyword completion
16950 @cindex tag completion
16951 @cindex link abbreviations, completion of
16953 Org supports in-buffer completion. This type of completion does
16954 not make use of the minibuffer. You simply type a few letters into
16955 the buffer and use the key to complete text right there.
16958 @kindex M-@key{TAB}
16960 Complete word at point
16963 At the beginning of a headline, complete TODO keywords.
16965 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16967 After @samp{*}, complete headlines in the current buffer so that they
16968 can be used in search links like @samp{[[*find this headline]]}.
16970 After @samp{:} in a headline, complete tags. The list of tags is taken
16971 from the variable @code{org-tag-alist} (possibly set through the
16972 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16973 dynamically from all tags used in the current buffer.
16975 After @samp{:} and not in a headline, complete property keys. The list
16976 of keys is constructed dynamically from all keys used in the current
16979 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16981 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16982 @samp{OPTIONS} which set file-specific options for Org mode. When the
16983 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16984 will insert example settings for this keyword.
16986 In the line after @samp{#+STARTUP: }, complete startup keywords,
16987 i.e., valid keys for this line.
16989 Elsewhere, complete dictionary words using Ispell.
16993 @node Easy templates
16994 @section Easy templates
16995 @cindex template insertion
16996 @cindex insertion, of templates
16998 Org mode supports insertion of empty structural elements (like
16999 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
17000 strokes. This is achieved through a native template expansion mechanism.
17001 Note that Emacs has several other template mechanisms which could be used in
17002 a similar way, for example @file{yasnippet}.
17004 To insert a structural element, type a @samp{<}, followed by a template
17005 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
17006 keystrokes are typed on a line by itself.
17008 The following template selectors are currently supported.
17010 @multitable @columnfractions 0.1 0.9
17011 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
17012 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
17013 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
17014 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
17015 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
17016 @item @kbd{l} @tab @code{#+BEGIN_EXPORT latex ... #+END_EXPORT}
17017 @item @kbd{L} @tab @code{#+LATEX:}
17018 @item @kbd{h} @tab @code{#+BEGIN_EXPORT html ... #+END_EXPORT}
17019 @item @kbd{H} @tab @code{#+HTML:}
17020 @item @kbd{a} @tab @code{#+BEGIN_EXPORT ascii ... #+END_EXPORT}
17021 @item @kbd{A} @tab @code{#+ASCII:}
17022 @item @kbd{i} @tab @code{#+INDEX:} line
17023 @item @kbd{I} @tab @code{#+INCLUDE:} line
17026 For example, on an empty line, typing "<e" and then pressing TAB, will expand
17027 into a complete EXAMPLE template.
17029 You can install additional templates by customizing the variable
17030 @code{org-structure-template-alist}. See the docstring of the variable for
17031 additional details.
17034 @section Speed keys
17036 @vindex org-use-speed-commands
17037 @vindex org-speed-commands-user
17039 Single keys can be made to execute commands when the cursor is at the
17040 beginning of a headline, i.e., before the first star. Configure the variable
17041 @code{org-use-speed-commands} to activate this feature. There is a
17042 pre-defined list of commands, and you can add more such commands using the
17043 variable @code{org-speed-commands-user}. Speed keys not only speed up
17044 navigation and other commands, but they also provide an alternative way to
17045 execute commands bound to keys that are not or not easily available on a TTY,
17046 or on a small mobile device with a limited keyboard.
17048 To see which commands are available, activate the feature and press @kbd{?}
17049 with the cursor at the beginning of a headline.
17051 @node Code evaluation security
17052 @section Code evaluation and security issues
17054 Org provides tools to work with code snippets, including evaluating them.
17056 Running code on your machine always comes with a security risk. Badly
17057 written or malicious code can be executed on purpose or by accident. Org has
17058 default settings which will only evaluate such code if you give explicit
17059 permission to do so, and as a casual user of these features you should leave
17060 these precautions intact.
17062 For people who regularly work with such code, the confirmation prompts can
17063 become annoying, and you might want to turn them off. This can be done, but
17064 you must be aware of the risks that are involved.
17066 Code evaluation can happen under the following circumstances:
17069 @item Source code blocks
17070 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
17071 C-c} in the block. The most important thing to realize here is that Org mode
17072 files which contain code snippets are, in a certain sense, like executable
17073 files. So you should accept them and load them into Emacs only from trusted
17074 sources---just like you would do with a program you install on your computer.
17076 Make sure you know what you are doing before customizing the variables
17077 which take off the default security brakes.
17079 @defopt org-confirm-babel-evaluate
17080 When t (the default), the user is asked before every code block evaluation.
17081 When @code{nil}, the user is not asked. When set to a function, it is called with
17082 two arguments (language and body of the code block) and should return t to
17083 ask and @code{nil} not to ask.
17086 For example, here is how to execute "ditaa" code (which is considered safe)
17090 (defun my-org-confirm-babel-evaluate (lang body)
17091 (not (string= lang "ditaa"))) ; don't ask for ditaa
17092 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
17095 @item Following @code{shell} and @code{elisp} links
17096 Org has two link types that can directly evaluate code (@pxref{External
17097 links}). These links can be problematic because the code to be evaluated is
17100 @defopt org-confirm-shell-link-function
17101 Function to queries user about shell link execution.
17103 @defopt org-confirm-elisp-link-function
17104 Functions to query user for Emacs Lisp link execution.
17107 @item Formulas in tables
17108 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
17109 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
17112 @node Customization
17113 @section Customization
17114 @cindex customization
17115 @cindex options, for customization
17116 @cindex variables, for customization
17118 There are more than 500 variables that can be used to customize
17119 Org. For the sake of compactness of the manual, I am not
17120 describing the variables here. A structured overview of customization
17121 variables is available with @kbd{M-x org-customize RET}. Or select
17122 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
17123 settings can also be activated on a per-file basis, by putting special
17124 lines into the buffer (@pxref{In-buffer settings}).
17126 @node In-buffer settings
17127 @section Summary of in-buffer settings
17128 @cindex in-buffer settings
17129 @cindex special keywords
17131 Org mode uses special lines in the buffer to define settings on a
17132 per-file basis. These lines start with a @samp{#+} followed by a
17133 keyword, a colon, and then individual words defining a setting. Several
17134 setting words can be in the same line, but you can also have multiple
17135 lines for the keyword. While these settings are described throughout
17136 the manual, here is a summary. After changing any of these lines in the
17137 buffer, press @kbd{C-c C-c} with the cursor still in the line to
17138 activate the changes immediately. Otherwise they become effective only
17139 when the file is visited again in a new Emacs session.
17141 @vindex org-archive-location
17143 @item #+ARCHIVE: %s_done::
17144 This line sets the archive location for the agenda file. It applies for
17145 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
17146 of the file. The first such line also applies to any entries before it.
17147 The corresponding variable is @code{org-archive-location}.
17149 This line sets the category for the agenda file. The category applies to the
17151 @item #+COLUMNS: %25ITEM ...
17152 @cindex property, COLUMNS
17153 Set the default format for columns view. This format applies when
17154 columns view is invoked in locations where no @code{COLUMNS} property
17156 @item #+CONSTANTS: name1=value1 ...
17157 @vindex org-table-formula-constants
17158 @vindex org-table-formula
17159 Set file-local values for constants to be used in table formulas. This
17160 line sets the local variable @code{org-table-formula-constants-local}.
17161 The global version of this variable is
17162 @code{org-table-formula-constants}.
17163 @item #+FILETAGS: :tag1:tag2:tag3:
17164 Set tags that can be inherited by any entry in the file, including the
17166 @item #+LINK: linkword replace
17167 @vindex org-link-abbrev-alist
17168 These lines (several are allowed) specify link abbreviations.
17169 @xref{Link abbreviations}. The corresponding variable is
17170 @code{org-link-abbrev-alist}.
17171 @item #+PRIORITIES: highest lowest default
17172 @vindex org-highest-priority
17173 @vindex org-lowest-priority
17174 @vindex org-default-priority
17175 This line sets the limits and the default for the priorities. All three
17176 must be either letters A--Z or numbers 0--9. The highest priority must
17177 have a lower ASCII number than the lowest priority.
17178 @item #+PROPERTY: Property_Name Value
17179 This line sets a default inheritance value for entries in the current
17180 buffer, most useful for specifying the allowed values of a property.
17181 @cindex #+SETUPFILE
17182 @item #+SETUPFILE: file
17183 This line defines a file that holds more in-buffer setup. Normally this is
17184 entirely ignored. Only when the buffer is parsed for option-setting lines
17185 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
17186 settings line, or when exporting), then the contents of this file are parsed
17187 as if they had been included in the buffer. In particular, the file can be
17188 any other Org mode file with internal setup. You can visit the file the
17189 cursor is in the line with @kbd{C-c '}.
17192 This line sets options to be used at startup of Org mode, when an
17193 Org file is being visited.
17195 The first set of options deals with the initial visibility of the outline
17196 tree. The corresponding variable for global default settings is
17197 @code{org-startup-folded}, with a default value @code{t}, which means
17199 @vindex org-startup-folded
17200 @cindex @code{overview}, STARTUP keyword
17201 @cindex @code{content}, STARTUP keyword
17202 @cindex @code{showall}, STARTUP keyword
17203 @cindex @code{showeverything}, STARTUP keyword
17205 overview @r{top-level headlines only}
17206 content @r{all headlines}
17207 showall @r{no folding of any entries}
17208 showeverything @r{show even drawer contents}
17211 @vindex org-startup-indented
17212 @cindex @code{indent}, STARTUP keyword
17213 @cindex @code{noindent}, STARTUP keyword
17214 Dynamic virtual indentation is controlled by the variable
17215 @code{org-startup-indented}
17217 indent @r{start with @code{org-indent-mode} turned on}
17218 noindent @r{start with @code{org-indent-mode} turned off}
17221 @vindex org-startup-align-all-tables
17222 Then there are options for aligning tables upon visiting a file. This
17223 is useful in files containing narrowed table columns. The corresponding
17224 variable is @code{org-startup-align-all-tables}, with a default value
17226 @cindex @code{align}, STARTUP keyword
17227 @cindex @code{noalign}, STARTUP keyword
17229 align @r{align all tables}
17230 noalign @r{don't align tables on startup}
17233 @vindex org-startup-with-inline-images
17234 When visiting a file, inline images can be automatically displayed. The
17235 corresponding variable is @code{org-startup-with-inline-images}, with a
17236 default value @code{nil} to avoid delays when visiting a file.
17237 @cindex @code{inlineimages}, STARTUP keyword
17238 @cindex @code{noinlineimages}, STARTUP keyword
17240 inlineimages @r{show inline images}
17241 noinlineimages @r{don't show inline images on startup}
17244 @vindex org-startup-with-latex-preview
17245 When visiting a file, @LaTeX{} fragments can be converted to images
17246 automatically. The variable @code{org-startup-with-latex-preview} which
17247 controls this behavior, is set to @code{nil} by default to avoid delays on
17249 @cindex @code{latexpreview}, STARTUP keyword
17250 @cindex @code{nolatexpreview}, STARTUP keyword
17252 latexpreview @r{preview @LaTeX{} fragments}
17253 nolatexpreview @r{don't preview @LaTeX{} fragments}
17256 @vindex org-log-done
17257 @vindex org-log-note-clock-out
17258 @vindex org-log-repeat
17259 Logging the closing and reopening of TODO items and clock intervals can be
17260 configured using these options (see variables @code{org-log-done},
17261 @code{org-log-note-clock-out} and @code{org-log-repeat})
17262 @cindex @code{logdone}, STARTUP keyword
17263 @cindex @code{lognotedone}, STARTUP keyword
17264 @cindex @code{nologdone}, STARTUP keyword
17265 @cindex @code{lognoteclock-out}, STARTUP keyword
17266 @cindex @code{nolognoteclock-out}, STARTUP keyword
17267 @cindex @code{logrepeat}, STARTUP keyword
17268 @cindex @code{lognoterepeat}, STARTUP keyword
17269 @cindex @code{nologrepeat}, STARTUP keyword
17270 @cindex @code{logreschedule}, STARTUP keyword
17271 @cindex @code{lognotereschedule}, STARTUP keyword
17272 @cindex @code{nologreschedule}, STARTUP keyword
17273 @cindex @code{logredeadline}, STARTUP keyword
17274 @cindex @code{lognoteredeadline}, STARTUP keyword
17275 @cindex @code{nologredeadline}, STARTUP keyword
17276 @cindex @code{logrefile}, STARTUP keyword
17277 @cindex @code{lognoterefile}, STARTUP keyword
17278 @cindex @code{nologrefile}, STARTUP keyword
17279 @cindex @code{logdrawer}, STARTUP keyword
17280 @cindex @code{nologdrawer}, STARTUP keyword
17281 @cindex @code{logstatesreversed}, STARTUP keyword
17282 @cindex @code{nologstatesreversed}, STARTUP keyword
17284 logdone @r{record a timestamp when an item is marked DONE}
17285 lognotedone @r{record timestamp and a note when DONE}
17286 nologdone @r{don't record when items are marked DONE}
17287 logrepeat @r{record a time when reinstating a repeating item}
17288 lognoterepeat @r{record a note when reinstating a repeating item}
17289 nologrepeat @r{do not record when reinstating repeating item}
17290 lognoteclock-out @r{record a note when clocking out}
17291 nolognoteclock-out @r{don't record a note when clocking out}
17292 logreschedule @r{record a timestamp when scheduling time changes}
17293 lognotereschedule @r{record a note when scheduling time changes}
17294 nologreschedule @r{do not record when a scheduling date changes}
17295 logredeadline @r{record a timestamp when deadline changes}
17296 lognoteredeadline @r{record a note when deadline changes}
17297 nologredeadline @r{do not record when a deadline date changes}
17298 logrefile @r{record a timestamp when refiling}
17299 lognoterefile @r{record a note when refiling}
17300 nologrefile @r{do not record when refiling}
17301 logdrawer @r{store log into drawer}
17302 nologdrawer @r{store log outside of drawer}
17303 logstatesreversed @r{reverse the order of states notes}
17304 nologstatesreversed @r{do not reverse the order of states notes}
17307 @vindex org-hide-leading-stars
17308 @vindex org-odd-levels-only
17309 Here are the options for hiding leading stars in outline headings, and for
17310 indenting outlines. The corresponding variables are
17311 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
17312 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
17313 @cindex @code{hidestars}, STARTUP keyword
17314 @cindex @code{showstars}, STARTUP keyword
17315 @cindex @code{odd}, STARTUP keyword
17316 @cindex @code{even}, STARTUP keyword
17318 hidestars @r{make all but one of the stars starting a headline invisible.}
17319 showstars @r{show all stars starting a headline}
17320 indent @r{virtual indentation according to outline level}
17321 noindent @r{no virtual indentation according to outline level}
17322 odd @r{allow only odd outline levels (1,3,...)}
17323 oddeven @r{allow all outline levels}
17326 @vindex org-put-time-stamp-overlays
17327 @vindex org-time-stamp-overlay-formats
17328 To turn on custom format overlays over timestamps (variables
17329 @code{org-put-time-stamp-overlays} and
17330 @code{org-time-stamp-overlay-formats}), use
17331 @cindex @code{customtime}, STARTUP keyword
17333 customtime @r{overlay custom time format}
17336 @vindex constants-unit-system
17337 The following options influence the table spreadsheet (variable
17338 @code{constants-unit-system}).
17339 @cindex @code{constcgs}, STARTUP keyword
17340 @cindex @code{constSI}, STARTUP keyword
17342 constcgs @r{@file{constants.el} should use the c-g-s unit system}
17343 constSI @r{@file{constants.el} should use the SI unit system}
17346 @vindex org-footnote-define-inline
17347 @vindex org-footnote-auto-label
17348 @vindex org-footnote-auto-adjust
17349 To influence footnote settings, use the following keywords. The
17350 corresponding variables are @code{org-footnote-define-inline},
17351 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
17352 @cindex @code{fninline}, STARTUP keyword
17353 @cindex @code{nofninline}, STARTUP keyword
17354 @cindex @code{fnlocal}, STARTUP keyword
17355 @cindex @code{fnprompt}, STARTUP keyword
17356 @cindex @code{fnauto}, STARTUP keyword
17357 @cindex @code{fnconfirm}, STARTUP keyword
17358 @cindex @code{fnplain}, STARTUP keyword
17359 @cindex @code{fnadjust}, STARTUP keyword
17360 @cindex @code{nofnadjust}, STARTUP keyword
17362 fninline @r{define footnotes inline}
17363 fnnoinline @r{define footnotes in separate section}
17364 fnlocal @r{define footnotes near first reference, but not inline}
17365 fnprompt @r{prompt for footnote labels}
17366 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
17367 fnconfirm @r{offer automatic label for editing or confirmation}
17368 fnplain @r{create @code{[1]}-like labels automatically}
17369 fnadjust @r{automatically renumber and sort footnotes}
17370 nofnadjust @r{do not renumber and sort automatically}
17373 @cindex org-hide-block-startup
17374 To hide blocks on startup, use these keywords. The corresponding variable is
17375 @code{org-hide-block-startup}.
17376 @cindex @code{hideblocks}, STARTUP keyword
17377 @cindex @code{nohideblocks}, STARTUP keyword
17379 hideblocks @r{Hide all begin/end blocks on startup}
17380 nohideblocks @r{Do not hide blocks on startup}
17383 @cindex org-pretty-entities
17384 The display of entities as UTF-8 characters is governed by the variable
17385 @code{org-pretty-entities} and the keywords
17386 @cindex @code{entitiespretty}, STARTUP keyword
17387 @cindex @code{entitiesplain}, STARTUP keyword
17389 entitiespretty @r{Show entities as UTF-8 characters where possible}
17390 entitiesplain @r{Leave entities plain}
17393 @item #+TAGS: TAG1(c1) TAG2(c2)
17394 @vindex org-tag-alist
17395 These lines (several such lines are allowed) specify the valid tags in
17396 this file, and (potentially) the corresponding @emph{fast tag selection}
17397 keys. The corresponding variable is @code{org-tag-alist}.
17400 This line contains the formulas for the table directly above the line.
17402 Table can have multiple lines containing @samp{#+TBLFM:}. Note
17403 that only the first line of @samp{#+TBLFM:} will be applied when
17404 you recalculate the table. For more details see @ref{Using
17405 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
17407 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
17408 @itemx #+OPTIONS:, #+BIND:,
17409 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
17410 These lines provide settings for exporting files. For more details see
17411 @ref{Export settings}.
17412 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
17413 @vindex org-todo-keywords
17414 These lines set the TODO keywords and their interpretation in the
17415 current file. The corresponding variable is @code{org-todo-keywords}.
17418 @node The very busy C-c C-c key
17419 @section The very busy C-c C-c key
17421 @cindex C-c C-c, overview
17423 The key @kbd{C-c C-c} has many purposes in Org, which are all
17424 mentioned scattered throughout this manual. One specific function of
17425 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
17426 other circumstances it means something like @emph{``Hey Org, look
17427 here and update according to what you see here''}. Here is a summary of
17428 what this means in different contexts.
17432 If there are highlights in the buffer from the creation of a sparse
17433 tree, or from clock display, remove these highlights.
17435 If the cursor is in one of the special @code{#+KEYWORD} lines, this
17436 triggers scanning the buffer for these lines and updating the
17439 If the cursor is inside a table, realign the table. This command
17440 works even if the automatic table editor has been turned off.
17442 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
17445 If the current buffer is a capture buffer, close the note and file it.
17446 With a prefix argument, file it, without further interaction, to the
17449 If the cursor is on a @code{<<<target>>>}, update radio targets and
17450 corresponding links in this buffer.
17452 If the cursor is in a property line or at the start or end of a property
17453 drawer, offer property commands.
17455 If the cursor is at a footnote reference, go to the corresponding
17456 definition, and @emph{vice versa}.
17458 If the cursor is on a statistics cookie, update it.
17460 If the cursor is in a plain list item with a checkbox, toggle the status
17463 If the cursor is on a numbered item in a plain list, renumber the
17466 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
17469 If the cursor is at a timestamp, fix the day name in the timestamp.
17473 @section A cleaner outline view
17474 @cindex hiding leading stars
17475 @cindex dynamic indentation
17476 @cindex odd-levels-only outlines
17477 @cindex clean outline view
17479 Some people find it noisy and distracting that the Org headlines start with a
17480 potentially large number of stars, and that text below the headlines is not
17481 indented. While this is no problem when writing a @emph{book-like} document
17482 where the outline headings are really section headings, in a more
17483 @emph{list-oriented} outline, indented structure is a lot cleaner:
17487 * Top level headline | * Top level headline
17488 ** Second level | * Second level
17489 *** 3rd level | * 3rd level
17490 some text | some text
17491 *** 3rd level | * 3rd level
17492 more text | more text
17493 * Another top level headline | * Another top level headline
17499 This kind of view can be achieved dynamically at display time using
17500 @code{org-indent-mode}. In this minor mode, all lines are prefixed for
17501 display with the necessary amount of space@footnote{@code{org-indent-mode}
17502 also sets the @code{wrap-prefix} property, such that @code{visual-line-mode}
17503 (or purely setting @code{word-wrap}) wraps long lines (including headlines)
17504 correctly indented.}. Also headlines are prefixed with additional stars, so
17505 that the amount of indentation shifts by two@footnote{See the variable
17506 @code{org-indent-indentation-per-level}.} spaces per level. All headline
17507 stars but the last one are made invisible using the @code{org-hide}
17508 face@footnote{Turning on @code{org-indent-mode} sets
17509 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
17510 @code{nil}.}; see below under @samp{2.} for more information on how this
17511 works. You can turn on @code{org-indent-mode} for all files by customizing
17512 the variable @code{org-startup-indented}, or you can turn it on for
17513 individual files using
17519 If you want a similar effect in an earlier version of Emacs and/or Org, or if
17520 you want the indentation to be hard space characters so that the plain text
17521 file looks as similar as possible to the Emacs display, Org supports you in
17526 @emph{Indentation of text below headlines}@*
17527 You may indent text below each headline to make the left boundary line up
17528 with the headline, like
17532 more text, now indented
17535 @vindex org-adapt-indentation
17536 Org supports this with paragraph filling, line wrapping, and structure
17537 editing@footnote{See also the variable @code{org-adapt-indentation}.},
17538 preserving or adapting the indentation as appropriate.
17541 @vindex org-hide-leading-stars
17542 @emph{Hiding leading stars}@* You can modify the display in such a way that
17543 all leading stars become invisible. To do this in a global way, configure
17544 the variable @code{org-hide-leading-stars} or change this on a per-file basis
17548 #+STARTUP: hidestars
17549 #+STARTUP: showstars
17552 With hidden stars, the tree becomes:
17556 * Top level headline
17564 @vindex org-hide @r{(face)}
17565 The leading stars are not truly replaced by whitespace, they are only
17566 fontified with the face @code{org-hide} that uses the background color as
17567 font color. If you are not using either white or black background, you may
17568 have to customize this face to get the wanted effect. Another possibility is
17569 to set this font such that the extra stars are @i{almost} invisible, for
17570 example using the color @code{grey90} on a white background.
17573 @vindex org-odd-levels-only
17574 Things become cleaner still if you skip all the even levels and use only odd
17575 levels 1, 3, 5..., effectively adding two stars to go from one outline level
17576 to the next@footnote{When you need to specify a level for a property search
17577 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
17578 way we get the outline view shown at the beginning of this section. In order
17579 to make the structure editing and export commands handle this convention
17580 correctly, configure the variable @code{org-odd-levels-only}, or set this on
17581 a per-file basis with one of the following lines:
17588 You can convert an Org file from single-star-per-level to the
17589 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
17590 RET} in that file. The reverse operation is @kbd{M-x
17591 org-convert-to-oddeven-levels}.
17595 @section Using Org on a tty
17596 @cindex tty key bindings
17598 Because Org contains a large number of commands, by default many of
17599 Org's core commands are bound to keys that are generally not
17600 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
17601 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
17602 together with modifiers like @key{Meta} and/or @key{Shift}. To access
17603 these commands on a tty when special keys are unavailable, the following
17604 alternative bindings can be used. The tty bindings below will likely be
17605 more cumbersome; you may find for some of the bindings below that a
17606 customized workaround suits you better. For example, changing a timestamp
17607 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
17608 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
17610 @multitable @columnfractions 0.15 0.2 0.1 0.2
17611 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
17612 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
17613 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
17614 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
17615 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
17616 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
17617 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
17618 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
17619 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
17620 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
17621 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
17622 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
17623 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
17624 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
17625 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
17626 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
17627 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
17628 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
17629 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17634 @section Interaction with other packages
17635 @cindex packages, interaction with other
17636 Org lives in the world of GNU Emacs and interacts in various ways
17637 with other code out there.
17640 * Cooperation:: Packages Org cooperates with
17641 * Conflicts:: Packages that lead to conflicts
17645 @subsection Packages that Org cooperates with
17648 @cindex @file{calc.el}
17649 @cindex Gillespie, Dave
17650 @item @file{calc.el} by Dave Gillespie
17651 Org uses the Calc package for implementing spreadsheet functionality in its
17652 tables (@pxref{The spreadsheet}). Another possibility for interaction
17653 between the two packages is using Calc for embedded calculations.
17654 @xref{Embedded Mode, , Embedded Mode, calc, GNU Emacs Calc Manual}.
17655 @item @file{constants.el} by Carsten Dominik
17656 @cindex @file{constants.el}
17657 @cindex Dominik, Carsten
17658 @vindex org-table-formula-constants
17659 In a table formula (@pxref{The spreadsheet}), it is possible to use
17660 names for natural constants or units. Instead of defining your own
17661 constants in the variable @code{org-table-formula-constants}, install
17662 the @file{constants} package which defines a large number of constants
17663 and units, and lets you use unit prefixes like @samp{M} for
17664 @samp{Mega}, etc. You will need version 2.0 of this package, available
17665 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
17666 the function @code{constants-get}, which has to be autoloaded in your
17667 setup. See the installation instructions in the file
17668 @file{constants.el}.
17669 @item @file{cdlatex.el} by Carsten Dominik
17670 @cindex @file{cdlatex.el}
17671 @cindex Dominik, Carsten
17672 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17673 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
17674 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17675 @cindex @file{imenu.el}
17676 Imenu allows menu access to an index of items in a file. Org mode
17677 supports Imenu---all you need to do to get the index is the following:
17679 (add-hook 'org-mode-hook
17680 (lambda () (imenu-add-to-menubar "Imenu")))
17682 @vindex org-imenu-depth
17683 By default the index is two levels deep---you can modify the depth using
17684 the option @code{org-imenu-depth}.
17685 @item @file{speedbar.el} by Eric M. Ludlam
17686 @cindex @file{speedbar.el}
17687 @cindex Ludlam, Eric M.
17688 Speedbar is a package that creates a special frame displaying files and
17689 index items in files. Org mode supports Speedbar and allows you to
17690 drill into Org files directly from the Speedbar. It also allows you to
17691 restrict the scope of agenda commands to a file or a subtree by using
17692 the command @kbd{<} in the Speedbar frame.
17693 @cindex @file{table.el}
17694 @item @file{table.el} by Takaaki Ota
17696 @cindex table editor, @file{table.el}
17697 @cindex @file{table.el}
17698 @cindex Ota, Takaaki
17700 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17701 and alignment can be created using the Emacs table package by Takaaki Ota.
17702 Org mode will recognize these tables and export them properly. Because of
17703 interference with other Org mode functionality, you unfortunately cannot edit
17704 these tables directly in the buffer. Instead, you need to use the command
17705 @kbd{C-c '} to edit them, similar to source code snippets.
17708 @orgcmd{C-c ',org-edit-special}
17709 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
17711 @orgcmd{C-c ~,org-table-create-with-table.el}
17712 Insert a @file{table.el} table. If there is already a table at point, this
17713 command converts it between the @file{table.el} format and the Org mode
17714 format. See the documentation string of the command
17715 @code{org-convert-table} for the restrictions under which this is
17721 @subsection Packages that lead to conflicts with Org mode
17725 @cindex @code{shift-selection-mode}
17726 @vindex org-support-shift-select
17727 In Emacs, @code{shift-selection-mode} is on by default, meaning that cursor
17728 motions combined with the shift key should start or enlarge regions. This
17729 conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17730 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17731 at such a location. By default, @kbd{S-@key{cursor}} commands outside
17732 special contexts don't do anything, but you can customize the variable
17733 @code{org-support-shift-select}. Org mode then tries to accommodate shift
17734 selection by (i) using it outside of the special contexts where special
17735 commands apply, and by (ii) extending an existing active region even if the
17736 cursor moves across a special context.
17738 @item @file{CUA.el} by Kim. F. Storm
17739 @cindex @file{CUA.el}
17740 @cindex Storm, Kim. F.
17741 @vindex org-replace-disputed-keys
17742 For the same reason, key bindings in Org also conflict with the
17743 @kbd{S-<cursor>} keys used by CUA mode. If you prefer to leave these keys to
17744 a different package while working in Org mode, configure the variable
17745 @code{org-replace-disputed-keys}. When set, Org will move the following key
17746 bindings in Org files, and in the agenda buffer (but not during date
17750 S-UP @result{} M-p S-DOWN @result{} M-n
17751 S-LEFT @result{} M-- S-RIGHT @result{} M-+
17752 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
17755 @vindex org-disputed-keys
17756 Yes, these are unfortunately more difficult to remember. If you want
17757 to have other replacement keys, look at the variable
17758 @code{org-disputed-keys}.
17760 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17761 @cindex @file{ecomplete.el}
17763 Ecomplete provides ``electric'' address completion in address header
17764 lines in message buffers. Sadly Orgtbl mode cuts ecompletes power
17765 supply: No completion happens when Orgtbl mode is enabled in message
17766 buffers while entering text in address header lines. If one wants to
17767 use ecomplete one should @emph{not} follow the advice to automagically
17768 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17769 instead---after filling in the message headers---turn on Orgtbl mode
17770 manually when needed in the messages body.
17772 @item @file{filladapt.el} by Kyle Jones
17773 @cindex @file{filladapt.el}
17775 Org mode tries to do the right thing when filling paragraphs, list items and
17776 other elements. Many users reported they had problems using both
17777 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17781 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17784 @item @file{yasnippet.el}
17785 @cindex @file{yasnippet.el}
17786 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17787 @code{"\t"}) overrules YASnippet's access to this key. The following code
17788 fixed this problem:
17791 (add-hook 'org-mode-hook
17793 (org-set-local 'yas/trigger-key [tab])
17794 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17797 The latest version of yasnippet doesn't play well with Org mode. If the
17798 above code does not fix the conflict, start by defining the following
17802 (defun yas/org-very-safe-expand ()
17803 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17806 Then, tell Org mode what to do with the new function:
17809 (add-hook 'org-mode-hook
17811 (make-variable-buffer-local 'yas/trigger-key)
17812 (setq yas/trigger-key [tab])
17813 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17814 (define-key yas/keymap [tab] 'yas/next-field)))
17817 @item @file{windmove.el} by Hovav Shacham
17818 @cindex @file{windmove.el}
17819 This package also uses the @kbd{S-<cursor>} keys, so everything written
17820 in the paragraph above about CUA mode also applies here. If you want make
17821 the windmove function active in locations where Org mode does not have
17822 special functionality on @kbd{S-@key{cursor}}, add this to your
17826 ;; Make windmove work in org-mode:
17827 (add-hook 'org-shiftup-final-hook 'windmove-up)
17828 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17829 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17830 (add-hook 'org-shiftright-final-hook 'windmove-right)
17833 @item @file{viper.el} by Michael Kifer
17834 @cindex @file{viper.el}
17836 Viper uses @kbd{C-c /} and therefore makes this key not access the
17837 corresponding Org mode command @code{org-sparse-tree}. You need to find
17838 another key for this command, or override the key in
17839 @code{viper-vi-global-user-map} with
17842 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17850 @section org-crypt.el
17851 @cindex @file{org-crypt.el}
17852 @cindex @code{org-decrypt-entry}
17854 Org-crypt will encrypt the text of an entry, but not the headline, or
17855 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17858 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17859 be encrypted when the file is saved. If you want to use a different tag just
17860 customize the @code{org-crypt-tag-matcher} setting.
17862 To use org-crypt it is suggested that you have the following in your
17866 (require 'org-crypt)
17867 (org-crypt-use-before-save-magic)
17868 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17870 (setq org-crypt-key nil)
17871 ;; GPG key to use for encryption
17872 ;; Either the Key ID or set to nil to use symmetric encryption.
17874 (setq auto-save-default nil)
17875 ;; Auto-saving does not cooperate with org-crypt.el: so you need
17876 ;; to turn it off if you plan to use org-crypt.el quite often.
17877 ;; Otherwise, you'll get an (annoying) message each time you
17880 ;; To turn it off only locally, you can insert this:
17882 ;; # -*- buffer-auto-save-file-name: nil; -*-
17885 Excluding the crypt tag from inheritance prevents already encrypted text
17886 being encrypted again.
17892 This appendix covers some areas where users can extend the functionality of
17896 * Hooks:: How to reach into Org's internals
17897 * Add-on packages:: Available extensions
17898 * Adding hyperlink types:: New custom link types
17899 * Adding export back-ends:: How to write new export back-ends
17900 * Context-sensitive commands:: How to add functionality to such commands
17901 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
17902 * Dynamic blocks:: Automatically filled blocks
17903 * Special agenda views:: Customized views
17904 * Speeding up your agendas:: Tips on how to speed up your agendas
17905 * Extracting agenda information:: Post-processing of agenda information
17906 * Using the property API:: Writing programs that use entry properties
17907 * Using the mapping API:: Mapping over all or selected entries
17914 Org has a large number of hook variables that can be used to add
17915 functionality. This appendix about hacking is going to illustrate the
17916 use of some of them. A complete list of all hooks with documentation is
17917 maintained by the Worg project and can be found at
17918 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17920 @node Add-on packages
17921 @section Add-on packages
17922 @cindex add-on packages
17924 A large number of add-on packages have been written by various authors.
17926 These packages are not part of Emacs, but they are distributed as contributed
17927 packages with the separate release available at @uref{http://orgmode.org}.
17928 See the @file{contrib/README} file in the source code directory for a list of
17929 contributed files. You may also find some more information on the Worg page:
17930 @uref{http://orgmode.org/worg/org-contrib/}.
17932 @node Adding hyperlink types
17933 @section Adding hyperlink types
17934 @cindex hyperlinks, adding new types
17936 Org has a large number of hyperlink types built-in
17937 (@pxref{Hyperlinks}). If you would like to add new link types, Org
17938 provides an interface for doing so. Let's look at an example file,
17939 @file{org-man.el}, that will add support for creating links like
17940 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17944 ;;; org-man.el - Support for links to manpages in Org
17948 (org-add-link-type "man" 'org-man-open)
17949 (add-hook 'org-store-link-functions 'org-man-store-link)
17951 (defcustom org-man-command 'man
17952 "The Emacs command to be used to display a man page."
17954 :type '(choice (const man) (const woman)))
17956 (defun org-man-open (path)
17957 "Visit the manpage on PATH.
17958 PATH should be a topic that can be thrown at the man command."
17959 (funcall org-man-command path))
17961 (defun org-man-store-link ()
17962 "Store a link to a manpage."
17963 (when (memq major-mode '(Man-mode woman-mode))
17964 ;; This is a man page, we do make this link
17965 (let* ((page (org-man-get-page-name))
17966 (link (concat "man:" page))
17967 (description (format "Manpage for %s" page)))
17968 (org-store-link-props
17971 :description description))))
17973 (defun org-man-get-page-name ()
17974 "Extract the page name from the buffer name."
17975 ;; This works for both `Man-mode' and `woman-mode'.
17976 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17977 (match-string 1 (buffer-name))
17978 (error "Cannot create link to this man page")))
17982 ;;; org-man.el ends here
17986 You would activate this new link type in @file{.emacs} with
17993 Let's go through the file and see what it does.
17996 It does @code{(require 'org)} to make sure that @file{org.el} has been
17999 The next line calls @code{org-add-link-type} to define a new link type
18000 with prefix @samp{man}. The call also contains the name of a function
18001 that will be called to follow such a link.
18003 @vindex org-store-link-functions
18004 The next line adds a function to @code{org-store-link-functions}, in
18005 order to allow the command @kbd{C-c l} to record a useful link in a
18006 buffer displaying a man page.
18009 The rest of the file defines the necessary variables and functions.
18010 First there is a customization variable that determines which Emacs
18011 command should be used to display man pages. There are two options,
18012 @code{man} and @code{woman}. Then the function to follow a link is
18013 defined. It gets the link path as an argument---in this case the link
18014 path is just a topic for the manual command. The function calls the
18015 value of @code{org-man-command} to display the man page.
18017 Finally the function @code{org-man-store-link} is defined. When you try
18018 to store a link with @kbd{C-c l}, this function will be called to
18019 try to make a link. The function must first decide if it is supposed to
18020 create the link for this buffer type; we do this by checking the value
18021 of the variable @code{major-mode}. If not, the function must exit and
18022 return the value @code{nil}. If yes, the link is created by getting the
18023 manual topic from the buffer name and prefixing it with the string
18024 @samp{man:}. Then it must call the command @code{org-store-link-props}
18025 and set the @code{:type} and @code{:link} properties. Optionally you
18026 can also set the @code{:description} property to provide a default for
18027 the link description when the link is later inserted into an Org
18028 buffer with @kbd{C-c C-l}.
18030 When it makes sense for your new link type, you may also define a function
18031 that implements special (e.g., completion) support for inserting such a link
18032 with @kbd{C-c C-l}. Such a function should not accept any arguments, and
18033 return the full link with prefix.
18035 @node Adding export back-ends
18036 @section Adding export back-ends
18037 @cindex Export, writing back-ends
18039 Org 8.0 comes with a completely rewritten export engine which makes it easy
18040 to write new export back-ends, either from scratch, or by deriving them
18041 from existing ones.
18043 Your two entry points are respectively @code{org-export-define-backend} and
18044 @code{org-export-define-derived-backend}. To grok these functions, you
18045 should first have a look at @file{ox-latex.el} (for how to define a new
18046 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
18047 back-end from an existing one.
18049 When creating a new back-end from scratch, the basic idea is to set the name
18050 of the back-end (as a symbol) and an alist of elements and export functions.
18051 On top of this, you will need to set additional keywords like
18052 @code{:menu-entry} (to display the back-end in the export dispatcher), and
18053 @code{:options-alist} (to let the user set export options that are specific
18056 Deriving a new back-end is similar, except that you need to set
18057 @code{:translate-alist} to an alist of export functions that should be used
18058 instead of the parent back-end functions.
18060 For a complete reference documentation, see
18061 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
18062 Reference on Worg}.
18064 @node Context-sensitive commands
18065 @section Context-sensitive commands
18066 @cindex context-sensitive commands, hooks
18067 @cindex add-ons, context-sensitive commands
18068 @vindex org-ctrl-c-ctrl-c-hook
18070 Org has several commands that act differently depending on context. The most
18071 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
18072 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
18074 Add-ons can tap into this functionality by providing a function that detects
18075 special context for that add-on and executes functionality appropriate for
18076 the context. Here is an example from Dan Davison's @file{org-R.el} which
18077 allows you to evaluate commands based on the @file{R} programming language
18078 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
18079 described in @ref{Working with source code} and is now obsolete.}. For this
18080 package, special contexts are lines that start with @code{#+R:} or
18084 (defun org-R-apply-maybe ()
18085 "Detect if this is context for org-R and execute R commands."
18086 (if (save-excursion
18087 (beginning-of-line 1)
18088 (looking-at "#\\+RR?:"))
18089 (progn (call-interactively 'org-R-apply)
18090 t) ;; to signal that we took action
18091 nil)) ;; to signal that we did not
18093 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
18096 The function first checks if the cursor is in such a line. If that is the
18097 case, @code{org-R-apply} is called and the function returns @code{t} to
18098 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
18099 contexts. If the function finds it should do nothing locally, it returns
18100 @code{nil} so that other, similar functions can have a try.
18103 @node Tables in arbitrary syntax
18104 @section Tables and lists in arbitrary syntax
18105 @cindex tables, in other modes
18106 @cindex lists, in other modes
18107 @cindex Orgtbl mode
18109 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
18110 frequent feature request has been to make it work with native tables in
18111 specific languages, for example @LaTeX{}. However, this is extremely
18112 hard to do in a general way, would lead to a customization nightmare,
18113 and would take away much of the simplicity of the Orgtbl mode table
18116 This appendix describes a different approach. We keep the Orgtbl mode
18117 table in its native format (the @i{source table}), and use a custom
18118 function to @i{translate} the table to the correct syntax, and to
18119 @i{install} it in the right location (the @i{target table}). This puts
18120 the burden of writing conversion functions on the user, but it allows
18121 for a very flexible system.
18123 Bastien added the ability to do the same with lists, in Orgstruct mode. You
18124 can use Org's facilities to edit and structure lists by turning
18125 @code{orgstruct-mode} on, then locally exporting such lists in another format
18126 (HTML, @LaTeX{} or Texinfo.)
18130 * Radio tables:: Sending and receiving radio tables
18131 * A @LaTeX{} example:: Step by step, almost a tutorial
18132 * Translator functions:: Copy and modify
18133 * Radio lists:: Sending and receiving lists
18137 @subsection Radio tables
18138 @cindex radio tables
18140 To define the location of the target table, you first need to create two
18141 lines that are comments in the current mode, but contain magic words
18142 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will
18143 insert the translated table between these lines, replacing whatever was there
18144 before. For example in C mode where comments are between @code{/* ... */}:
18147 /* BEGIN RECEIVE ORGTBL table_name */
18148 /* END RECEIVE ORGTBL table_name */
18152 Just above the source table, we put a special line that tells
18153 Orgtbl mode how to translate this table and where to install it. For
18157 #+ORGTBL: SEND table_name translation_function arguments...
18161 @code{table_name} is the reference name for the table that is also used
18162 in the receiver lines. @code{translation_function} is the Lisp function
18163 that does the translation. Furthermore, the line can contain a list of
18164 arguments (alternating key and value) at the end. The arguments will be
18165 passed as a property list to the translation function for
18166 interpretation. A few standard parameters are already recognized and
18167 acted upon before the translation function is called:
18171 Skip the first N lines of the table. Hlines do count as separate lines for
18174 @item :skipcols (n1 n2 ...)
18175 List of columns that should be skipped. If the table has a column with
18176 calculation marks, that column is automatically discarded as well.
18177 Please note that the translator function sees the table @emph{after} the
18178 removal of these columns, the function never knows that there have been
18179 additional columns.
18183 The one problem remaining is how to keep the source table in the buffer
18184 without disturbing the normal workings of the file, for example during
18185 compilation of a C file or processing of a @LaTeX{} file. There are a
18186 number of different solutions:
18190 The table could be placed in a block comment if that is supported by the
18191 language. For example, in C mode you could wrap the table between
18192 @samp{/*} and @samp{*/} lines.
18194 Sometimes it is possible to put the table after some kind of @i{END}
18195 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
18198 You can just comment the table line-by-line whenever you want to process
18199 the file, and uncomment it whenever you need to edit the table. This
18200 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
18201 makes this comment-toggling very easy, in particular if you bind it to a
18205 @node A @LaTeX{} example
18206 @subsection A @LaTeX{} example of radio tables
18207 @cindex @LaTeX{}, and Orgtbl mode
18209 The best way to wrap the source table in @LaTeX{} is to use the
18210 @code{comment} environment provided by @file{comment.sty}. It has to be
18211 activated by placing @code{\usepackage@{comment@}} into the document
18212 header. Orgtbl mode can insert a radio table skeleton@footnote{By
18213 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
18214 variable @code{orgtbl-radio-table-templates} to install templates for other
18215 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
18216 be prompted for a table name, let's say we use @samp{salesfigures}. You
18217 will then get the following template:
18219 @cindex #+ORGTBL, SEND
18221 % BEGIN RECEIVE ORGTBL salesfigures
18222 % END RECEIVE ORGTBL salesfigures
18224 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18230 @vindex @LaTeX{}-verbatim-environments
18231 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
18232 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
18233 into the receiver location with name @code{salesfigures}. You may now
18234 fill in the table---feel free to use the spreadsheet features@footnote{If
18235 the @samp{#+TBLFM} line contains an odd number of dollar characters,
18236 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
18237 example you can fix this by adding an extra line inside the
18238 @code{comment} environment that is used to balance the dollar
18239 expressions. If you are using AUC@TeX{} with the font-latex library, a
18240 much better solution is to add the @code{comment} environment to the
18241 variable @code{LaTeX-verbatim-environments}.}:
18244 % BEGIN RECEIVE ORGTBL salesfigures
18245 % END RECEIVE ORGTBL salesfigures
18247 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18248 | Month | Days | Nr sold | per day |
18249 |-------+------+---------+---------|
18250 | Jan | 23 | 55 | 2.4 |
18251 | Feb | 21 | 16 | 0.8 |
18252 | March | 22 | 278 | 12.6 |
18253 #+TBLFM: $4=$3/$2;%.1f
18254 % $ (optional extra dollar to keep font-lock happy, see footnote)
18259 When you are done, press @kbd{C-c C-c} in the table to get the converted
18260 table inserted between the two marker lines.
18262 Now let's assume you want to make the table header by hand, because you
18263 want to control how columns are aligned, etc. In this case we make sure
18264 that the table translator skips the first 2 lines of the source
18265 table, and tell the command to work as a @i{splice}, i.e., to not produce
18266 header and footer commands of the target table:
18269 \begin@{tabular@}@{lrrr@}
18270 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
18271 % BEGIN RECEIVE ORGTBL salesfigures
18272 % END RECEIVE ORGTBL salesfigures
18276 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
18277 | Month | Days | Nr sold | per day |
18278 |-------+------+---------+---------|
18279 | Jan | 23 | 55 | 2.4 |
18280 | Feb | 21 | 16 | 0.8 |
18281 | March | 22 | 278 | 12.6 |
18282 #+TBLFM: $4=$3/$2;%.1f
18286 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
18287 Orgtbl mode. By default, it uses a @code{tabular} environment to typeset the
18288 table and marks horizontal lines with @code{\hline}. You can control the
18289 output through several parameters (see also @pxref{Translator functions}),
18290 including the following ones :
18293 @item :splice nil/t
18294 When non-@code{nil}, return only table body lines, don't wrap them into a tabular
18295 environment. Default is @code{nil}.
18298 A format to be used to wrap each field, it should contain @code{%s} for the
18299 original field value. For example, to wrap each field value in dollars,
18300 you could use @code{:fmt "$%s$"}. This may also be a property list with
18301 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
18302 A function of one argument can be used in place of the strings; the
18303 function must return a formatted string.
18306 Use this format to print numbers with exponentials. The format should have
18307 @code{%s} twice for inserting mantissa and exponent, for example
18308 @code{"%s\\times10^@{%s@}"}. This may also be a property list with column
18309 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
18310 4 "$%s\\cdot10^@{%s@}$")}. After @code{efmt} has been applied to a value,
18311 @code{fmt} will also be applied. Similar to @code{fmt}, functions of two
18312 arguments can be supplied instead of strings. By default, no special
18313 formatting is applied.
18316 @node Translator functions
18317 @subsection Translator functions
18318 @cindex HTML, and Orgtbl mode
18319 @cindex translator function
18321 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
18322 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
18323 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
18324 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}. These all use
18325 a generic translator, @code{orgtbl-to-generic}, which, in turn, can delegate
18326 translations to various export back-ends (@pxref{Export back-ends}).
18328 In particular, properties passed into the function (i.e., the ones set by the
18329 @samp{ORGTBL SEND} line) take precedence over translations defined in the
18330 function. So if you would like to use the @LaTeX{} translator, but wanted
18331 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
18332 could just overrule the default with
18335 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
18338 For a new language, you can use the generic function to write your own
18339 converter function. For example, if you have a language where a table is
18340 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
18341 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
18342 separator is a TAB, you could define your generic translator like this:
18345 (defun orgtbl-to-language (table params)
18346 "Convert the orgtbl-mode TABLE to language."
18349 (org-combine-plists
18350 '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
18355 Please check the documentation string of the function
18356 @code{orgtbl-to-generic} for a full list of parameters understood by
18357 that function, and remember that you can pass each of them into
18358 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
18359 using the generic function.
18361 Of course you can also write a completely new function doing complicated
18362 things the generic translator cannot do. A translator function takes
18363 two arguments. The first argument is the table, a list of lines, each
18364 line either the symbol @code{hline} or a list of fields. The second
18365 argument is the property list containing all parameters specified in the
18366 @samp{#+ORGTBL: SEND} line. The function must return a single string
18367 containing the formatted table. If you write a generally useful
18368 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
18369 others can benefit from your work.
18372 @subsection Radio lists
18373 @cindex radio lists
18374 @cindex org-list-insert-radio-list
18376 Sending and receiving radio lists works exactly the same way as sending and
18377 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
18378 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
18379 @code{org-list-insert-radio-list}.
18381 Here are the differences with radio tables:
18386 Orgstruct mode must be active.
18388 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
18390 @kbd{C-c C-c} will work when pressed on the first item of the list.
18393 Built-in translators functions are : @code{org-list-to-latex},
18394 @code{org-list-to-html} and @code{org-list-to-texinfo}. They all use the
18395 generic translator @code{org-list-to-generic}. Please check its
18396 documentation for a list of supported parameters, which can be used to
18397 control more accurately how the list should be rendered.
18399 Here is a @LaTeX{} example. Let's say that you have this in your
18403 % BEGIN RECEIVE ORGLST to-buy
18404 % END RECEIVE ORGLST to-buy
18406 #+ORGLST: SEND to-buy org-list-to-latex
18415 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
18416 @LaTeX{} list between the two marker lines.
18418 @node Dynamic blocks
18419 @section Dynamic blocks
18420 @cindex dynamic blocks
18422 Org documents can contain @emph{dynamic blocks}. These are
18423 specially marked regions that are updated by some user-written function.
18424 A good example for such a block is the clock table inserted by the
18425 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
18427 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
18428 to the block and can also specify parameters for the function producing
18429 the content of the block.
18431 @cindex #+BEGIN:dynamic block
18433 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
18438 Dynamic blocks are updated with the following commands
18441 @orgcmd{C-c C-x C-u,org-dblock-update}
18442 Update dynamic block at point.
18443 @orgkey{C-u C-c C-x C-u}
18444 Update all dynamic blocks in the current file.
18447 Updating a dynamic block means to remove all the text between BEGIN and
18448 END, parse the BEGIN line for parameters and then call the specific
18449 writer function for this block to insert the new content. If you want
18450 to use the original content in the writer function, you can use the
18451 extra parameter @code{:content}.
18453 For a block with name @code{myblock}, the writer function is
18454 @code{org-dblock-write:myblock} with as only parameter a property list
18455 with the parameters given in the begin line. Here is a trivial example
18456 of a block that keeps track of when the block update function was last
18460 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
18466 The corresponding block writer function could look like this:
18469 (defun org-dblock-write:block-update-time (params)
18470 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
18471 (insert "Last block update at: "
18472 (format-time-string fmt))))
18475 If you want to make sure that all dynamic blocks are always up-to-date,
18476 you could add the function @code{org-update-all-dblocks} to a hook, for
18477 example @code{before-save-hook}. @code{org-update-all-dblocks} is
18478 written in a way such that it does nothing in buffers that are not in
18481 You can narrow the current buffer to the current dynamic block (like any
18482 other block) with @code{org-narrow-to-block}.
18484 @node Special agenda views
18485 @section Special agenda views
18486 @cindex agenda views, user-defined
18488 @vindex org-agenda-skip-function
18489 @vindex org-agenda-skip-function-global
18490 Org provides a special hook that can be used to narrow down the selection
18491 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
18492 @code{agenda*} view is the same as @code{agenda} except that it only
18493 considers @emph{appointments}, i.e., scheduled and deadline items that have a
18494 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
18495 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
18496 specify a function that is used at each match to verify if the match should
18497 indeed be part of the agenda view, and if not, how much should be skipped.
18498 You can specify a global condition that will be applied to all agenda views,
18499 this condition would be stored in the variable
18500 @code{org-agenda-skip-function-global}. More commonly, such a definition is
18501 applied only to specific custom searches, using
18502 @code{org-agenda-skip-function}.
18504 Let's say you want to produce a list of projects that contain a WAITING
18505 tag anywhere in the project tree. Let's further assume that you have
18506 marked all tree headings that define a project with the TODO keyword
18507 PROJECT@. In this case you would run a TODO search for the keyword
18508 PROJECT, but skip the match unless there is a WAITING tag anywhere in
18509 the subtree belonging to the project line.
18511 To achieve this, you must write a function that searches the subtree for
18512 the tag. If the tag is found, the function must return @code{nil} to
18513 indicate that this match should not be skipped. If there is no such
18514 tag, return the location of the end of the subtree, to indicate that
18515 search should continue from there.
18518 (defun my-skip-unless-waiting ()
18519 "Skip trees that are not waiting"
18520 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
18521 (if (re-search-forward ":waiting:" subtree-end t)
18522 nil ; tag found, do not skip
18523 subtree-end))) ; tag not found, continue after end of subtree
18526 Now you may use this function in an agenda custom command, for example
18530 (org-add-agenda-custom-command
18531 '("b" todo "PROJECT"
18532 ((org-agenda-skip-function 'my-skip-unless-waiting)
18533 (org-agenda-overriding-header "Projects waiting for something: "))))
18536 @vindex org-agenda-overriding-header
18537 Note that this also binds @code{org-agenda-overriding-header} to get a
18538 meaningful header in the agenda view.
18540 @vindex org-odd-levels-only
18541 @vindex org-agenda-skip-function
18542 A general way to create custom searches is to base them on a search for
18543 entries with a certain level limit. If you want to study all entries with
18544 your custom search function, simply do a search for
18545 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
18546 level number corresponds to order in the hierarchy, not to the number of
18547 stars.}, and then use @code{org-agenda-skip-function} to select the entries
18548 you really want to have.
18550 You may also put a Lisp form into @code{org-agenda-skip-function}. In
18551 particular, you may use the functions @code{org-agenda-skip-entry-if}
18552 and @code{org-agenda-skip-subtree-if} in this form, for example:
18555 @item (org-agenda-skip-entry-if 'scheduled)
18556 Skip current entry if it has been scheduled.
18557 @item (org-agenda-skip-entry-if 'notscheduled)
18558 Skip current entry if it has not been scheduled.
18559 @item (org-agenda-skip-entry-if 'deadline)
18560 Skip current entry if it has a deadline.
18561 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
18562 Skip current entry if it has a deadline, or if it is scheduled.
18563 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
18564 Skip current entry if the TODO keyword is TODO or WAITING.
18565 @item (org-agenda-skip-entry-if 'todo 'done)
18566 Skip current entry if the TODO keyword marks a DONE state.
18567 @item (org-agenda-skip-entry-if 'timestamp)
18568 Skip current entry if it has any timestamp, may also be deadline or scheduled.
18569 @anchor{x-agenda-skip-entry-regexp}
18570 @item (org-agenda-skip-entry-if 'regexp "regular expression")
18571 Skip current entry if the regular expression matches in the entry.
18572 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
18573 Skip current entry unless the regular expression matches.
18574 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
18575 Same as above, but check and skip the entire subtree.
18578 Therefore we could also have written the search for WAITING projects
18579 like this, even without defining a special function:
18582 (org-add-agenda-custom-command
18583 '("b" todo "PROJECT"
18584 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
18585 'regexp ":waiting:"))
18586 (org-agenda-overriding-header "Projects waiting for something: "))))
18589 @node Speeding up your agendas
18590 @section Speeding up your agendas
18591 @cindex agenda views, optimization
18593 When your Org files grow in both number and size, agenda commands may start
18594 to become slow. Below are some tips on how to speed up the agenda commands.
18598 Reduce the number of Org agenda files: this will reduce the slowdown caused
18599 by accessing a hard drive.
18601 Reduce the number of DONE and archived headlines: this way the agenda does
18602 not need to skip them.
18604 @vindex org-agenda-dim-blocked-tasks
18605 Inhibit the dimming of blocked tasks:
18607 (setq org-agenda-dim-blocked-tasks nil)
18610 @vindex org-startup-folded
18611 @vindex org-agenda-inhibit-startup
18612 Inhibit agenda files startup options:
18614 (setq org-agenda-inhibit-startup nil)
18617 @vindex org-agenda-show-inherited-tags
18618 @vindex org-agenda-use-tag-inheritance
18619 Disable tag inheritance in agenda:
18621 (setq org-agenda-use-tag-inheritance nil)
18625 You can set these options for specific agenda views only. See the docstrings
18626 of these variables for details on why they affect the agenda generation, and
18627 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18628 page} for further explanations.
18630 @node Extracting agenda information
18631 @section Extracting agenda information
18632 @cindex agenda, pipe
18633 @cindex Scripts, for agenda processing
18635 @vindex org-agenda-custom-commands
18636 Org provides commands to access agenda information for the command
18637 line in Emacs batch mode. This extracted information can be sent
18638 directly to a printer, or it can be read by a program that does further
18639 processing of the data. The first of these commands is the function
18640 @code{org-batch-agenda}, that produces an agenda view and sends it as
18641 ASCII text to STDOUT@. The command takes a single string as parameter.
18642 If the string has length 1, it is used as a key to one of the commands
18643 you have configured in @code{org-agenda-custom-commands}, basically any
18644 key you can use after @kbd{C-c a}. For example, to directly print the
18645 current TODO list, you could use
18648 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18651 If the parameter is a string with 2 or more characters, it is used as a
18652 tags/TODO match string. For example, to print your local shopping list
18653 (all items with the tag @samp{shop}, but excluding the tag
18654 @samp{NewYork}), you could use
18657 emacs -batch -l ~/.emacs \
18658 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18662 You may also modify parameters on the fly like this:
18665 emacs -batch -l ~/.emacs \
18666 -eval '(org-batch-agenda "a" \
18667 org-agenda-span (quote month) \
18668 org-agenda-include-diary nil \
18669 org-agenda-files (quote ("~/org/project.org")))' \
18674 which will produce a 30-day agenda, fully restricted to the Org file
18675 @file{~/org/projects.org}, not even including the diary.
18677 If you want to process the agenda data in more sophisticated ways, you
18678 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18679 list of values for each agenda item. Each line in the output will
18680 contain a number of fields separated by commas. The fields in a line
18684 category @r{The category of the item}
18685 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
18686 type @r{The type of the agenda entry, can be}
18687 todo @r{selected in TODO match}
18688 tagsmatch @r{selected in tags match}
18689 diary @r{imported from diary}
18690 deadline @r{a deadline}
18691 scheduled @r{scheduled}
18692 timestamp @r{appointment, selected by timestamp}
18693 closed @r{entry was closed on date}
18694 upcoming-deadline @r{warning about nearing deadline}
18695 past-scheduled @r{forwarded scheduled item}
18696 block @r{entry has date block including date}
18697 todo @r{The TODO keyword, if any}
18698 tags @r{All tags including inherited ones, separated by colons}
18699 date @r{The relevant date, like 2007-2-14}
18700 time @r{The time, like 15:00-16:50}
18701 extra @r{String with extra planning info}
18702 priority-l @r{The priority letter if any was given}
18703 priority-n @r{The computed numerical priority}
18707 Time and date will only be given if a timestamp (or deadline/scheduled)
18708 led to the selection of the item.
18710 A CSV list like this is very easy to use in a post-processing script.
18711 For example, here is a Perl program that gets the TODO list from
18712 Emacs/Org and prints all the items, preceded by a checkbox:
18717 # define the Emacs command to run
18718 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18720 # run it and capture the output
18721 $agenda = qx@{$cmd 2>/dev/null@};
18723 # loop over all lines
18724 foreach $line (split(/\n/,$agenda)) @{
18725 # get the individual values
18726 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18727 $priority_l,$priority_n) = split(/,/,$line);
18728 # process and print
18729 print "[ ] $head\n";
18733 @node Using the property API
18734 @section Using the property API
18735 @cindex API, for properties
18736 @cindex properties, API
18738 Here is a description of the functions that can be used to work with
18741 @defun org-entry-properties &optional pom which
18742 Get all properties of the entry at point-or-marker POM.@*
18743 This includes the TODO keyword, the tags, time strings for deadline,
18744 scheduled, and clocking, and any additional properties defined in the
18745 entry. The return value is an alist. Keys may occur multiple times
18746 if the property key was used several times.@*
18747 POM may also be @code{nil}, in which case the current entry is used.
18748 If WHICH is @code{nil} or @code{all}, get all properties. If WHICH is
18749 @code{special} or @code{standard}, only get that subclass.
18751 @vindex org-use-property-inheritance
18752 @findex org-insert-property-drawer
18753 @defun org-entry-get pom property &optional inherit
18754 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
18755 this only looks at properties defined locally in the entry. If @code{INHERIT}
18756 is non-@code{nil} and the entry does not have the property, then also check
18757 higher levels of the hierarchy. If @code{INHERIT} is the symbol
18758 @code{selective}, use inheritance if and only if the setting of
18759 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18762 @defun org-entry-delete pom property
18763 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18766 @defun org-entry-put pom property value
18767 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18770 @defun org-buffer-property-keys &optional include-specials
18771 Get all property keys in the current buffer.
18774 @defun org-insert-property-drawer
18775 Insert a property drawer for the current entry.
18778 @defun org-entry-put-multivalued-property pom property &rest values
18779 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18780 @code{VALUES} should be a list of strings. They will be concatenated, with
18781 spaces as separators.
18784 @defun org-entry-get-multivalued-property pom property
18785 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18786 list of values and return the values as a list of strings.
18789 @defun org-entry-add-to-multivalued-property pom property value
18790 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18791 list of values and make sure that @code{VALUE} is in this list.
18794 @defun org-entry-remove-from-multivalued-property pom property value
18795 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18796 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18799 @defun org-entry-member-in-multivalued-property pom property value
18800 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18801 list of values and check if @code{VALUE} is in this list.
18804 @defopt org-property-allowed-value-functions
18805 Hook for functions supplying allowed values for a specific property.
18806 The functions must take a single argument, the name of the property, and
18807 return a flat list of allowed values. If @samp{:ETC} is one of
18808 the values, use the values as completion help, but allow also other values
18809 to be entered. The functions must return @code{nil} if they are not
18810 responsible for this property.
18813 @node Using the mapping API
18814 @section Using the mapping API
18815 @cindex API, for mapping
18816 @cindex mapping entries, API
18818 Org has sophisticated mapping capabilities to find all entries satisfying
18819 certain criteria. Internally, this functionality is used to produce agenda
18820 views, but there is also an API that can be used to execute arbitrary
18821 functions for each or selected entries. The main entry point for this API
18824 @defun org-map-entries func &optional match scope &rest skip
18825 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18827 @code{FUNC} is a function or a Lisp form. The function will be called
18828 without arguments, with the cursor positioned at the beginning of the
18829 headline. The return values of all calls to the function will be collected
18830 and returned as a list.
18832 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18833 @code{FUNC} does not need to preserve point. After evaluation, the cursor
18834 will be moved to the end of the line (presumably of the headline of the
18835 processed entry) and search continues from there. Under some circumstances,
18836 this may not produce the wanted results. For example, if you have removed
18837 (e.g., archived) the current (sub)tree it could mean that the next entry will
18838 be skipped entirely. In such cases, you can specify the position from where
18839 search should continue by making @code{FUNC} set the variable
18840 @code{org-map-continue-from} to the desired buffer position.
18842 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18843 view. Only headlines that are matched by this query will be considered
18844 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
18845 headlines will be visited by the iteration.
18847 @code{SCOPE} determines the scope of this command. It can be any of:
18850 nil @r{the current buffer, respecting the restriction if any}
18851 tree @r{the subtree started with the entry at point}
18852 region @r{The entries within the active region, if any}
18853 file @r{the current buffer, without restriction}
18855 @r{the current buffer, and any archives associated with it}
18856 agenda @r{all agenda files}
18857 agenda-with-archives
18858 @r{all agenda files with any archive files associated with them}
18860 @r{if this is a list, all files in the list will be scanned}
18863 The remaining args are treated as settings for the skipping facilities of
18864 the scanner. The following items can be given here:
18866 @vindex org-agenda-skip-function
18868 archive @r{skip trees with the archive tag}
18869 comment @r{skip trees with the COMMENT keyword}
18870 function or Lisp form
18871 @r{will be used as value for @code{org-agenda-skip-function},}
18872 @r{so whenever the function returns t, FUNC}
18873 @r{will not be called for that entry and search will}
18874 @r{continue from the point where the function leaves it}
18878 The function given to that mapping routine can really do anything you like.
18879 It can use the property API (@pxref{Using the property API}) to gather more
18880 information about the entry, or in order to change metadata in the entry.
18881 Here are a couple of functions that might be handy:
18883 @defun org-todo &optional arg
18884 Change the TODO state of the entry. See the docstring of the functions for
18885 the many possible values for the argument @code{ARG}.
18888 @defun org-priority &optional action
18889 Change the priority of the entry. See the docstring of this function for the
18890 possible values for @code{ACTION}.
18893 @defun org-toggle-tag tag &optional onoff
18894 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
18895 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18900 Promote the current entry.
18904 Demote the current entry.
18907 Here is a simple example that will turn all entries in the current file with
18908 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18909 Entries in comment trees and in archive trees will be ignored.
18913 '(org-todo "UPCOMING")
18914 "+TOMORROW" 'file 'archive 'comment)
18917 The following example counts the number of entries with TODO keyword
18918 @code{WAITING}, in all agenda files.
18921 (length (org-map-entries t "/+WAITING" 'agenda))
18925 @appendix MobileOrg
18929 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18930 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
18931 capture support for an Org mode system rooted on a ``real'' computer. It
18932 also allows you to record changes to existing entries. The
18933 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18934 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18935 and is now in the hands Sean Escriva. Android users should check out
18936 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18937 by Matt Jones. The two implementations are not identical but offer similar
18940 This appendix describes the support Org has for creating agenda views in a
18941 format that can be displayed by @i{MobileOrg}, and for integrating notes
18942 captured and changes made by @i{MobileOrg} into the main system.
18944 For changing tags and TODO states in MobileOrg, you should have set up the
18945 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18946 cover all important tags and TODO keywords, even if individual files use only
18947 part of these. MobileOrg will also offer you states and tags set up with
18948 in-buffer settings, but it will understand the logistics of TODO state
18949 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18950 (@pxref{Setting tags}) only for those set in these variables.
18953 * Setting up the staging area:: Where to interact with the mobile device
18954 * Pushing to MobileOrg:: Uploading Org files and agendas
18955 * Pulling from MobileOrg:: Integrating captured and flagged items
18958 @node Setting up the staging area
18959 @section Setting up the staging area
18961 MobileOrg needs to interact with Emacs through a directory on a server. If
18962 you are using a public server, you should consider encrypting the files that
18963 are uploaded to the server. This can be done with Org mode 7.02 and with
18964 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18965 installation on your system. To turn on encryption, set a password in
18966 @i{MobileOrg} and, on the Emacs side, configure the variable
18967 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18968 password in your Emacs setup, you might also want to configure
18969 @code{org-mobile-encryption-password}. Please read the docstring of that
18970 variable. Note that encryption will apply only to the contents of the
18971 @file{.org} files. The file names themselves will remain visible.}.
18973 The easiest way to create that directory is to use a free
18974 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18975 Dropbox, or if your version of MobileOrg does not support it, you can use a
18976 webdav server. For more information, check out the documentation of MobileOrg and also this
18977 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18978 When MobileOrg first connects to your Dropbox, it will create a directory
18979 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
18983 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18986 Org mode has commands to put files for @i{MobileOrg} into that directory,
18987 and to read captured notes from there.
18989 @node Pushing to MobileOrg
18990 @section Pushing to MobileOrg
18992 This operation copies all files currently listed in @code{org-mobile-files}
18993 to the directory @code{org-mobile-directory}. By default this list contains
18994 all agenda files (as listed in @code{org-agenda-files}), but additional files
18995 can be included by customizing @code{org-mobile-files}. File names will be
18996 staged with paths relative to @code{org-directory}, so all files should be
18997 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18998 have the same name as their targets.}.
19000 The push operation also creates a special Org file @file{agendas.org} with
19001 all custom agenda view defined by the user@footnote{While creating the
19002 agendas, Org mode will force ID properties on all referenced entries, so that
19003 these entries can be uniquely identified if @i{MobileOrg} flags them for
19004 further action. If you do not want to get these properties in so many
19005 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
19006 to @code{nil}. Org mode will then rely on outline paths, in the hope that
19007 these will be unique enough.}.
19009 Finally, Org writes the file @file{index.org}, containing links to all other
19010 files. @i{MobileOrg} first reads this file from the server, and then
19011 downloads all agendas and Org files listed in it. To speed up the download,
19012 MobileOrg will only read files whose checksums@footnote{Checksums are stored
19013 automatically in the file @file{checksums.dat}} have changed.
19015 @node Pulling from MobileOrg
19016 @section Pulling from MobileOrg
19018 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
19019 files for viewing. It also appends captured entries and pointers to flagged
19020 and changed entries to the file @file{mobileorg.org} on the server. Org has
19021 a @emph{pull} operation that integrates this information into an inbox file
19022 and operates on the pointers to flagged entries. Here is how it works:
19026 Org moves all entries found in
19027 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
19028 operation.} and appends them to the file pointed to by the variable
19029 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
19030 will be a top-level entry in the inbox file.
19032 After moving the entries, Org will attempt to implement the changes made in
19033 @i{MobileOrg}. Some changes are applied directly and without user
19034 interaction. Examples are all changes to tags, TODO state, headline and body
19035 text that can be cleanly applied. Entries that have been flagged for further
19036 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
19037 again. When there is a problem finding an entry or applying the change, the
19038 pointer entry will remain in the inbox and will be marked with an error
19039 message. You need to later resolve these issues by hand.
19041 Org will then generate an agenda view with all flagged entries. The user
19042 should then go through these entries and do whatever actions are necessary.
19043 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
19044 will be displayed in the echo area when the cursor is on the corresponding
19050 Pressing @kbd{?} in that special agenda will display the full flagging note in
19051 another window and also push it onto the kill ring. So you could use @kbd{?
19052 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
19053 Pressing @kbd{?} twice in succession will offer to remove the
19054 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
19055 in a property). In this way you indicate that the intended processing for
19056 this flagged entry is finished.
19061 If you are not able to process all flagged entries directly, you can always
19062 return to this agenda view@footnote{Note, however, that there is a subtle
19063 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
19064 is guaranteed to search all files that have been addressed by the last pull.
19065 This might include a file that is not currently in your list of agenda files.
19066 If you later use @kbd{C-c a ?} to regenerate the view, only the current
19067 agenda files will be searched.} using @kbd{C-c a ?}.
19069 @node History and acknowledgments
19070 @appendix History and acknowledgments
19071 @cindex acknowledgments
19075 @section From Carsten
19077 Org was born in 2003, out of frustration over the user interface of the Emacs
19078 Outline mode. I was trying to organize my notes and projects, and using
19079 Emacs seemed to be the natural way to go. However, having to remember eleven
19080 different commands with two or three keys per command, only to hide and show
19081 parts of the outline tree, that seemed entirely unacceptable to me. Also,
19082 when using outlines to take notes, I constantly wanted to restructure the
19083 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
19084 cycling} and @emph{structure editing} were originally implemented in the
19085 package @file{outline-magic.el}, but quickly moved to the more general
19086 @file{org.el}. As this environment became comfortable for project planning,
19087 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
19088 @emph{table support}. These areas highlighted the two main goals that Org
19089 still has today: to be a new, outline-based, plain text mode with innovative
19090 and intuitive editing features, and to incorporate project planning
19091 functionality directly into a notes file.
19093 Since the first release, literally thousands of emails to me or to
19094 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
19095 reports, feedback, new ideas, and sometimes patches and add-on code.
19096 Many thanks to everyone who has helped to improve this package. I am
19097 trying to keep here a list of the people who had significant influence
19098 in shaping one or more aspects of Org. The list may not be
19099 complete, if I have forgotten someone, please accept my apologies and
19102 Before I get to this list, a few special mentions are in order:
19105 @item Bastien Guerry
19106 Bastien has written a large number of extensions to Org (most of them
19107 integrated into the core by now), including the @LaTeX{} exporter and the
19108 plain list parser. His support during the early days was central to the
19109 success of this project. Bastien also invented Worg, helped establishing the
19110 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
19111 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
19112 I desparately needed a break.
19113 @item Eric Schulte and Dan Davison
19114 Eric and Dan are jointly responsible for the Org-babel system, which turns
19115 Org into a multi-language environment for evaluating code and doing literate
19116 programming and reproducible research. This has become one of Org's killer
19117 features that define what Org is today.
19119 John has contributed a number of great ideas and patches directly to Org,
19120 including the attachment system (@file{org-attach.el}), integration with
19121 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
19122 items, habit tracking (@file{org-habits.el}), and encryption
19123 (@file{org-crypt.el}). Also, the capture system is really an extended copy
19124 of his great @file{remember.el}.
19125 @item Sebastian Rose
19126 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
19127 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
19128 higher level. He also wrote @file{org-info.js}, a Java script for displaying
19129 web pages derived from Org using an Info-like or a folding interface with
19130 single-key navigation.
19133 @noindent See below for the full list of contributions! Again, please
19134 let me know what I am missing here!
19136 @section From Bastien
19138 I (Bastien) have been maintaining Org between 2011 and 2013. This appendix
19139 would not be complete without adding a few more acknowledgements and thanks.
19141 I am first grateful to Carsten for his trust while handing me over the
19142 maintainership of Org. His unremitting support is what really helped me
19143 getting more confident over time, with both the community and the code.
19145 When I took over maintainership, I knew I would have to make Org more
19146 collaborative than ever, as I would have to rely on people that are more
19147 knowledgeable than I am on many parts of the code. Here is a list of the
19148 persons I could rely on, they should really be considered co-maintainers,
19149 either of the code or the community:
19153 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
19154 from worrying about possible bugs here and let me focus on other parts.
19156 @item Nicolas Goaziou
19157 Nicolas is maintaining the consistency of the deepest parts of Org. His work
19158 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
19159 the doors for many new ideas and features. He rewrote many of the old
19160 exporters to use the new export engine, and helped with documenting this
19161 major change. More importantly (if that's possible), he has been more than
19162 reliable during all the work done for Org 8.0, and always very reactive on
19166 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
19167 into a flexible and conceptually clean process. He patiently coped with the
19168 many hiccups that such a change can create for users.
19171 The Org mode mailing list would not be such a nice place without Nick, who
19172 patiently helped users so many times. It is impossible to overestimate such
19173 a great help, and the list would not be so active without him.
19176 I received support from so many users that it is clearly impossible to be
19177 fair when shortlisting a few of them, but Org's history would not be
19178 complete if the ones above were not mentioned in this manual.
19180 @section List of contributions
19185 @i{Russel Adams} came up with the idea for drawers.
19187 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
19188 feedback on many features and several patches.
19190 @i{Luis Anaya} wrote @file{ox-man.el}.
19192 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
19194 @i{Michael Brand} helped by reporting many bugs and testing many features.
19195 He also implemented the distinction between empty fields and 0-value fields
19196 in Org's spreadsheets.
19198 @i{Christophe Bataillon} created the great unicorn logo that we use on the
19201 @i{Alex Bochannek} provided a patch for rounding timestamps.
19203 @i{Jan Böcker} wrote @file{org-docview.el}.
19205 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
19207 @i{Tom Breton} wrote @file{org-choose.el}.
19209 @i{Charles Cave}'s suggestion sparked the implementation of templates
19210 for Remember, which are now templates for capture.
19212 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
19215 @i{Gregory Chernov} patched support for Lisp forms into table
19216 calculations and improved XEmacs compatibility, in particular by porting
19217 @file{nouline.el} to XEmacs.
19219 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
19220 make Org pupular through her blog.
19222 @i{Toby S. Cubitt} contributed to the code for clock formats.
19224 @i{Baoqiu Cui} contributed the first DocBook exporter. In Org 8.0, we go a
19225 different route: you can now export to Texinfo and export the @file{.texi}
19226 file to DocBook using @code{makeinfo}.
19228 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
19229 came up with the idea of properties, and that there should be an API for
19232 @i{Nick Dokos} tracked down several nasty bugs.
19234 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
19235 inspired some of the early development, including HTML export. He also
19236 asked for a way to narrow wide table columns.
19238 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
19239 several years now. He also sponsored the hosting costs until Rackspace
19240 started to host us for free.
19242 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
19243 the Org-Babel documentation into the manual.
19245 @i{Christian Egli} converted the documentation into Texinfo format, inspired
19246 the agenda, patched CSS formatting into the HTML exporter, and wrote
19247 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
19248 @file{ox-taskjuggler.el} for Org 8.0.
19250 @i{David Emery} provided a patch for custom CSS support in exported
19253 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
19255 @i{Nic Ferrier} contributed mailcap and XOXO support.
19257 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
19259 @i{John Foerch} figured out how to make incremental search show context
19260 around a match in a hidden outline tree.
19262 @i{Raimar Finken} wrote @file{org-git-line.el}.
19264 @i{Mikael Fornius} works as a mailing list moderator.
19266 @i{Austin Frank} works as a mailing list moderator.
19268 @i{Eric Fraga} drove the development of BEAMER export with ideas and
19271 @i{Barry Gidden} did proofreading the manual in preparation for the book
19272 publication through Network Theory Ltd.
19274 @i{Niels Giesen} had the idea to automatically archive DONE trees.
19276 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
19277 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
19278 in implementing a clean framework for Org exporters.
19280 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
19282 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
19285 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
19286 task state change logging, and the clocktable. His clear explanations have
19287 been critical when we started to adopt the Git version control system.
19289 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
19292 @i{Phil Jackson} wrote @file{org-irc.el}.
19294 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
19295 folded entries, and column view for properties.
19297 @i{Matt Jones} wrote @i{MobileOrg Android}.
19299 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
19301 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
19303 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
19304 provided frequent feedback and some patches.
19306 @i{Matt Lundin} has proposed last-row references for table formulas and named
19307 invisible anchors. He has also worked a lot on the FAQ.
19309 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
19310 and is a prolific contributor on the mailing list with competent replies,
19311 small fixes and patches.
19313 @i{Jason F. McBrayer} suggested agenda export to CSV format.
19315 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
19317 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
19320 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
19323 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
19325 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
19326 and being able to quickly restrict the agenda to a subtree.
19328 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
19330 @i{Greg Newman} refreshed the unicorn logo into its current form.
19332 @i{Tim O'Callaghan} suggested in-file links, search options for general
19333 file links, and TAGS.
19335 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
19336 version of the reference card.
19338 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
19341 @i{Oliver Oppitz} suggested multi-state TODO items.
19343 @i{Scott Otterson} sparked the introduction of descriptive text for
19344 links, among other things.
19346 @i{Pete Phillips} helped during the development of the TAGS feature, and
19347 provided frequent feedback.
19349 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
19352 @i{Martin Pohlack} provided the code snippet to bundle character insertion
19353 into bundles of 20 for undo.
19355 @i{Rackspace.com} is hosting our website for free. Thank you Rackspace!
19357 @i{T.V. Raman} reported bugs and suggested improvements.
19359 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
19362 @i{Paul Rivier} provided the basic implementation of named footnotes. He
19363 also acted as mailing list moderator for some time.
19365 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
19367 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
19368 conflict with @file{allout.el}.
19370 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
19373 @i{Philip Rooke} created the Org reference card, provided lots
19374 of feedback, developed and applied standards to the Org documentation.
19376 @i{Christian Schlauer} proposed angular brackets around links, among
19379 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
19380 enjoy folding in non-org buffers by using Org headlines in comments.
19382 @i{Paul Sexton} wrote @file{org-ctags.el}.
19384 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
19385 @file{organizer-mode.el}.
19387 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
19388 examples, and remote highlighting for referenced code lines.
19390 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
19391 now packaged into Org's @file{contrib} directory.
19393 @i{Daniel Sinder} came up with the idea of internal archiving by locking
19396 @i{Dale Smith} proposed link abbreviations.
19398 @i{James TD Smith} has contributed a large number of patches for useful
19399 tweaks and features.
19401 @i{Adam Spiers} asked for global linking commands, inspired the link
19402 extension system, added support for mairix, and proposed the mapping API.
19404 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
19405 @LaTeX{}, UTF-8, Latin-1 and ASCII.
19407 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
19408 with links transformation to Org syntax.
19410 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
19411 chapter about publishing.
19413 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
19415 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
19416 enabled source code highlighting in Gnus.
19418 @i{Stefan Vollmar} organized a video-recorded talk at the
19419 Max-Planck-Institute for Neurology. He also inspired the creation of a
19420 concept index for HTML export.
19422 @i{Jürgen Vollmer} contributed code generating the table of contents
19425 @i{Samuel Wales} has provided important feedback and bug reports.
19427 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
19430 @i{David Wainberg} suggested archiving, and improvements to the linking
19433 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
19436 @i{Roland Winkler} requested additional key bindings to make Org
19439 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
19440 and contributed various ideas and code snippets.
19444 @node GNU Free Documentation License
19445 @appendix GNU Free Documentation License
19446 @include doclicense.texi
19450 @unnumbered Concept index
19455 @unnumbered Key index
19459 @node Command and Function Index
19460 @unnumbered Command and function index
19464 @node Variable Index
19465 @unnumbered Variable index
19467 This is not a complete index of variables and faces, only the ones that are
19468 mentioned in the manual. For a more complete list, use @kbd{M-x
19469 org-customize @key{RET}} and then click yourself through the tree.
19475 @c Local variables:
19477 @c indent-tabs-mode: nil
19478 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
19479 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
19483 @c LocalWords: webdavhost pre